Skip to main content

Class: Order

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Constructors

constructor

new Order()

Inherited from

BaseEntity.constructor

Properties

billing_address

billing_address: Copy to Clipboard

Defined in

models/order.ts:125


billing_address_id

billing_address_id: Copy to Clipboard

Defined in

models/order.ts:121


canceled_at

canceled_at: Copy to Clipboard

Defined in

models/order.ts:231


cart

cart: Copy to Clipboard

Defined in

models/order.ts:106


cart_id

cart_id: Copy to Clipboard

Defined in

models/order.ts:102


claims

claims: Copy to Clipboard[]

Defined in

models/order.ts:199


created_at

created_at: Copy to Clipboard

Inherited from

BaseEntity.created_at

Defined in

interfaces/models/base-entity.ts:16


currency

currency: Copy to Clipboard

Defined in

models/order.ts:149


currency_code

currency_code: Copy to Clipboard

Defined in

models/order.ts:145


customer

customer: Copy to Clipboard

Defined in

models/order.ts:114


customer_id

customer_id: Copy to Clipboard

Defined in

models/order.ts:110


discount_total

discount_total: Copy to Clipboard

Defined in

models/order.ts:256


discounts

discounts: Copy to Clipboard[]

Defined in

models/order.ts:166


display_id

display_id: Copy to Clipboard

Defined in

models/order.ts:98


draft_order

draft_order: Copy to Clipboard

Defined in

models/order.ts:212


draft_order_id

draft_order_id: Copy to Clipboard

Defined in

models/order.ts:208


edits

edits: Copy to Clipboard[]

Defined in

models/order.ts:220


email

email: Copy to Clipboard

Defined in

models/order.ts:117


external_id

external_id: Copy to Clipboard | Copy to Clipboard

Defined in

models/order.ts:243


fulfillment_status

fulfillment_status: Copy to Clipboard

Defined in

models/order.ts:90


fulfillments

fulfillments: Copy to Clipboard[]

Defined in

models/order.ts:193


gift_card_tax_total

gift_card_tax_total: Copy to Clipboard

Defined in

models/order.ts:264


gift_card_total

gift_card_total: Copy to Clipboard

Defined in

models/order.ts:263


gift_card_transactions

gift_card_transactions: Copy to Clipboard[]

Defined in

models/order.ts:228


gift_cards

gift_cards: Copy to Clipboard[]

Defined in

models/order.ts:180


id

id: Copy to Clipboard

Inherited from

BaseEntity.id

Defined in

interfaces/models/base-entity.ts:13


idempotency_key

idempotency_key: Copy to Clipboard

Defined in

models/order.ts:240


items

items: Copy to Clipboard[]

Defined in

models/order.ts:225


metadata

metadata: Copy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Defined in

models/order.ts:234


no_notification

no_notification: Copy to Clipboard

Defined in

models/order.ts:237


object

Copy to Clipboard object: Copy to Clipboard

Defined in

models/order.ts:80


paid_total: Copy to Clipboard

Defined in

models/order.ts:261


payment_status

payment_status: Copy to Clipboard

Defined in

models/order.ts:93


payments

payments: Copy to Clipboard[]

Defined in

models/order.ts:188


refundable_amount

refundable_amount: Copy to Clipboard

Defined in

models/order.ts:262


refunded_total

refunded_total: Copy to Clipboard

Defined in

models/order.ts:258


refunds

refunds: Copy to Clipboard[]

Defined in

models/order.ts:202


region

region: Copy to Clipboard

Defined in

models/order.ts:141


region_id

region_id: Copy to Clipboard

Defined in

models/order.ts:137


returns

returns: Copy to Clipboard[]

Defined in

models/order.ts:196


sales_channel

sales_channel: Copy to Clipboard

Defined in

models/order.ts:252


sales_channel_id

sales_channel_id: Copy to Clipboard | Copy to Clipboard

Defined in

models/order.ts:246


shipping_address

shipping_address: Copy to Clipboard

Defined in

models/order.ts:133


shipping_address_id

shipping_address_id: Copy to Clipboard

Defined in

models/order.ts:129


shipping_methods

shipping_methods: Copy to Clipboard[]

Defined in

models/order.ts:185


shipping_total

shipping_total: Copy to Clipboard

Defined in

models/order.ts:255


status

status: Copy to Clipboard

Defined in

models/order.ts:83


subtotal

subtotal: Copy to Clipboard

Defined in

models/order.ts:260


swaps

swaps: Copy to Clipboard[]

Defined in

models/order.ts:205


tax_rate

tax_rate: Copy to Clipboard | Copy to Clipboard

Defined in

models/order.ts:152


tax_total

tax_total: Copy to Clipboard | Copy to Clipboard

Defined in

models/order.ts:257


total

total: Copy to Clipboard

Defined in

models/order.ts:259


updated_at

updated_at: Copy to Clipboard

Inherited from

BaseEntity.updated_at

Defined in

interfaces/models/base-entity.ts:19

Methods

beforeInsert

Copy to Clipboard beforeInsert(): Copy to Clipboard<Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

models/order.ts:266