Order - Order Module Data Models Reference

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

idstringRequired

region_idnull | stringRequired

Default: null

customer_idnull | stringRequired

Default: null

versionnumberRequired

Default: 1

sales_channel_idnull | stringRequired

Default: null

statusOrderStatusRequired

is_draft_orderbooleanRequired

Default: false

emailnull | stringRequired

Default: null

currency_codestringRequired

no_notificationnull | booleanRequired

Default: null

summaryCollection<OrderSummary, object>Required

metadatanull | Record<string, unknown>Required

Default: null

itemsCollection<OrderItem, object>Required

shipping_methodsCollection<ShippingMethod, object>Required

transactionsCollection<Transaction, object>Required

created_atDateRequired

updated_atDateRequired

deleted_atnull | DateRequired

Default: null

canceled_atnull | DateRequired

Default: null

[OptionalProps]OptionalOrderProps

shipping_address_idnull | string

shipping_addressnull | Address

billing_address_idnull | string

billing_addressnull | Address