This query will return a single order given its id.

The id of the order to retrieve

This query will return a customer event given its id.

The id of the customer to retrieve

This query will return an OrderConnection containing the requested data along with pagination information for users to continue paging through this customers orders.

The id of the customer to retrieve orders for

(Optional) Supported filter parameters

This query will return an OrderConnection containing the requested data along with pagination information for users to continue paging through all filtered orders.

(Optional) Supported filter parameters

This query will return an CustomerConnection containing the requested data along with pagination information for users to continue paging through all filtered customers.

(Optional) Supported filter parameters

The unique address id

The two-letter code for the country of the address.

The region of the address, such as the province, state, or district.

The name of the city, district, village, or town

The postal code for the address

The state for the address

The first line of the address. Typically the street address or PO Box number.

The second line of the address. Typically the number of the apartment, suite, or unit.

A comment about the address

⚠️ DEPRECATED

use postalCode instead

⚠️ DEPRECATED

use countryISO2 instead

When the tax result was created

Service that was used for generating tax data

Currency in ISO 4217 three-letter format.

Tax data for order items.

Tax data for order shipping.

Time at which the tax data will expire. Measured in seconds since the Unix epoch.

External ID used in tax service API (e.g. stripe).

Tax datetime that was used for calculating the tax data. Measured in seconds since the Unix epoch.

Item ID. Filled only for items data.

Amount used for calculating taxes in string-decimal format.

Amount of taxes for this object in string-decimal format.

Quantity of items. Filled only for items data.

Specifies whether the amount includes taxes.
Could be 'inclusive' or 'exclusive'.

Tax code used for calculating taxes for this object.
Depends on the used tax service API.

Tax details breakdown (if tax service API provides this data).

Amount of tax in string-decimal format.

The reasoning behind this tax.
Depends on the used tax service API.

A localized display name for tax type, intended to be human-readable.
Depends on the used tax service API.

The tax rate percentage in string-decimal format.

The tax type, such as 'vat' or 'sales_tax'.
Depends on the used tax service API.

Total amount of items without taxes in string-decimal format.

Total amount of items taxes in string-decimal format.

Total amount of items with taxes in string-decimal format.

Tax details for these items.

Total amount of shipping without taxes in string-decimal format.

Total amount of shipping taxes in string-decimal format.

Total amount of shipping with taxes in string-decimal format.

Tax details for the shipping.

The unique customer id

The customers first name

The customers last name

The customers email

The customers phone number

A map of meta data for the customer

The customers addresses

When the customer was created

When the customer was last modified

The external id of the source, used for syncing with external systems

The destination id of the customer, used for syncing with external systems

Information to aid in pagination.

A list of edges.

A cursor for use in pagination.

The customer data

The unique fulfillment id

The external id for the fulfillment

External location ID that has been assigned for fulfillment work

The destination where the items should be sent

The type of delivery

The type of delivery method

The nacelle status of the fulfillment

The merchant status of the fulfillment

The current shipment status of the fulfillment

Timestamp at which the Fulfillment has been delivered (unix timestamp in seconds)

Comment describing when delivery expected, received from the shipping company.
E.g. "28 July 2023 before 9pm".

The name of the tracking company

A list of tracking numbers provided by the shipping company

A list of tracking URLs

A list of order item fulfillment data

Information to aid in pagination.

An array of FulfillmentsEdge's.

A cursor for use in pagination.

The fulfillment data

Order Item ID

Quantity of fulfilled goods for this Order Item

[source] An amount for the money

[source] A currencyCode identifier for the amount

[source] (optional) The precision to which the currency amount should be displayed

The unique order id

The status of the order

The nacelle entry id of the order

The email address associated with the customer.

The phone number associated with the customer.

The external id of the orders source

The destination id of the order, used for syncing with external systems

A comment about the order

When the order was created

When the order was last modified

When the order was canceled

The reason the order was canceled

The currency of the order for example USD, CAD, etc.

The shipping method for the order

[source] The meta data for the order

[source] The customer for the order

[source] The shipping address for the order

[source] The billing address for the order

[source] The payment information for the order

[source] The tax calculation information for the order

The tax rate of the order in string-decimal format

The shipping price of the order

⚠️ DEPRECATED

use items instead

[source] A query to get all the order items based on the filter

[source] Supported filter parameters

[source] A query to get all the fulfillments based on the filter

[source] Supported filter parameters

[source] The total price of the order

[source] The subtotal price of the order

[source] The total tax of the order

[source] The total discounts of the order

⚠️ DEPRECATED

use payment instead

⚠️ DEPRECATED

use payment instead

⚠️ DEPRECATED

use payment instead

⚠️ DEPRECATED

use price instead

⚠️ DEPRECATED

use subtotalPrice instead

⚠️ DEPRECATED

use tax instead

⚠️ DEPRECATED

use discounts instead

Information to aid in pagination.

A list of edges.

A cursor for use in pagination.

The item at the end of OrderEdge.

The unique order item id

The nacelle entry id of the product this item represents

The nacelle entery id of the variant this item represents

The status of the order item

The external id of the order item

The destination id of the order item, used for syncing with external systems

A comment about the order item

The total price of the order item

The subtotal price of the order item

The total tax of the order item

The total discounts of the order item

The tax rate of the order item in string-decimal format

The total quantity of the order item

The meta data for the order item

The product sku

When the order item was created

⚠️ DEPRECATED

use meta instead

⚠️ DEPRECATED

use productID instead

⚠️ DEPRECATED

use variantID instead

⚠️ DEPRECATED

use priceAmount instead

Information to aid in pagination.

An array of OrderItemsEdge's.

A cursor for use in pagination.

The order item data

Whether there is a next page to view

Whether there is a previous page to view

The starting cursor of this request

The ending cursor of this request

The unique payment id

The status of the payment

The total price of the payment

The currency of the payment for example USD, CAD, etc.

The external id for the payment for example the stripe payment intent id

The payment processor name for the payment. For example Stripe, Paypal, etc.

The type of payment. For example credit card, paypal, etc.

The status of the payment processor

The meta data for the payment

The brand of the card used for the payment. For example Visa, Mastercard, etc.

⚠️ DEPRECATED

use amountValue instead

⚠️ DEPRECATED

use cardBrand instead

(Optional) A cursor for navigating in forwards through data

(Optional) A cursor for navigating in backwards through data

(Optional) Returns the first n collections of a query. Defaults to 50. Max value of 100

(Optional) A cursor for navigating in forwards through data

(Optional) A cursor for navigating in backwards through data

(Optional) How many records to return. Defaults to 50. Max value of 100

(Optional) How the returned rows are ordered either version, or timestamp.

(Optional) What direction the data is retrieved by.

(Optional) A cursor for navigating in forwards through data

(Optional) A cursor for navigating in backwards through data

(Optional) A timestamp that filters out all events before it, timezone is utc +00:00

(Optional) A timestamp that filters out all events after it, timezone is utc +00:00

(Optional) First denotes how many records to return

(Optional) The order id to filter by

(Optional) The string to search for in the order

(Optional) The status to filter by

(Optional) How the returned rows are ordered either version, or timestamp.

(Optional) What direction the data is retrieved by.

(Optional) A cursor for navigating in forwards through data

(Optional) A cursor for navigating in backwards through data

(Optional) How many records to return. Defaults to 50. Max value of 100

(Optional) How the returned rows are ordered either version, or timestamp.

(Optional) What direction the data is retrieved by.

(Optional) Whether to return canceled items