type: object
description: The details of the swap to create.
required:
  - return_items
properties:
  return_items:
    description: The Line Items to associate with the swap's return.
    type: array
    items:
      type: object
      required:
        - item_id
        - quantity
      properties:
        item_id:
          description: The ID of the Line Item that will be returned.
          type: string
        quantity:
          description: The number of items that will be returned
          type: integer
        reason_id:
          description: The ID of the Return Reason to use.
          type: string
        note:
          description: An optional note with information about the Return.
          type: string
  return_shipping:
    description: The shipping method associated with the swap's return.
    type: object
    required:
      - option_id
    properties:
      option_id:
        type: string
        description: The ID of the Shipping Option to create the Shipping Method from.
      price:
        type: integer
        description: The price to charge for the Shipping Method.
  additional_items:
    description: The new items to send to the Customer.
    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 Product Variant.
          type: integer
  sales_channel_id:
    type: string
    description: The ID of the sales channel associated with the swap.
  custom_shipping_options:
    description: >-
      An array of custom shipping options to potentially create a Shipping
      Method from to send the additional items.
    type: array
    items:
      type: object
      required:
        - option_id
        - price
      properties:
        option_id:
          description: The ID of the Shipping Option.
          type: string
        price:
          description: The custom price of the Shipping Option.
          type: integer
  no_notification:
    description: >-
      If set to `true`, no notification will be sent to the customer related to
      this Swap.
    type: boolean
  return_location_id:
    type: string
    description: The ID of the location used for the associated return.
  allow_backorder:
    description: If set to `true`, swaps can be completed with items out of stock
    type: boolean
    default: true