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

Return - Order Module Data Models Reference

This documentation provides a reference to the Return . This belongs to the Order Module.

idstring
order_idstring
orderOrder
exchangeOrderExchange
exchange_idnull | string

Default: null

claimOrderClaim
claim_idnull | string

Default: null

order_versionnumber
display_idnumber
statusReturnStatus

Default: ReturnStatus.OPEN

location_idnull | string

Default: null

no_notificationnull | boolean

Default: null

refund_amountnumber | BigNumber
raw_refund_amountBigNumberRawValue
itemsCollection<ReturnItem, object>
shipping_methodsCollection<OrderShipping, object>
transactionsCollection<OrderTransaction, object>
created_bynull | string

Default: null

metadatanull | Record<string, unknown>

Default: null

created_atDate
updated_atDate
deleted_atnull | Date

Default: null

requested_atnull | Date

Default: null

received_atnull | Date

Default: null

canceled_atnull | Date

Default: null

[OptionalProps]ModelDateColumnsOptional
Was this page helpful?