Skip to main content

Class: Order

Hierarchy​

  • BaseEntity

    ↳ Order

Constructors​

constructor​

• new Order()

Inherited from​

BaseEntity.constructor

Properties​

billing_address​

• billing_address: Address

Defined in​

models/order.ts:125

billing_address_id​

• billing_address_id: string

Defined in​

models/order.ts:121

canceled_at​

• canceled_at: Date

Defined in​

models/order.ts:231

cart​

• cart: Cart

Defined in​

models/order.ts:106

cart_id​

• cart_id: string

Defined in​

models/order.ts:102

claims​

• claims: ClaimOrder[]

Defined in​

models/order.ts:199

created_at​

• created_at: Date

Inherited from​

BaseEntity.created_at

Defined in​

interfaces/models/base-entity.ts:16

currency​

• currency: Currency

Defined in​

models/order.ts:149

currency_code​

• currency_code: string

Defined in​

models/order.ts:145

customer​

• customer: Customer

Defined in​

models/order.ts:114

customer_id​

• customer_id: string

Defined in​

models/order.ts:110

discount_total​

• discount_total: number

Defined in​

models/order.ts:256

discounts​

• discounts: Discount[]

Defined in​

models/order.ts:166

display_id​

• display_id: number

Defined in​

models/order.ts:98

draft_order​

• draft_order: DraftOrder

Defined in​

models/order.ts:212

draft_order_id​

• draft_order_id: string

Defined in​

models/order.ts:208

edits​

• edits: OrderEdit[]

Defined in​

models/order.ts:220

email​

• email: string

Defined in​

models/order.ts:117

external_id​

• external_id: null | string

Defined in​

models/order.ts:243

fulfillment_status​

• fulfillment_status: FulfillmentStatus

Defined in​

models/order.ts:90

fulfillments​

• fulfillments: Fulfillment[]

Defined in​

models/order.ts:193

gift_card_tax_total​

• gift_card_tax_total: number

Defined in​

models/order.ts:264

gift_card_total​

• gift_card_total: number

Defined in​

models/order.ts:263

gift_card_transactions​

• gift_card_transactions: GiftCardTransaction[]

Defined in​

models/order.ts:228

gift_cards​

• gift_cards: GiftCard[]

Defined in​

models/order.ts:180

id​

• id: string

Inherited from​

BaseEntity.id

Defined in​

interfaces/models/base-entity.ts:13

idempotency_key​

• idempotency_key: string

Defined in​

models/order.ts:240

items​

• items: LineItem[]

Defined in​

models/order.ts:225

metadata​

• metadata: Record<string, unknown>

Defined in​

models/order.ts:234

no_notification​

• no_notification: boolean

Defined in​

models/order.ts:237

object​

• Readonly object: "order"

Defined in​

models/order.ts:80

• paid_total: number

Defined in​

models/order.ts:261

payment_status​

• payment_status: PaymentStatus

Defined in​

models/order.ts:93

payments​

• payments: Payment[]

Defined in​

models/order.ts:188

refundable_amount​

• refundable_amount: number

Defined in​

models/order.ts:262

refunded_total​

• refunded_total: number

Defined in​

models/order.ts:258

refunds​

• refunds: Refund[]

Defined in​

models/order.ts:202

region​

• region: Region

Defined in​

models/order.ts:141

region_id​

• region_id: string

Defined in​

models/order.ts:137

returns​

• returns: Return[]

Defined in​

models/order.ts:196

sales_channel​

• sales_channel: SalesChannel

Defined in​

models/order.ts:252

sales_channel_id​

• sales_channel_id: null | string

Defined in​

models/order.ts:246

shipping_address​

• shipping_address: Address

Defined in​

models/order.ts:133

shipping_address_id​

• shipping_address_id: string

Defined in​

models/order.ts:129

shipping_methods​

• shipping_methods: ShippingMethod[]

Defined in​

models/order.ts:185

shipping_total​

• shipping_total: number

Defined in​

models/order.ts:255

status​

• status: OrderStatus

Defined in​

models/order.ts:83

subtotal​

• subtotal: number

Defined in​

models/order.ts:260

swaps​

• swaps: Swap[]

Defined in​

models/order.ts:205

tax_rate​

• tax_rate: null | number

Defined in​

models/order.ts:152

tax_total​

• tax_total: null | number

Defined in​

models/order.ts:257

total​

• total: number

Defined in​

models/order.ts:259

updated_at​

• updated_at: Date

Inherited from​

BaseEntity.updated_at

Defined in​

interfaces/models/base-entity.ts:19

Methods​

beforeInsert​

▸ Private beforeInsert(): Promise<void>

Returns​

Promise<void>

Defined in​

models/order.ts:266