AdminPostOrdersOrderClaimsReq
The details of the claim to be created.
Properties
type
"replace" | "refund"RequiredThe type of the Claim. This will determine how the Claim is treated:
replace
Claims will result in a Fulfillment with new items being created, while a refund
Claim will refund the amount paid for the claimed items.The Claim Items that the Claim will consist of.
return_shipping
ReturnShippingOptional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.
return_shipping
ReturnShippingadditional_items
AdditionalItem[]The new items to send to the Customer. This is only used if the claim's type is replace
.
additional_items
AdditionalItem[]replace
.shipping_methods
ShippingMethod[]The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is replace
.
shipping_methods
ShippingMethod[]replace
.refund_amount
numberThe amount to refund the customer. This is used when the claim's type is
refund
.shipping_address
AddressPayloadAn optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.
shipping_address
AddressPayloadno_notification
booleanIf set to true no notification will be send related to this Claim.
return_location_id
stringThe ID of the location used for the associated return.
metadata
Record<string, unknown>An optional set of key-value pairs to hold additional information.
Was this section helpful?