Description

Topic: Orders

Fields

billing_address: Address

billing_address_short: AddressShort

calculated: Boolean!

Whether order was successfully "calculated" or not

Example: false

cancel_reason: OrderCancelReason

The reason why the order was canceled

canceled_at: String

The date and time when the order was canceled or null

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

client_secret: String!

Pending payment intent secret when gateway is "stripe"

Example: "pi_1EaAoC2eZvKYlo2C6OmgnpXw_secret_tYSeiTjxphYCjZNjrcaCFRa5v"

closed_at: String

The date and time when the order was closed or null

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

created_at: String!

The date and time when the order was created

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

currency: String!

Currency code

Example: "USD"

custom_items: [OrderCustomItem!]

customer: StorefrontCustomer

customer_balance_spent: Int!

Amount of money spent on the customer balance

Example: 0

customer_email: String

Customer email, used in no auth order flows

Example: "foo@bar.com"

discount_code: String

Coupon code if set

display: OrderDisplay

financial_status: OrderFinancialStatus!

Financial status of the order

fulfilled_at: String

The date and time when the order was completely fulfilled

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

fulfillment_status: OrderFulfillmentStatus!

Fulfillment status of the order

gateway: Gateway

gateway_type: GatewayType

Gateway type

id: String!

A unique order identifier

Example: "or_EQzGqWoY"

line_items: [StorefrontOrderLineItem!]!

Order line items

mobile: String!

The mobile phone number of the customer (used for notifications)

Example: "45634634562"

mobile_notifications: Boolean!

Whether to notify customer via mobile phone or not

Example: false

number: Int!

Numerical order identifier unique to the shop

Example: 1001

on_hold: Boolean!

Whether server thinks order is on hold or not (depends on server time)

Example: false

on_hold_until: String

The date and time when order is no longer considered on hold

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

paid_at: String

The date and time when the order was transitioned to one of the payment states

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

payment_detail: PaymentDetail

primary_rate: Float!

Conversion rate from order's currency to shop's primary currency

Example: 1.2525236

promotion: StorefrontPromotion

reserved_at: String

The date and time when the order resources were reserved

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

round_tax_at: RoundTaxAt!

At what level the tax should be rounded

selected_shipping_rates: [StorefrontShippingRate!]!

send_fulfillment_notifications: Boolean!

Should customer receive fulfillment-related notifications or not

Example: true

send_order_notifications: Boolean!

Should customer receive order-related notifications or not

Example: true

shipping_address: Address

shipping_address_short: AddressShort

shipping_detail: ShippingDetail

shipping_price: Int!

Shipping price

Example: 0

shipping_rate_groups: [StorefrontShippingRateGroup!]

A list of available shipping rates and shipping providers (only after they were calculated)

source_name: OrderSourceName!

Where the order originated from

state: OrderState!

State of an order

subtotal_price: Int!

Price of the order before shipping and taxes

Example: 0

tax_inclusive_prices: Boolean!

Whether prices include the tax or not

Example: false

tax_rounding: Int!

Difference between sum of rounded values and rounded sum for taxes

Example: 1

tips_preview: Int!

Pre-calculated tips preview

Example: 100

total_discounts: Int!

The total amount of the discounts to be applied to the price of the order

Example: 0

total_line_items_price: Int!

The sum of all the prices of all the items in the order (before any discounts, taxes and shipping)

Example: 0

total_price: Int!

The sum of all the prices of all the items in the order, taxes and discounts included

Example: 0

total_tax: Int!

The sum of all the taxes applied to the order

Example: 0

total_weight: Int!

The sum of all the weights of the line items in the order, in grams

Example: 0

updated_at: String!

The date and time when the order was last modified

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

usd_rate: Float!

Conversion rate from order's currency to USD

Example: 1.2525236

uuid: String!

UUID for this order, used for anonymous users authorization

Example: "550e8400-e29b-41d4-a716-446655440000"

Used By

Mutations

storefrontOrdersAllocateNumber, storefrontOrdersCalculate, storefrontOrdersCancel, storefrontOrdersCancelReservation, storefrontOrdersCreate, storefrontOrdersMobile, storefrontOrdersModify, storefrontOrdersPay, storefrontOrdersReserve

Queries

storefrontOrders, storefrontOrdersLastCart

Types

StorefrontCustomerInventory, StorefrontOrderPage, StorefrontReturn, StorefrontSubscription

Preview (typescript)

Loading module