AdminPostOrdersOrderSwapsReq
The details of the swap to create.
Properties
The Line Items to associate with the swap's return.
return_shipping
ReturnShippingThe shipping method associated with the swap's return.
return_shipping
ReturnShippingsales_channel_id
stringThe ID of the sales channel associated with the swap.
additional_items
AdditionalItem[]The new items to send to the Customer.
additional_items
AdditionalItem[]custom_shipping_options
CustomShippingOption[]An array of custom shipping options to potentially create a Shipping Method from to send the additional items.Default: []
custom_shipping_options
CustomShippingOption[][]
no_notification
booleanIf set to
true
, no notification will be sent to the customer related to this Swap.return_location_id
stringThe ID of the location used for the associated return.
allow_backorder
booleanIf set to
true
, swaps can be completed with items out of stockDefault: true
Was this section helpful?