Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
51 lines
1.3 KiB
YAML
51 lines
1.3 KiB
YAML
type: object
|
|
required:
|
|
- order_id
|
|
- return_items
|
|
- additional_items
|
|
properties:
|
|
order_id:
|
|
type: string
|
|
description: The ID of the Order to create the Swap for.
|
|
return_items:
|
|
description: The items to include in the Return.
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- item_id
|
|
- quantity
|
|
properties:
|
|
item_id:
|
|
description: The ID of the order's line item to return.
|
|
type: string
|
|
quantity:
|
|
description: The quantity to return.
|
|
type: integer
|
|
reason_id:
|
|
description: >-
|
|
The ID of the reason of this return. Return reasons can be retrieved
|
|
from the List Return Reasons endpoint.
|
|
type: string
|
|
note:
|
|
description: The note to add to the item being swapped.
|
|
type: string
|
|
return_shipping_option:
|
|
type: string
|
|
description: The ID of the Shipping Option to create the Shipping Method from.
|
|
additional_items:
|
|
description: The items to exchange the returned items with.
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- variant_id
|
|
- quantity
|
|
properties:
|
|
variant_id:
|
|
description: The ID of the Product Variant.
|
|
type: string
|
|
quantity:
|
|
description: The quantity of the variant.
|
|
type: integer
|