medusa-store/docs/api/admin/components/schemas/Swap.yaml

title: Swap
description: >-
  Swaps can be created when a Customer wishes to exchange Products that they
  have purchased to different Products. Swaps consist of a Return of previously
  purchased Products and a Fulfillment of new Products, the amount paid for the
  Products being returned will be used towards payment for the new Products. In
  the case where the amount paid for the the Products being returned exceed the
  amount to be paid for the new Products, a Refund will be issued for the
  difference.
type: object
required:
  - allow_backorder
  - canceled_at
  - cart_id
  - confirmed_at
  - created_at
  - deleted_at
  - difference_due
  - fulfillment_status
  - id
  - idempotency_key
  - metadata
  - no_notification
  - order_id
  - payment_status
  - shipping_address_id
  - updated_at
properties:
  id:
    description: The swap's ID
    type: string
    example: swap_01F0YET86Y9G92D3YDR9Y6V676
  fulfillment_status:
    description: The status of the Fulfillment of the Swap.
    type: string
    enum:
      - not_fulfilled
      - fulfilled
      - shipped
      - partially_shipped
      - canceled
      - requires_action
    example: not_fulfilled
  payment_status:
    description: >-
      The status of the Payment of the Swap. The payment may either refer to the
      refund of an amount or the authorization of a new amount.
    type: string
    enum:
      - not_paid
      - awaiting
      - captured
      - confirmed
      - canceled
      - difference_refunded
      - partially_refunded
      - refunded
      - requires_action
    example: not_paid
  order_id:
    description: The ID of the Order where the Line Items to be returned where purchased.
    type: string
    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  order:
    description: An order object. Available if the relation `order` is expanded.
    nullable: true
    type: object
  additional_items:
    description: >-
      The new Line Items to ship to the Customer. Available if the relation
      `additional_items` is expanded.
    type: array
    items:
      $ref: ./LineItem.yaml
  return_order:
    description: >-
      A return order object. The Return that is issued for the return part of
      the Swap. Available if the relation `return_order` is expanded.
    nullable: true
    type: object
  fulfillments:
    description: >-
      The Fulfillments used to send the new Line Items. Available if the
      relation `fulfillments` is expanded.
    type: array
    items:
      type: object
  payment:
    description: >-
      The Payment authorized when the Swap requires an additional amount to be
      charged from the Customer. Available if the relation `payment` is
      expanded.
    nullable: true
    type: object
  difference_due:
    description: >-
      The difference that is paid or refunded as a result of the Swap. May be
      negative when the amount paid for the returned items exceed the total of
      the new Products.
    nullable: true
    type: integer
    example: 0
  shipping_address_id:
    description: >-
      The Address to send the new Line Items to - in most cases this will be the
      same as the shipping address on the Order.
    nullable: true
    type: string
    example: addr_01G8ZH853YPY9B94857DY91YGW
  shipping_address:
    description: Available if the relation `shipping_address` is expanded.
    nullable: true
    $ref: ./Address.yaml
  shipping_methods:
    description: >-
      The Shipping Methods used to fulfill the additional items purchased.
      Available if the relation `shipping_methods` is expanded.
    type: array
    items:
      $ref: ./ShippingMethod.yaml
  cart_id:
    description: The id of the Cart that the Customer will use to confirm the Swap.
    nullable: true
    type: string
    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
  cart:
    description: A cart object. Available if the relation `cart` is expanded.
    nullable: true
    type: object
  confirmed_at:
    description: The date with timezone at which the Swap was confirmed by the Customer.
    nullable: true
    type: string
    format: date-time
  canceled_at:
    description: The date with timezone at which the Swap was canceled.
    nullable: true
    type: string
    format: date-time
  no_notification:
    description: If set to true, no notification will be sent related to this swap
    nullable: true
    type: boolean
    example: false
  allow_backorder:
    description: If true, swaps can be completed with items out of stock
    type: boolean
    default: false
  idempotency_key:
    description: >-
      Randomly generated key used to continue the completion of the swap in case
      of failure.
    nullable: true
    type: string
    externalDocs:
      url: >-
        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
      description: Learn more how to use the idempotency key.
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time
  metadata:
    description: An optional key-value map with additional details
    nullable: true
    type: object
    example:
      car: white