Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

Order - Order Module Data Models Reference

This documentation provides a reference to the Order . This belongs to the Order Module.

idstring
display_idnumber
region_idnull | string

Default: null

customer_idnull | string

Default: null

versionnumber

Default: 1

sales_channel_idnull | string

Default: null

statusOrderStatus
is_draft_orderboolean

Default: false

emailnull | string

Default: null

currency_codestring
no_notificationnull | boolean

Default: null

summaryCollection<OrderSummary, object>
metadatanull | Record<string, unknown>

Default: null

itemsCollection<OrderItem, object>
shipping_methodsCollection<OrderShipping, object>
transactionsCollection<OrderTransaction, object>
created_atDate
updated_atDate
deleted_atnull | Date

Default: null

canceled_atnull | Date

Default: null

[OptionalProps]OptionalOrderPropsOptional
shipping_address_idnull | stringOptional
shipping_addressnull | OrderAddressOptional
billing_address_idnull | stringOptional
billing_addressnull | OrderAddressOptional
Was this page helpful?