AdminPostOrdersOrderSwapsReq
The details of the swap to create.
Properties
The Line Items to associate with the swap's return.
additional_itemsAdditionalItem[]The new items to send to the Customer.
additional_itemsAdditionalItem[]allow_backorderbooleanIf set to
true, swaps can be completed with items out of stockDefault: true
custom_shipping_optionsCustomShippingOption[]An array of custom shipping options to potentially create a Shipping Method from to send the additional items.Default: []
custom_shipping_optionsCustomShippingOption[][]no_notificationbooleanIf set to
true, no notification will be sent to the customer related to this Swap.return_location_idstringThe ID of the location used for the associated return.
return_shippingReturnShippingThe shipping method associated with the swap's return.
return_shippingReturnShippingsales_channel_idstringThe ID of the sales channel associated with the swap.
Was this section helpful?