Description

Topic: Orders

Fields

billing_address: AddressCreate!

billing_address_short_id: String

cancel_reason: OrderCancelReason

The reason why the order was canceled

canceled_at: String

coupon_id: String!

created_at: String!

currency: String!

custom_items: [OICustomItem!]

customer_balance_spent: Int!

customer_id: String!

financial_status: OrderFinancialStatus!

Financial status of the order

fulfilled_at: String

fulfillment_status: OrderFulfillmentStatus!

Fulfillment status of the order

fulfillments: [OIOrderFulfillment!]

history: [OIOrderHistory!]

line_items: [OIOrderLineItem!]!

mobile: String!

mobile_notifications: Boolean!

number: Int!

paid_at: String!

payment_detail: OIPaymentDetail

primary_rate: Float!

promotion_id: String!

recovered: Boolean!

reserved_at: String!

restored_at: String

round_tax_at: RoundTaxAt!

At what level the tax should be rounded

sales_channel_id: String

shipping_address: AddressCreate!

shipping_address_override: AddressCreate

shipping_address_short_id: String

shipping_detail: OIShippingDetail!

shipping_price: Int!

source_name: OrderSourceName!

Where the order originated from

subtotal_price: Int!

tags: [String!]

Order tags (can be used for organization)

tax_inclusive_prices: Boolean!

tax_rounding: Int!

total_discounts: Int!

total_line_items_price: Int!

total_price: Int!

total_tax: Int!

total_weight: Int!

usd_rate: Float!

Used By

Mutations

ordersCreateImported

Preview (typescript)

interface OIOrder {
billing_address: AddressCreate
billing_address_short_id?: string
cancel_reason?: OrderCancelReason | null
canceled_at?: string
coupon_id: string
created_at: string
currency: string
custom_items?: OICustomItem[]
customer_balance_spent: number
customer_id: string
financial_status: OrderFinancialStatus
fulfilled_at?: string
fulfillment_status: OrderFulfillmentStatus
fulfillments?: OIOrderFulfillment[]
history?: OIOrderHistory[]
line_items: OIOrderLineItem[]
mobile: string
mobile_notifications: boolean
number: number
paid_at: string
payment_detail?: OIPaymentDetail | null
primary_rate: number
promotion_id: string
recovered: boolean
reserved_at: string
restored_at?: string
round_tax_at: RoundTaxAt
sales_channel_id?: string
shipping_address: AddressCreate
shipping_address_override?: AddressCreate | null
shipping_address_short_id?: string
shipping_detail: OIShippingDetail
shipping_price: number
source_name: OrderSourceName
subtotal_price: number
tags?: string[]
tax_inclusive_prices: boolean
tax_rounding: number
total_discounts: number
total_line_items_price: number
total_price: number
total_tax: number
total_weight: number
usd_rate: number
}