File Shipping Claim

Files a shipping claim.

Several fields are conditionally required depending on initialResolution and category; see the field descriptions on FileShippingClaimInput for the exact conditions. A structurally valid request can still be rejected if those conditions are not met.

To help us process the claim quickly, include any relevant supporting documents in the documents field. If they are omitted, we may need to request them later, which can delay processing of the claim.

Initial Resolution and Reship Fields

initialResolution governs which reship-related fields are permitted.

ValuereshippedOrdernewReshipOrderPreferencesNotes
already_reshippedRequiredForbiddenOrder was already reshipped elsewhere.
reship_requestedForbiddenRequiredCustomer asked for a reship; the reship order is created immediately, or at submitAt if provided.
reship_when_approvedForbiddenRequiredReship pending approval; the reship order is not created until approved, so submitAt must be null.
reship_not_requestedForbiddenForbiddenNo reship involved.
reship_or_refundForbiddenForbiddenReserved, only valid when MonkProtect is enabled.

Category Values

Describes the type of shipping issue being claimed.

ValueDescription
nullDefault
lost_in_transitThe shipment was lost while in transit and never delivered.
damaged_in_transitThe shipment's packaging or contents were damaged while in transit. Requires at least one document with documentType = damage_photo_packaging.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Must belong to the authenticated account. Resolved jointly with orderKey.

string
required

Resolved within the given storeId, not globally. Must identify an existing order.

string
enum
required

The resolution requested for the claim at the time of filing, e.g. whether a reship order should be created for it, and if so, when.

Show Details
already_reshippedOrder was already reshipped elsewhere.
reship_requestedCustomer asked for a reship
reship_when_approvedReship pending approval
reship_not_requestedNo reship involved.
reship_or_refundReserved, only valid when MonkProtect is enabled.
Allowed:
string | null
Defaults to null

Free-form note providing additional context about the claim for the claims processing team to review.

Claim Category Name | null
Defaults to null

When set to damaged_in_transit, documents must contain at least one entry with documentType = damage_photo_packaging; its absence is rejected.

Claim Reshipped Order Input | null
Defaults to null

Required if and only if initialResolution = already_reshipped. Must be null for every other resolution; supplying it otherwise is rejected.

New Reship Order Preferences Input | null
Defaults to null

newReshipOrderPreferences is only meaningful for reship_requested and reship_when_approved claims. For everything else, provide null.

documents
array of objects | null
Defaults to null

For category = damaged_in_transit, at least one entry with documentType = damage_photo_packaging is required. Only PDF and images are supported mime types.

documents
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json