post:
  operationId: PostSwaps
  summary: Create a Swap
  description: >-
    Creates a Swap on an Order by providing some items to return along with some
    items to send back
  requestBody:
    content:
      application/json:
        schema:
          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:
                required:
                  - item_id
                  - quantity
                properties:
                  item_id:
                    description: The ID of the Line Item from the Order.
                    type: string
                  quantity:
                    description: The quantity to swap.
                    type: integer
                  reason_id:
                    description: The ID of the reason of this return.
                    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 to.
              type: array
              items:
                required:
                  - variant_id
                  - quantity
                properties:
                  variant_id:
                    description: The ID of the Product Variant to send.
                    type: string
                  quantity:
                    description: The quantity to send of the variant.
                    type: integer
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/swaps/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/swaps/postundefined
  tags:
    - Swap
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              swap:
                $ref: ../components/schemas/swap.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml