File Fulfillment Claim

post

https://api.shipmonk.com/v1/integrations/claims/fulfillment

Files a fulfillment claim.

Several fields are conditionally required depending on initialResolution; see the field descriptions on FileFulfillmentClaimInput 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.

Value	reshippedOrder	newReshipOrderPreferences	Notes
`already_reshipped`	Required	Forbidden	Order was already reshipped elsewhere.
`reship_requested`	Forbidden	Required	Customer asked for a reship; the reship order is created immediately, or at `submitAt` if provided.
`reship_when_approved`	Forbidden	Required	Reship pending approval; the reship order is not created until approved, so `submitAt` must be null.
`reship_not_requested`	Forbidden	Forbidden	No reship involved.
`reship_or_refund`	Forbidden	Forbidden	Reserved, only valid when MonkProtect is enabled.

Not Followed Instructions Types Values

Describes which special instruction given for the order was not followed.

Value	Description
`custom_packaging`	Custom packaging was specified for the order and was not used or was used incorrectly.
`special_packing_instructions`	Special packing instructions were provided for the order and were not followed.
`fragile`	The order contained fragile items requiring special handling that was not followed.
`gift_message`	A gift message was requested to be printed and was printed incorrectly or not included in the package.
`packing_note`	A packing note was specified for the order and was not followed.
`additional_documents`	Additional documents were requested to be included in the package and were missing or incorrect.
`missing_packlist`	A ShipMonk packing list was expected to be included in the package and was missing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

store_id

integer

required

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

order_key

string

required

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

initial_resolution

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_reshipped	Order was already reshipped elsewhere.
reship_requested	Customer asked for a reship
reship_when_approved	Reship pending approval
reship_not_requested	No reship involved.
reship_or_refund	Reserved, only valid when MonkProtect is enabled.

Allowed:

return_requested

boolean

required

When true, a return (RMA) is created for the claim's wrong or overshipped products, and for the return-to-vendor product if extra unknown products are claimed.

products

array of objects

required

Each (productSku, type) pair must be unique; a duplicate pair is rejected. The same productSku may appear with differing type values.

products*

documents

array of objects

required

Supporting documentation for the claim, e.g. photos, invoices, or other evidence. Only PDF and images are supported mime types.

documents*

customer_note

string | null

Defaults to null

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

extra_unknown_products_description

string | null

Defaults to null

Describes extra products received that were not part of the order. A non-null value marks the claim as having extra unknown products; use null if none were received.

not_followed_instructions

Fulfillment Claim Disobeyed Instructions Input | null

Defaults to null

The representation of a "special instructions were not followed" claim. This case is expressed through this object, not through a product type.

reshipped_order

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

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.

Response

200Success