• Overview
  • Examples
  • Recipes
  • Commerce Modules
  • Architectural Modules
  • Integrations
  • Storefront Development
    • SDKs and Tools
    • create-medusa-app
    • Medusa CLI
    • JS SDK
    • Next.js Starter Storefront
    General
    • Medusa Configurations
    • Deployment Guides
    • Troubleshooting Guides
    Admin
    • Admin Widget Injection Zones
    • Admin Components
    Lists
    • Container Dependencies
    • Events List
    References
    • Workflows SDK
    • Data Model Language
    • Service Factory
    • Helper Steps
    • Core Workflows
    • Testing Framework
    Other
    • Contribution Guidelines
      • Docs
      • Admin Translations
    • Usage
  • Get Started
  • Product
    Commerce Modules
    Architectural Modules
  • Resources
    Guides
    Examples
    Recipes
    Admin Components
    Storefront Development
    UI Library
  • Tools & SDKs
    Medusa CLI
    JS SDK
    Next.js Starter
    create-medusa-app
    Integrations
  • Framework
    Modules
    API Routes
    Workflows
    Data Models
    Subscribers
    Scheduled Jobs
    Loaders
    Admin Customizations
    Links
    Query
  • Reference
    Admin API
    Store API
    Core Workflows
    Data Model Language
    Service Factory
    Events Reference
    Admin Widget Injection Zones
v2.2·Report Issue
Homepage
Medusa v1
Changelog
Troubleshooting
Hide Sidebar⌘\
Theme
Light
Dark
Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

OrderDTO

The order details.

Loading...
Was this page helpful?
Edit this page
      Guides
      • All Areas
      • Guides
      • References
      • Admin API (v2)
      • Store API (v2)
      • Medusa UI
      Navigation↑↓
      Open Result↵
      idstring
      The ID of the order.
      versionnumber
      The version of the order.
      display_idnumber
      The order's display ID.
      statusOrderStatus
      The status of the order.
      currency_codestring
      The currency of the order
      created_atstring | Date
      When the order was created.
      updated_atstring | Date
      When the order was updated.
      original_item_totalBigNumberValue
      The original item total of the order.
      original_item_subtotalBigNumberValue
      The original item subtotal of the order.
      original_item_tax_totalBigNumberValue
      The original item tax total of the order.
      item_totalBigNumberValue
      The item total of the order.
      item_subtotalBigNumberValue
      The item subtotal of the order.
      item_tax_totalBigNumberValue
      The item tax total of the order.
      original_totalBigNumberValue
      The original total of the order.
      original_subtotalBigNumberValue
      The original subtotal of the order.
      original_tax_totalBigNumberValue
      The original tax total of the order.
      totalBigNumberValue
      The total of the order.
      subtotalBigNumberValue
      The subtotal of the order. (Excluding taxes)
      tax_totalBigNumberValue
      The tax total of the order.
      discount_subtotalBigNumberValue
      The discount subtotal of the order.
      discount_totalBigNumberValue
      The discount total of the order.
      discount_tax_totalBigNumberValue
      The discount tax total of the order.
      gift_card_totalBigNumberValue
      The gift card total of the order.
      gift_card_tax_totalBigNumberValue
      The gift card tax total of the order.
      shipping_totalBigNumberValue
      The shipping total of the order.
      shipping_subtotalBigNumberValue
      The shipping subtotal of the order.
      shipping_tax_totalBigNumberValue
      The shipping tax total of the order.
      original_shipping_totalBigNumberValue
      The original shipping total of the order.
      original_shipping_subtotalBigNumberValue
      The original shipping subtotal of the order.
      original_shipping_tax_totalBigNumberValue
      The original shipping tax total of the order.
      raw_original_item_totalBigNumberRawValue
      The raw original item total of the order.
      raw_original_item_subtotalBigNumberRawValue
      The raw original item subtotal of the order.
      raw_original_item_tax_totalBigNumberRawValue
      The raw original item tax total of the order.
      raw_item_totalBigNumberRawValue
      The raw item total of the order.
      raw_item_subtotalBigNumberRawValue
      The raw item subtotal of the order.
      raw_item_tax_totalBigNumberRawValue
      The raw item tax total of the order.
      raw_original_totalBigNumberRawValue
      The raw original total of the order.
      raw_original_subtotalBigNumberRawValue
      The raw original subtotal of the order.
      raw_original_tax_totalBigNumberRawValue
      The raw original tax total of the order.
      raw_totalBigNumberRawValue
      The raw total of the order.
      raw_subtotalBigNumberRawValue
      The raw subtotal of the order. (Excluding taxes)
      raw_tax_totalBigNumberRawValue
      The raw tax total of the order.
      raw_discount_totalBigNumberRawValue
      The raw discount total of the order.
      raw_discount_tax_totalBigNumberRawValue
      The raw discount tax total of the order.
      raw_gift_card_totalBigNumberRawValue
      The raw gift card total of the order.
      raw_gift_card_tax_totalBigNumberRawValue
      The raw gift card tax total of the order.
      raw_shipping_totalBigNumberRawValue
      The raw shipping total of the order.
      raw_shipping_subtotalBigNumberRawValue
      The raw shipping subtotal of the order.
      raw_shipping_tax_totalBigNumberRawValue
      The raw shipping tax total of the order.
      raw_original_shipping_totalBigNumberRawValue
      The raw original shipping total of the order.
      raw_original_shipping_subtotalBigNumberRawValue
      The raw original shipping subtotal of the order.
      raw_original_shipping_tax_totalBigNumberRawValue
      The raw original shipping tax total of the order.
      order_changeOrderChangeDTOOptional
      The active order change, if any.
      region_idstringOptional
      The ID of the region the order belongs to.
      customer_idstringOptional
      The ID of the customer on the order.
      sales_channel_idstringOptional
      The ID of the sales channel the order belongs to.
      emailstringOptional
      The email of the order.
      shipping_addressOrderAddressDTOOptional
      The associated shipping address.
      billing_addressOrderAddressDTOOptional
      The associated billing address.
      itemsOrderLineItemDTO[]Optional
      The associated order details / line items.
      shipping_methodsOrderShippingMethodDTO[]Optional
      The associated shipping methods
      transactionsOrderTransactionDTO[]Optional
      The tramsactions associated with the order
      credit_linesOrderCreditLineDTO[]Optional
      The credit lines for an order
      summaryOrderSummaryDTOOptional
      The summary of the order totals.
      metadatanull | Record<string, unknown>Optional
      Holds custom data in key-value pairs.
      canceled_atstring | DateOptional
      When the order was canceled.