type: object
description: The order change's exchange.
x-schemaName: OrderExchange
required:
  - id
  - order_id
  - order_version
  - display_id
  - additional_items
  - metadata
properties:
  order_id:
    type: string
    title: order_id
    description: The ID of the order the exchange is created for.
  additional_items:
    type: array
    description: The new items (outbound) sent by the exchange.
    items:
      $ref: ./BaseExchangeItem.yaml
  no_notification:
    type: boolean
    title: no_notification
    description: Whether to send the customer notifications when the exchange is updated.
  difference_due:
    type: number
    title: difference_due
    description: >-
      The amount to be exchanged or refunded. If the amount is negative, it must
      be refunded. If positive, additional payment is required from the
      customer.
  return:
    $ref: ./Return.yaml
  return_id:
    type: string
    title: return_id
    description: The ID of the associated exchange.
  id:
    type: string
    title: id
    description: The exchange's ID.
  display_id:
    type: number
    title: display_id
    description: The exchange's display ID.
  shipping_methods:
    type: array
    description: The shipping methods used to send the new (outbound) items.
    items:
      $ref: ./OrderShippingMethod.yaml
  transactions:
    type: array
    description: The exchange's transactions.
    externalDocs:
      url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
    items:
      $ref: ./OrderTransaction.yaml
  metadata:
    type: object
    description: The exchange's metadata, can hold custom key-value pairs.
    externalDocs:
      url: https://docs.medusajs.com/api/store#manage-metadata
      description: Learn how to manage metadata
  created_at:
    type: string
    format: date-time
    title: created_at
    description: The date that the exchange was created.
  updated_at:
    type: string
    format: date-time
    title: updated_at
    description: The date that the exchange was updated.
  order:
    $ref: ./Order.yaml
  order_version:
    type: number
    title: order_version
    description: The version of the order when the exchange is applied.
  raw_difference_due:
    oneOf:
      - type: string
        title: raw_difference_due
        description: The exchange's raw difference due.
      - type: number
        title: raw_difference_due
        description: The exchange's raw difference due.
      - type: string
        title: raw_difference_due
        description: The exchange's raw difference due.
      - type: number
        title: raw_difference_due
        description: The exchange's raw difference due.
  allow_backorder:
    type: boolean
    title: allow_backorder
    description: >-
      Whether variants that are out of stock can be added to the exchange as
      outbound items.
  created_by:
    type: string
    title: created_by
    description: The ID of the user that created the exchange.
  deleted_at:
    type: string
    format: date-time
    title: deleted_at
    description: The date the exchange was deleted.
  canceled_at:
    type: string
    title: canceled_at
    description: The date the exchange was canceled.
    format: date-time