11 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| entitiesSidebar |
Class: Order
Hierarchy
-
BaseEntity↳
Order
Constructors
constructor
• new Order()
Inherited from
BaseEntity.constructor
Properties
billing_address
• billing_address: Address
Defined in
billing_address_id
• billing_address_id: string
Defined in
canceled_at
• canceled_at: Date
Defined in
cart
• cart: Cart
Defined in
cart_id
• cart_id: string
Defined in
claims
• claims: ClaimOrder[]
Defined in
created_at
• created_at: Date
Inherited from
BaseEntity.created_at
Defined in
interfaces/models/base-entity.ts:16
currency
• currency: Currency
Defined in
currency_code
• currency_code: string
Defined in
customer
• customer: Customer
Defined in
customer_id
• customer_id: string
Defined in
discount_total
• discount_total: number
Defined in
discounts
• discounts: Discount[]
Defined in
display_id
• display_id: number
Defined in
draft_order
• draft_order: DraftOrder
Defined in
draft_order_id
• draft_order_id: string
Defined in
edits
• edits: OrderEdit[]
Defined in
• email: string
Defined in
external_id
• external_id: null | string
Defined in
fulfillment_status
• fulfillment_status: FulfillmentStatus
Defined in
fulfillments
• fulfillments: Fulfillment[]
Defined in
gift_card_tax_total
• gift_card_tax_total: number
Defined in
gift_card_total
• gift_card_total: number
Defined in
gift_card_transactions
• gift_card_transactions: GiftCardTransaction[]
Defined in
gift_cards
• gift_cards: GiftCard[]
Defined in
id
• id: string
Inherited from
BaseEntity.id
Defined in
interfaces/models/base-entity.ts:13
idempotency_key
• idempotency_key: string
Defined in
items
• items: LineItem[]
Defined in
metadata
• metadata: Record<string, unknown>
Defined in
no_notification
• no_notification: boolean
Defined in
object
• Readonly object: "order"
Defined in
paid_total
• paid_total: number
Defined in
payment_status
• payment_status: PaymentStatus
Defined in
payments
• payments: Payment[]
Defined in
raw_discount_total
• raw_discount_total: number
Defined in
refundable_amount
• refundable_amount: number
Defined in
refunded_total
• refunded_total: number
Defined in
refunds
• refunds: Refund[]
Defined in
region
• region: Region
Defined in
region_id
• region_id: string
Defined in
returnable_items
• Optional returnable_items: LineItem[]
Defined in
returns
• returns: Return[]
Defined in
sales_channel
• sales_channel: SalesChannel
Defined in
sales_channel_id
• sales_channel_id: null | string
Defined in
shipping_address
• shipping_address: Address
Defined in
shipping_address_id
• shipping_address_id: string
Defined in
shipping_methods
• shipping_methods: ShippingMethod[]
Defined in
shipping_total
• shipping_total: number
Defined in
status
• status: OrderStatus
Defined in
subtotal
• subtotal: number
Defined in
swaps
• swaps: Swap[]
Defined in
tax_rate
• tax_rate: null | number
Defined in
tax_total
• tax_total: null | number
Defined in
total
• total: number
Defined in
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>