AdminPostOrdersOrderClaimsReq

The details of the claim to be created.

Properties

additional_itemsAdditionalItem[]

The new items to send to the Customer. This is only used if the claim's type is replace.

claim_itemsItem[]Required

The Claim Items that the Claim will consist of.

metadataRecord<string, unknown>

An optional set of key-value pairs to hold additional information.

no_notificationboolean

If set to true no notification will be send related to this Claim.

refund_amountnumber

The amount to refund the customer. This is used when the claim's type is refund.

return_location_idstring

The ID of the location used for the associated return.

return_shippingReturnShipping

Optional 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.

shipping_addressAddressPayload

An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.

shipping_methodsShippingMethod[]

The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is replace.

type"refund" | "replace"Required

The 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.