Skip to main content
Skip to main content

AdminPostOrdersOrderSwapsReq

The details of the swap to create.

Properties

return_itemsReturnItem[]Required
The Line Items to associate with the swap's return.
return_shippingReturnShipping
The shipping method associated with the swap's return.
sales_channel_idstring
The ID of the sales channel associated with the swap.
additional_itemsAdditionalItem[]
The new items to send to the Customer.
custom_shipping_optionsCustomShippingOption[]
An array of custom shipping options to potentially create a Shipping Method from to send the additional items.

Default: []

no_notificationboolean
If set to true, no notification will be sent to the customer related to this Swap.
return_location_idstring
The ID of the location used for the associated return.
allow_backorderboolean
If set to true, swaps can be completed with items out of stock

Default: true

Was this section helpful?