Class: Order

Hierarchy

• BaseEntityCopy to Clipboard

  ↳ OrderCopy to Clipboard

Constructors

constructor

• new Order()

Inherited from

BaseEntity.constructor

Properties

billing_address

• billing_address: AddressCopy to Clipboard

Defined in

models/order.ts:125

---

billing_address_id

• billing_address_id: stringCopy to Clipboard

Defined in

models/order.ts:121

---

canceled_at

• canceled_at: DateCopy to Clipboard

Defined in

models/order.ts:231

---

cart

• cart: CartCopy to Clipboard

Defined in

models/order.ts:106

---

cart_id

• cart_id: stringCopy to Clipboard

Defined in

models/order.ts:102

---

claims

• claims: ClaimOrderCopy to Clipboard[]

Defined in

models/order.ts:199

---

created_at

• created_at: DateCopy to Clipboard

Inherited from

BaseEntity.created_at

Defined in

interfaces/models/base-entity.ts:16

---

currency

• currency: CurrencyCopy to Clipboard

Defined in

models/order.ts:149

---

currency_code

• currency_code: stringCopy to Clipboard

Defined in

models/order.ts:145

---

customer

• customer: CustomerCopy to Clipboard

Defined in

models/order.ts:114

---

customer_id

• customer_id: stringCopy to Clipboard

Defined in

models/order.ts:110

---

discount_total

• discount_total: numberCopy to Clipboard

Defined in

models/order.ts:256

---

discounts

• discounts: DiscountCopy to Clipboard[]

Defined in

models/order.ts:166

---

display_id

• display_id: numberCopy to Clipboard

Defined in

models/order.ts:98

---

draft_order

• draft_order: DraftOrderCopy to Clipboard

Defined in

models/order.ts:212

---

draft_order_id

• draft_order_id: stringCopy to Clipboard

Defined in

models/order.ts:208

---

edits

• edits: OrderEditCopy to Clipboard[]

Defined in

models/order.ts:220

---

email

• email: stringCopy to Clipboard

Defined in

models/order.ts:117

---

external_id

• external_id: nullCopy to Clipboard | stringCopy to Clipboard

Defined in

models/order.ts:243

---

fulfillment_status

• fulfillment_status: FulfillmentStatusCopy to Clipboard

Defined in

models/order.ts:90

---

fulfillments

• fulfillments: FulfillmentCopy to Clipboard[]

Defined in

models/order.ts:193

---

gift_card_tax_total

• gift_card_tax_total: numberCopy to Clipboard

Defined in

models/order.ts:264

---

gift_card_total

• gift_card_total: numberCopy to Clipboard

Defined in

models/order.ts:263

---

gift_card_transactions

• gift_card_transactions: GiftCardTransactionCopy to Clipboard[]

Defined in

models/order.ts:228

---

gift_cards

• gift_cards: GiftCardCopy to Clipboard[]

Defined in

models/order.ts:180

---

id

• id: stringCopy to Clipboard

Inherited from

BaseEntity.id

Defined in

interfaces/models/base-entity.ts:13

---

idempotency_key

• idempotency_key: stringCopy to Clipboard

Defined in

models/order.ts:240

---

items

• items: LineItemCopy to Clipboard[]

Defined in

models/order.ts:225

---

metadata

• metadata: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Defined in

models/order.ts:234

---

no_notification

• no_notification: booleanCopy to Clipboard

Defined in

models/order.ts:237

---

object

• ReadonlyCopy to Clipboard object: "order"Copy to Clipboard

Defined in

models/order.ts:80

---

paid_total

• paid_total: numberCopy to Clipboard

Defined in

models/order.ts:261

---

payment_status

• payment_status: PaymentStatusCopy to Clipboard

Defined in

models/order.ts:93

---

payments

• payments: PaymentCopy to Clipboard[]

Defined in

models/order.ts:188

---

refundable_amount

• refundable_amount: numberCopy to Clipboard

Defined in

models/order.ts:262

---

refunded_total

• refunded_total: numberCopy to Clipboard

Defined in

models/order.ts:258

---

refunds

• refunds: RefundCopy to Clipboard[]

Defined in

models/order.ts:202

---

region

• region: RegionCopy to Clipboard

Defined in

models/order.ts:141

---

region_id

• region_id: stringCopy to Clipboard

Defined in

models/order.ts:137

---

returns

• returns: ReturnCopy to Clipboard[]

Defined in

models/order.ts:196

---

sales_channel

• sales_channel: SalesChannelCopy to Clipboard

Defined in

models/order.ts:252

---

sales_channel_id

• sales_channel_id: nullCopy to Clipboard | stringCopy to Clipboard

Defined in

models/order.ts:246

---

shipping_address

• shipping_address: AddressCopy to Clipboard

Defined in

models/order.ts:133

---

shipping_address_id

• shipping_address_id: stringCopy to Clipboard

Defined in

models/order.ts:129

---

shipping_methods

• shipping_methods: ShippingMethodCopy to Clipboard[]

Defined in

models/order.ts:185

---

shipping_total

• shipping_total: numberCopy to Clipboard

Defined in

models/order.ts:255

---

status

• status: OrderStatusCopy to Clipboard

Defined in

models/order.ts:83

---

subtotal

• subtotal: numberCopy to Clipboard

Defined in

models/order.ts:260

---

swaps

• swaps: SwapCopy to Clipboard[]

Defined in

models/order.ts:205

---

tax_rate

• tax_rate: nullCopy to Clipboard | numberCopy to Clipboard

Defined in

models/order.ts:152

---

tax_total

• tax_total: nullCopy to Clipboard | numberCopy to Clipboard

Defined in

models/order.ts:257

---

total

• total: numberCopy to Clipboard

Defined in

models/order.ts:259

---

updated_at

• updated_at: DateCopy to Clipboard

Inherited from

BaseEntity.updated_at

Defined in

interfaces/models/base-entity.ts:19

Methods

beforeInsert

▸ PrivateCopy to Clipboard beforeInsert(): PromiseCopy to Clipboard<voidCopy to Clipboard>

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

models/order.ts:266