Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

OrderClaimDTO

The claim details.

idstring
The claim's ID.
typeOrderClaimType
The claim's type.
order_idstring
The ID of the associated order.
order_versionnumber
The version of the order when the claim is applied.
display_idnumber
The claim's display ID.
claim_itemsany[]
The items to be received from the customer.
additional_itemsany[]
The items to be sent to the customer if the claim's type is replace.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
orderOrderDTOOptional
The associated order.
returnReturnDTOOptional
The associated return, if the claim's type is replace.
return_idstringOptional
The ID of the associated return, if the claim's type is replace.
no_notificationbooleanOptional
Whether the customer should receive notifications related to updates on the claim.
refund_amountBigNumberValueOptional
The refund amount of the claim.
raw_refund_amountBigNumberValueOptional
The raw refund amount of the claim.
created_bynull | stringOptional
The id of the user that created the order claim
shipping_methodsOrderShippingMethodDTO[]Optional
The shipping methods used to send the additional items.
transactionsOrderTransactionDTO[]Optional
The claim's transactions if additional payment is required.
created_atstring | DateOptional
The creation date of the claim.
updated_atstring | DateOptional
The update date of the claim.
deleted_atstring | DateOptional
The deletion date of the claim.
canceled_atstring | DateOptional
The cancelation date of the claim.
Was this page helpful?
Edit this page