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

ReturnDTO

The return details.

idstring
The ID of the return.
statusReturnStatus
The status of the return.
order_idstring
The associated order's ID.
itemsOrderReturnItemDTO[]
The items of the return
display_idnumber
The return's display ID.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
refund_amountBigNumberValueOptional
The refund amount of the return.
raw_refund_amountBigNumberValueOptional
The raw refund amount of the return.
orderOrderDTOOptional
The associated order.
exchange_idstringOptional
The associated exchange's ID.
exchangeOrderExchangeDTOOptional
The associated exchange.
claim_idstringOptional
The associated claim's ID.
claimOrderClaimDTOOptional
The associated claim.
location_idstringOptional
The ID of the location to return the items to.
no_notificationbooleanOptional
Whether the customer should receive notifications related to updates on the return.
created_bynull | stringOptional
The id of the user that created the return
shipping_methodsOrderShippingMethodDTO[]Optional
The shipping methods used to receive the returned items.
transactionsOrderTransactionDTO[]Optional
The return's transactions if refund is required.
created_atstring | DateOptional
The creation date of the return.
updated_atstring | DateOptional
The update date of the return.
deleted_atstring | DateOptional
The deletion date of the return.
canceled_atstring | DateOptional
The cancelation date of the return.
requested_atstring | DateOptional
The request date of the return.
received_atstring | DateOptional
The receival date of the return.
Was this page helpful?
Edit this page