Order

admin/collections.internal.Order

Base abstract entity for all entities

Properties

beforeInsertanyRequired

billing_addressAddressRequired

billing_address_idstringRequired

canceled_atDateRequired

cartCartRequired

cart_idstringRequired

claimsClaimOrder[]Required

created_atDateRequired

currencyCurrencyRequired

currency_codestringRequired

customerCustomerRequired

customer_idstringRequired

discount_totalnumberRequired

discountsDiscount[]Required

display_idnumberRequired

draft_orderDraftOrderRequired

draft_order_idstringRequired

editsOrderEdit[]Required

emailstringRequired

external_idnull | stringRequired

fulfillment_statusFulfillmentStatusRequired

fulfillmentsFulfillment[]Required

gift_card_tax_totalnumberRequired

gift_card_totalnumberRequired

gift_card_transactionsGiftCardTransaction[]Required

gift_cardsGiftCard[]Required

idstringRequired

idempotency_keystringRequired

item_tax_totalnull | numberRequired

itemsLineItem[]Required

metadataRecord<string, unknown>Required

no_notificationbooleanRequired

object"order"Required

Default: `"order"`

paid_totalnumberRequired

payment_statusPaymentStatusRequired

paymentsPayment[]Required

raw_discount_totalnumberRequired

refundable_amountnumberRequired

refunded_totalnumberRequired

refundsRefund[]Required

regionRegionRequired

region_idstringRequired

returnable_itemsLineItem[]

returnsReturn[]Required

sales_channelSalesChannelRequired

sales_channel_idnull | stringRequired

shipping_addressAddressRequired

shipping_address_idstringRequired

shipping_methodsShippingMethod[]Required

shipping_tax_totalnull | numberRequired

shipping_totalnumberRequired

statusOrderStatusRequired

subtotalnumberRequired

swapsSwap[]Required

tax_ratenull | numberRequired

tax_totalnull | numberRequired

totalnumberRequired

updated_atDateRequired