Order - Order Module Data Models Reference

This documentation provides a reference to the Order data model. It belongs to the Order Module.

idPrimaryKeyModifier<IdProperty>

The ID of the order.

display_idAutoIncrementProperty

The display ID of the order

versionNumberProperty

The version of the order

statusEnumProperty<typeof OrderStatus>

The status of the order

is_draft_orderBooleanProperty

Whether the order is a draft order.

currency_codeTextProperty

The currency code of the order. @example usd

summaryHasMany<any>

The associated summary.

itemsHasMany<any>

The associated items.

shipping_methodsHasMany<any>

The associated shipping methods.

transactionsHasMany<any>

The associated transactions, which include amounts captured and refunded.

credit_linesHasMany<any>

The associated credit lines, which include additional payment amounts for an order.

returnsHasMany<any>

The associated returns.

region_idTextPropertyOptional

The ID of the region that the order was purchased in.

customer_idTextPropertyOptional

The ID of the customer that placed the order.

sales_channel_idTextPropertyOptional

The ID of the sales channel that the order was purchased through.

emailTextPropertyOptional

The email of the order's customer

no_notificationBooleanPropertyOptional

Whether the customer should receive notifications for order updates.

metadataJSONPropertyOptional

Holds custom data in key-value pairs.

canceled_atDateTimePropertyOptional

The date the order was canceled.

shipping_addressHasOneWithForeignKey<any, undefined>Optional

The associated shipping_address.

billing_addressHasOneWithForeignKey<any, undefined>Optional

The associated billing address.