type: object
description: The order's details.
x-schemaName: BaseOrder
required:
  - id
  - version
  - region_id
  - customer_id
  - sales_channel_id
  - email
  - currency_code
  - status
  - items
  - shipping_methods
  - payment_status
  - fulfillment_status
  - summary
  - created_at
  - updated_at
  - original_item_total
  - original_item_subtotal
  - original_item_tax_total
  - item_total
  - item_subtotal
  - item_tax_total
  - item_discount_total
  - original_total
  - original_subtotal
  - original_tax_total
  - total
  - subtotal
  - tax_total
  - discount_total
  - discount_tax_total
  - gift_card_total
  - gift_card_tax_total
  - shipping_total
  - shipping_subtotal
  - shipping_tax_total
  - shipping_discount_total
  - original_shipping_total
  - original_shipping_subtotal
  - original_shipping_tax_total
  - credit_line_total
properties:
  payment_collections:
    type: array
    description: The order's payment collections.
    items:
      $ref: ./BasePaymentCollection.yaml
  fulfillments:
    type: array
    description: The order's fulfillments.
    items:
      $ref: ./BaseOrderFulfillment.yaml
  shipping_address:
    $ref: ./BaseOrderAddress.yaml
  billing_address:
    $ref: ./BaseOrderAddress.yaml
  id:
    type: string
    title: id
    description: The order's ID.
  version:
    type: number
    title: version
    description: The order's version.
  region_id:
    type: string
    title: region_id
    description: The ID of the region associated with the order.
  customer_id:
    type: string
    title: customer_id
    description: The ID of the customer that placed the order.
  sales_channel_id:
    type: string
    title: sales_channel_id
    description: The ID of the sales channel the order is placed in.
  email:
    type: string
    title: email
    description: The email of the customer that placed the order.
    format: email
  currency_code:
    type: string
    title: currency_code
    description: The order's currency code.
  display_id:
    type: number
    title: display_id
    description: The order's display ID.
  items:
    type: array
    description: The order's items.
    items:
      $ref: ./BaseOrderLineItem.yaml
  shipping_methods:
    type: array
    description: The order's shipping methods.
    items:
      $ref: ./BaseOrderShippingMethod.yaml
  payment_status:
    type: string
    description: The order's payment status.
    enum:
      - canceled
      - not_paid
      - awaiting
      - authorized
      - partially_authorized
      - captured
      - partially_captured
      - partially_refunded
      - refunded
      - requires_action
  fulfillment_status:
    type: string
    description: The order's fulfillment status.
    enum:
      - canceled
      - not_fulfilled
      - partially_fulfilled
      - fulfilled
      - partially_shipped
      - shipped
      - partially_delivered
      - delivered
  transactions:
    type: array
    description: The order's transactions.
    items:
      $ref: ./BaseOrderTransaction.yaml
  summary:
    $ref: ./BaseOrderSummary.yaml
  metadata:
    type: object
    description: The order'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 the order was created.
  updated_at:
    type: string
    format: date-time
    title: updated_at
    description: The date the order was updated.
  original_item_total:
    type: number
    title: original_item_total
    description: >-
      The sum of all line items' original totals before discounts, including
      taxes.
  original_item_subtotal:
    type: number
    title: original_item_subtotal
    description: >-
      The sum of all line items' original subtotals before discounts, excluding
      taxes.
  original_item_tax_total:
    type: number
    title: original_item_tax_total
    description: The sum of all line items' original tax totals before discounts.
  item_total:
    type: number
    title: item_total
    description: The sum of all line items' totals after discounts, including taxes.
  item_subtotal:
    type: number
    title: item_subtotal
    description: The sum of all line items' subtotals before discounts, excluding taxes.
  item_tax_total:
    type: number
    title: item_tax_total
    description: The sum of all line items' tax totals after discounts.
  original_total:
    type: number
    title: original_total
    description: >-
      The order's total before discounts, including taxes. Calculated as the sum
      of `original_item_total` and `original_shipping_total`.
  original_subtotal:
    type: number
    title: original_subtotal
    description: >-
      The order's subtotal before discounts, excluding taxes. Calculated as the
      sum of `original_item_subtotal` and `original_shipping_subtotal`.
  original_tax_total:
    type: number
    title: original_tax_total
    description: >-
      The order's tax total before discounts. Calculated as the sum of
      `original_item_tax_total` and `original_shipping_tax_total`.
  total:
    type: number
    title: total
    description: The order's final total after discounts and credit lines, including taxes.
  subtotal:
    type: number
    title: subtotal
    description: >-
      The order's subtotal before discounts, excluding taxes. Calculated as the
      sum of `item_subtotal` and `shipping_subtotal`.
  tax_total:
    type: number
    title: tax_total
    description: >-
      The order's tax total after discounts. Calculated as the sum of
      `item_tax_total` and `shipping_tax_total`.
  discount_total:
    type: number
    title: discount_total
    description: >-
      The total amount of discounts applied to the order, including the tax
      portion of discounts.
  discount_tax_total:
    type: number
    title: discount_tax_total
    description: >-
      The total amount of discounts applied to the order's tax. Represents the
      tax portion of discounts.
  gift_card_total:
    type: number
    title: gift_card_total
    description: The order's gift card total.
  gift_card_tax_total:
    type: number
    title: gift_card_tax_total
    description: The tax total of the order's gift card.
  shipping_total:
    type: number
    title: shipping_total
    description: The sum of all shipping methods' totals after discounts, including taxes.
  shipping_subtotal:
    type: number
    title: shipping_subtotal
    description: >-
      The sum of all shipping methods' subtotals before discounts, excluding
      taxes.
  shipping_tax_total:
    type: number
    title: shipping_tax_total
    description: The sum of all shipping methods' tax totals after discounts.
  original_shipping_total:
    type: number
    title: original_shipping_total
    description: >-
      The sum of all shipping methods' original totals before discounts,
      including taxes.
  original_shipping_subtotal:
    type: number
    title: original_shipping_subtotal
    description: >-
      The sum of all shipping methods' original subtotals before discounts,
      excluding taxes.
  original_shipping_tax_total:
    type: number
    title: original_shipping_tax_total
    description: The sum of all shipping methods' original tax totals before discounts.
  status:
    type: string
    title: status
    description: The order's status.
  credit_line_total:
    type: number
    title: credit_line_total
    description: >-
      The total amount of credit lines applied to the order, including taxes.
      Subtracted from the final total.
  item_discount_total:
    type: number
    title: item_discount_total
    description: >-
      The sum of all discounts applied to line items, including the tax portion
      of discounts.
  shipping_discount_total:
    type: number
    title: shipping_discount_total
    description: >-
      The sum of all discounts applied to shipping methods, including the tax
      portion of discounts.
  custom_display_id:
    type: string
    title: custom_display_id
    description: The custom display ID of the order.
    externalDocs:
      url: >-
        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id