Description

Topic: Orders

Fields

abandoned_at: String

The date and time when the order was last abandoned

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

Timestamp (RFC 3339)

abandoned_email_message: Message

Abandoned order recovery email message (you can use it to perform a resend)

Expandable

Permission bit: "messages.read"

abandoned_email_processed_at: String

The date and time when order was considered for recovery email notification

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

Timestamp (RFC 3339)

abandoned_times: Int!

Number of times this order was abandoned

Example: 5

authorization_expires_at: String

The date and time when order payment authorization expires

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

Timestamp (RFC 3339)

billing_address: Address

Billing address of the order

billing_address_short: AddressShort

Short version of the billing address

Expandable

calc_log: [OrderCalcLog!]!

Order calculation log

calculated: Boolean!

Whether order was successfully "calculated" or not

Example: false

cancel_reason: OrderCancelReason

The reason why the order was canceled

Example: "customer"

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)

coupon: Coupon

Coupon associated with the order (when "discount_code" is provided and resolved)

Expandable

Permission bit: "coupons.read"

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!]

Custom line items defined for this order

customer: Customer

Customer who created the order

Expandable

Permission bit: "customers.read"

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

draft_number: Int!

Numerical draft order identifier unique to the shop

Example: 1

financial_status: OrderFinancialStatus!

Financial status of the order

Example: "unpaid"

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

Example: "unfulfilled"

gateway: Gateway

Gateway picked for this order

Expandable

Permission bit: "gateways.read"

gateway_type: GatewayType

Gateway type

history: [OrderHistory!]!

Order history

id: String!

A unique order identifier

Example: "or_EQzGqWoY"

invoice_due_date: String

Due date and time for order's invoice

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

Timestamp (RFC 3339)

invoice_email_message: Message

Invoice email message (you can use it to perform a resend)

Expandable

Permission bit: "messages.read"

line_items: [OrderLineItem!]!

Order line items

lost_at: String

The date and time when the order was marked as lost

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

Timestamp (RFC 3339)

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)

packaging_detail: [PackedBox!]!

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)

paid_email_message: Message

Email that was sent on payment (you can use it to perform a resend)

Expandable

Permission bit: "messages.read"

payment_detail: PaymentDetail

primary_rate: Float!

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

Example: 1.2525236

promotion: Promotion

Promotion associated with the order (when "discount_code" is provided and resolved)

Expandable

Permission bit: "promotions.read"

recovered: Boolean!

Whether this order is considered as recovered (before entering paid state it was abandoned)

Example: false

reserved_at: String

The date and time when the order resources were reserved

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

Timestamp (RFC 3339)

restored_at: String

The date and time when the order was last restored from being abandoned

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

Timestamp (RFC 3339)

review_reminder_email_message: Message

Review reminder email message (you can use it to perform a resend)

Expandable

Permission bit: "messages.read"

review_reminder_email_processed_at: String

The date and time when order was considered for review reminder email notification

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

Timestamp (RFC 3339)

risk: OrderRisk

Risk evaluation result for this order

Expandable

round_tax_at: RoundTaxAt!

At what level the tax should be rounded

rule_eval_detail: OrderRuleEvalDetail!

sales_channel: SalesChannel

Sales channel associated with this order

Expandable

Permission bit: "sales_channels.read"

selected_shipping_rates: [ShippingRate!]!

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 of the order

shipping_address_override: Address

Shipping address override

shipping_address_short: AddressShort

Short version of the shipping address

Expandable

shipping_address_verification: AddressVerification

Verification status of the shipping address

shipping_detail: ShippingDetail

shipping_price: Int!

Shipping price

Example: 0

shipping_rate_groups: [ShippingRateGroup!]

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

source_name: OrderSourceName!

Where the order originated from

Example: "web"

state: OrderState!

State of an order

Example: "cart"

subscription: Subscription

Subscription associated with this order

Expandable

Permission bit: "subscriptions.read"

subtotal_price: Int!

Price of the order before shipping and taxes

Example: 0

tags: [String!]!

Order tags (can be used for organization)

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

unpacked_items: [UnpackedItem!]!

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

user: User

User who created the order

Expandable

Permission bit: "users.read"

uuid: String!

UUID for this order, used for anonymous users authorization

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

Used By

Mutations

ordersAllocateNumber, ordersCalculate, ordersCancel, ordersCancelReservation, ordersCapture, ordersCreate, ordersCreateImported, ordersModify, ordersOverride, ordersPay, ordersRefund, ordersReserve, ordersRestock, ordersSendInvoice, ordersSendReminder

Queries

orders

Types

Customer, CustomerBalance, CustomerInventory, OrderExpandableItems, OrderPage, OrderSearchResult, Return, Subscription, UnifiedSearchResult

Preview (typescript)

Loading module