www/apps/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx
import { TypeList } from "docs-ui"
The order change action details.
<TypeList types={[{"name":"id","type":"string","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"null \| string","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"null \| OrderChangeDTO","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"string","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"string","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"string","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"OrderStatus","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"BigNumberValue","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"BigNumberValue","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"BigNumberValue","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"BigNumberValue","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"BigNumberValue","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"BigNumberValue","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_discount_total","type":"BigNumberValue","description":"The item discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"BigNumberValue","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"BigNumberValue","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"credit_line_total","type":"BigNumberValue","description":"The credit line total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"BigNumberValue","description":"The gift card total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"BigNumberValue","description":"The gift card tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"BigNumberValue","description":"The shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_subtotal","type":"BigNumberValue","description":"The shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_tax_total","type":"BigNumberValue","description":"The shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_discount_total","type":"BigNumberValue","description":"The shipping discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_total","type":"BigNumberValue","description":"The original shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_subtotal","type":"BigNumberValue","description":"The original shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_tax_total","type":"BigNumberValue","description":"The original shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_display_id","type":"string","description":"The order's custom display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"OrderChangeDTO","description":"The active order change, if any.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"string","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"string","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"string","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"OrderAddressDTO","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"OrderAddressDTO","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"OrderLineItemDTO[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"OrderCreditLineDTO[]","description":"The credit lines for an order","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"summary","type":"OrderSummaryDTO","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"is_draft_order","type":"boolean","description":"Whether the order is a draft order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"locale","type":"string","description":"The locale of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_order","type":"ReturnDTO","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"ReturnStatus","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"OrderReturnItemDTO[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"BigNumberValue","description":"The refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refund_amount","type":"BigNumberValue","description":"The raw refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"string","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange","type":"OrderExchangeDTO","description":"The associated exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"string","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"OrderClaimDTO","description":"The associated claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"string","description":"The ID of the location to return the items to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"boolean","description":"Whether the customer should receive notifications related\nto updates on the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"The id of the user that created the return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The shipping methods used to receive the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The return's transactions if refund is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"The deletion date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"The cancelation date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"string \| Date","description":"The request date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"string \| Date","description":"The receival date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"exchange","type":"OrderExchangeDTO","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"number","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"any[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"boolean","description":"Whether the customer should receive notifications related\nto updates on the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"BigNumberValue","description":"The difference due of the order exchange.\n\n- If less than 0, the merchant owes the customer this amount.\n- If greater than 0, the customer owes the merchange this amount.\n- If equal to 0, no payment is required by either sides.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_difference_due","type":"BigNumberValue","description":"The raw difference due of the order exchange.\n\n- If less than 0, the merchant owes the customer this amount.\n- If greater than 0, the customer owes the merchange this amount.\n- If equal to 0, no payment is required by either sides.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"boolean","description":"Whether the variants that are out of stock can be added to the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"ReturnDTO","description":"The associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"string","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"The id of the user that created the order exchange","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The shipping methods used to send the additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The exchange's transactions if additional payment is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"The deletion date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"The cancelation date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim","type":"OrderClaimDTO","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"OrderClaimType","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"number","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"any[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"any[]","description":"The items to be sent to the customer\nif the claim's type is replace.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"ReturnDTO","description":"The associated return, if the claim's type is replace.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"string","description":"The ID of the associated return, if the claim's type is replace.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"boolean","description":"Whether the customer should receive notifications related\nto updates on the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"BigNumberValue","description":"The refund amount of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refund_amount","type":"BigNumberValue","description":"The raw refund amount of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"The id of the user that created the order claim","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The shipping methods used to send the additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The claim's transactions if additional payment is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"The deletion date of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"The cancelation date of the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"actions","type":"OrderChangeActionDTO[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"null \| string","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"null \| OrderChangeDTO","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"null \| string","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"null \| string","description":"The ID of the associated return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"null \| string","description":"The ID of the associated claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"null \| string","description":"The ID of the associated exchange.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"null \| OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reference","type":"string","description":"The reference of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"ChangeActionType","description":"The action of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"null \| Record<string, unknown>","description":"The details of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"null \| string","description":"The internal note of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordering","type":"number","description":"The ordering of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order change action was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order change action was updated","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"OrderChangeStatus","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"null \| string","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"null \| string \| Date","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"null \| string","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"null \| string \| Date","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"null \| string","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"null \| string","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"null \| string \| Date","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"null \| string","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"null \| string \| Date","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"\"return\" \| \"exchange\" \| \"claim\" \| \"edit\" \| \"transfer\"","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"carry_over_promotions","type":"null \| boolean","description":"Whether to carry over promotions (apply promotions to outbound exchange items).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order_id","type":"null \| string","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"null \| string","description":"The ID of the associated return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"null \| string","description":"The ID of the associated claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"null \| string","description":"The ID of the associated exchange.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"null \| OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"OrderStatus","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"BigNumberValue","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"BigNumberValue","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"BigNumberValue","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"BigNumberValue","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"BigNumberValue","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"BigNumberValue","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_discount_total","type":"BigNumberValue","description":"The item discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_total","type":"BigNumberValue","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"BigNumberValue","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_subtotal","type":"BigNumberValue","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"credit_line_total","type":"BigNumberValue","description":"The credit line total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_card_total","type":"BigNumberValue","description":"The gift card total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_card_tax_total","type":"BigNumberValue","description":"The gift card tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_total","type":"BigNumberValue","description":"The shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_subtotal","type":"BigNumberValue","description":"The shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_tax_total","type":"BigNumberValue","description":"The shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_discount_total","type":"BigNumberValue","description":"The shipping discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_shipping_total","type":"BigNumberValue","description":"The original shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_shipping_subtotal","type":"BigNumberValue","description":"The original shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_shipping_tax_total","type":"BigNumberValue","description":"The original shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"number","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"BigNumberRawValue","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"BigNumber","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"custom_display_id","type":"string","description":"The order's custom display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"OrderChangeDTO","description":"The active order change, if any.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"string","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"string","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"string","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"ReturnDTO","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"OrderExchangeDTO","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"OrderClaimDTO","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"OrderChangeActionDTO[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"OrderChangeStatus","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"null \| string","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"null \| string \| Date","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"null \| string","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"null \| string \| Date","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"null \| string","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"null \| string","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"null \| string \| Date","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"null \| string","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"null \| string \| Date","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"\"return\" \| \"exchange\" \| \"claim\" \| \"edit\" \| \"transfer\"","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"carry_over_promotions","type":"null \| boolean","description":"Whether to carry over promotions (apply promotions to outbound exchange items).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"string","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"string","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"string","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"OrderAddressDTO","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"string","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"string","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"string","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"string","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"string","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"string","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"string","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"string","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"string","description":"The lower-case ISO 3166-2 province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"string","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"OrderAddressDTO","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"string","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"string","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"string","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"string","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"string","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"string","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"string","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"string","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"string","description":"The lower-case ISO 3166-2 province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"string","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"OrderLineItemDTO[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"BigNumberValue","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"BigNumberValue","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"BigNumberValue","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"BigNumberValue","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"BigNumberValue","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"BigNumberValue","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"string","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"boolean","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"boolean","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"boolean","description":"Indicates whether the line item is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"number","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"number","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"OrderItemDTO","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"null \| string","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"null \| string","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"null \| string","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"null \| string","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"null \| string","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"null \| string","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"null \| string","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"null \| string","description":"The ID of the type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"null \| string","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"null \| string","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"null \| string","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"null \| string","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"null \| string","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"null \| string","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"null \| Record<string, unknown>","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"number","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"OrderLineItemTaxLineDTO[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"OrderLineItemAdjustmentDTO[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"BigNumberValue","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"BigNumberValue","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"string","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"string","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Record<string, unknown>","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"OrderShippingMethodTaxLineDTO[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"OrderShippingMethodAdjustmentDTO[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"BigNumberValue","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"string","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"credit_lines","type":"OrderCreditLineDTO[]","description":"The credit lines for an order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"string","description":"The ID of the order credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"string","description":"The ID of the order that the credit line belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"OrderDTO","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"BigNumberValue","description":"The amount of the credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"null \| string","description":"The reference model name that the credit line is generated from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"null \| string","description":"The reference model id that the credit line is generated from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"The metadata of the order detail","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The date when the order credit line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The date when the order credit line was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"OrderSummaryDTO","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"pending_difference","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"current_order_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_order_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transaction_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"credit_line_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accounting_total","type":"BigNumberValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_pending_difference","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_current_order_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_order_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_transaction_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_paid_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refunded_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_credit_line_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_accounting_total","type":"BigNumberRawValue","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"boolean","description":"Whether the order is a draft order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"locale","type":"string","description":"The locale of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reference","type":"string","description":"The reference of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"ChangeActionType","description":"The action of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"null \| Record<string, unknown>","description":"The details of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"null \| string","description":"The internal note of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordering","type":"number","description":"The ordering of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order change action was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order change action was updated","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderChangeActionDTO"/>