Skip to main content
POST
Create Claim
Shipping and Warranty claims for orders that were made on your online store.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sourceOrderId
string
required

Body

application/json
email
string
required
Example:

"claim@example.com"

salesChannel
enum<string>
default:ONLINE
required

The sales channel for the claim

Available options:
ONLINE,
IN_STORE
Example:

"ONLINE"

claimCategory
enum<string>
default:SHIPPING
required

The category of the claim

Available options:
SHIPPING,
WARRANTY
Example:

"SHIPPING"

fulfillmentIssues
object[]
required
Example:
resolution
object
required
claimFiledFrom
enum<string>
default:EXTERNAL

Indicates where the claim was filed from

Available options:
EXTERNAL,
INTERNAL
Example:

"EXTERNAL"

options
object

Additional options for claim creation

Response

status
string
required
read-only
Example:

"ok"