ClaimOrder

A Claim represents a group of faulty or missing items. It consists of claim items that refer to items in the original order that should be replaced or refunded. It also includes details related to shipping and fulfillment.

Properties

idstringRequired

The claim's ID

payment_statusClaimPaymentStatusRequired

The status of the claim's payment

Default: na

fulfillment_statusClaimFulfillmentStatusRequired

The claim's fulfillment status

Default: not_fulfilled

claim_itemsClaimItem[]Required

The details of the items that should be replaced or refunded.

additional_itemsLineItem[]Required

The details of the new items to be shipped when the claim's type is replace

typeClaimTypeRequired

The claim's type

order_idstringRequired

The ID of the order that the claim comes from.

orderOrderRequired

The details of the order that this claim was created for.

return_orderReturnRequired

The details of the return associated with the claim if the claim's type is replace.

shipping_address_idstringRequired

The ID of the address that the new items should be shipped to

shipping_addressAddressRequired

The details of the address that new items should be shipped to.

shipping_methodsShippingMethod[]Required

The details of the shipping methods that the claim order will be shipped with.

fulfillmentsFulfillment[]Required

The fulfillments of the new items to be shipped

refund_amountnumberRequired

The amount that will be refunded in conjunction with the claim

canceled_atDateRequired

The date with timezone at which the claim was canceled.

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

deleted_atDateRequired

The date with timezone at which the resource was deleted.

no_notificationbooleanRequired

Flag for describing whether or not notifications related to this should be send.

metadataRecord<string, unknown>Required

An optional key-value map with additional details

idempotency_keystringRequired

Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.