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

additional_itemsLineItem[]Required

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

canceled_atDateRequired

The date with timezone at which the claim was canceled.

claim_itemsClaimItem[]Required

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

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atDateRequired

The date with timezone at which the resource was deleted.

fulfillment_statusClaimFulfillmentStatusRequired

The claim's fulfillment status

Default: not_fulfilled

fulfillmentsFulfillment[]Required

The fulfillments of the new items to be shipped

idstringRequired

The claim's ID

idempotency_keystringRequired

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

metadataRecord<string, unknown>Required

An optional key-value map with additional details

no_notificationbooleanRequired

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

orderOrderRequired

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

order_idstringRequired

The ID of the order that the claim comes from.

payment_statusClaimPaymentStatusRequired

The status of the claim's payment

Default: na

refund_amountnumberRequired

The amount that will be refunded in conjunction with the claim

return_orderReturnRequired

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

shipping_addressAddressRequired

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

shipping_address_idstringRequired

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

shipping_methodsShippingMethod[]Required

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

typeClaimTypeRequired

The claim's type

updated_atDateRequired

The date with timezone at which the resource was updated.