Order object
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
cancelReason
(OrderCancelReason)
|
Represents the reason for the order's cancellation. Returns null if the order wasn't canceled. |
canceledAt
(DateTime)
|
The date and time when the order was canceled. Returns null if the order wasn't canceled. |
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
currentSubtotalPrice
(MoneyV2!)
|
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. |
currentTotalDuties
(MoneyV2)
|
The total cost of duties. |
currentTotalPrice
(MoneyV2!)
|
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. |
currentTotalTax
(MoneyV2!)
|
The total of all taxes applied to the order, excluding taxes for returned line items. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
edited
(Boolean!)
|
Whether the order has had any edits applied or not. |
email
(String)
|
The customer's email address. |
financialStatus
(OrderFinancialStatus)
|
The financial status of the order. |
fulfillmentStatus
(OrderFulfillmentStatus!)
|
The fulfillment status for the order. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
originalTotalDuties
(MoneyV2)
|
The total of all duties applied to the order. |
originalTotalPrice
(MoneyV2!)
|
The total price of the order before any applied edits. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
Types that return Order
On this page
Fields
Types that return Order
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
cancelReason
(OrderCancelReason)
|
Represents the reason for the order's cancellation. Returns null if the order wasn't canceled. |
canceledAt
(DateTime)
|
The date and time when the order was canceled. Returns null if the order wasn't canceled. |
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
currentSubtotalPrice
(MoneyV2!)
|
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. |
currentTotalPrice
(MoneyV2!)
|
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. |
currentTotalTax
(MoneyV2!)
|
The total of all taxes applied to the order, excluding taxes for returned line items. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
edited
(Boolean!)
|
Whether the order has had any edits applied or not. |
email
(String)
|
The customer's email address. |
financialStatus
(OrderFinancialStatus)
|
The financial status of the order. |
fulfillmentStatus
(OrderFulfillmentStatus!)
|
The fulfillment status for the order. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
originalTotalPrice
(MoneyV2!)
|
The total price of the order before any applied edits. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
cancelReason
(OrderCancelReason)
|
Represents the reason for the order's cancellation. Returns null if the order wasn't canceled. |
canceledAt
(DateTime)
|
The date and time when the order was canceled. Returns null if the order wasn't canceled. |
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
currentSubtotalPrice
(MoneyV2!)
|
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. |
currentTotalPrice
(MoneyV2!)
|
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. |
currentTotalTax
(MoneyV2!)
|
The total of all taxes applied to the order, excluding taxes for returned line items. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
edited
(Boolean!)
|
Whether the order has had any edits applied or not. |
email
(String)
|
The customer's email address. |
financialStatus
(OrderFinancialStatus)
|
The financial status of the order. |
fulfillmentStatus
(OrderFulfillmentStatus!)
|
The fulfillment status for the order. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
originalTotalPrice
(MoneyV2!)
|
The total price of the order before any applied edits. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
cancelReason
(OrderCancelReason)
|
Represents the reason for the order's cancellation. Returns null if the order wasn't canceled. |
canceledAt
(DateTime)
|
The date and time when the order was canceled. Returns null if the order wasn't canceled. |
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
currentSubtotalPrice
(MoneyV2!)
|
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. |
currentTotalPrice
(MoneyV2!)
|
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. |
currentTotalTax
(MoneyV2!)
|
The total of all taxes applied to the order, excluding taxes for returned line items. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
edited
(Boolean!)
|
Whether the order has had any edits applied or not. |
email
(String)
|
The customer's email address. |
financialStatus
(OrderFinancialStatus)
|
The financial status of the order. |
fulfillmentStatus
(OrderFulfillmentStatus!)
|
The fulfillment status for the order. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
originalTotalPrice
(MoneyV2!)
|
The total price of the order before any applied edits. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
cancelReason
(OrderCancelReason)
|
Represents the reason for the order's cancellation. Returns null if the order wasn't canceled. |
canceledAt
(DateTime)
|
The date and time when the order was canceled. Returns null if the order wasn't canceled. |
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
currentSubtotalPrice
(MoneyV2!)
|
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. |
currentTotalPrice
(MoneyV2!)
|
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. |
currentTotalTax
(MoneyV2!)
|
The total of all taxes applied to the order, excluding taxes for returned line items. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
edited
(Boolean!)
|
Whether the order has had any edits applied or not. |
email
(String)
|
The customer's email address. |
financialStatus
(OrderFinancialStatus)
|
The financial status of the order. |
fulfillmentStatus
(OrderFulfillmentStatus!)
|
The fulfillment status for the order. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
originalTotalPrice
(MoneyV2!)
|
The total price of the order before any applied edits. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
email
(String)
|
The customer's email address. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
email
(String)
|
The customer's email address. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
Types that return OrderEdge
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Required access
unauthenticated_read_customers access scope.
On this page
Connections
discountApplications
(DiscountApplicationConnection!)
|
Discounts that have been applied on the order. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
lineItems
(OrderLineItemConnection!)
|
List of the order’s line items. |
after
(
String
)
|
Returns the elements that come after the specified cursor. |
before
(
String
)
|
Returns the elements that come before the specified cursor. |
first
(
Int
)
|
Returns up to the first |
last
(
Int
)
|
Returns up to the last |
reverse
(
Boolean
)
|
Reverse the order of the underlying list.Default value: false |
Fields
currencyCode
(CurrencyCode!)
|
The code of the currency used for the payment. |
customerLocale
(String)
|
The locale code in which this specific order happened. |
customerUrl
(URL)
|
The unique URL that the customer can use to access the order. |
email
(String)
|
The customer's email address. |
id
(ID!)
|
Globally unique identifier. |
name
(String!)
|
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. |
orderNumber
(Int!)
|
A unique numeric identifier for the order for use by shop owner and customer. |
phone
(String)
|
The customer's phone number for receiving SMS notifications. |
processedAt
(DateTime!)
|
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. |
shippingAddress
(MailingAddress)
|
The address to where the order will be shipped. |
shippingDiscountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the shipping line by discount applications. |
statusUrl
(URL!)
|
The unique URL for the order's status page. |
subtotalPriceV2
(MoneyV2)
|
Price of the order before duties, shipping and taxes. |
successfulFulfillments
([Fulfillment!])
|
List of the order’s successful fulfillments. |
first
(
Int
)
|
Truncate the array result to this size. |
totalPriceV2
(MoneyV2!)
|
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). |
totalRefundedV2
(MoneyV2!)
|
The total amount that has been refunded. |
totalShippingPriceV2
(MoneyV2!)
|
The total cost of shipping. |
totalTaxV2
(MoneyV2)
|
The total cost of taxes. |
Types that return Order
Implements
Deprecated fields
subtotalPrice
(Money)
deprecated
|
Price of the order before shipping and taxes. Deprecation warningUse |
totalPrice
(Money!)
deprecated
|
The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). Deprecation warningUse |
totalRefunded
(Money!)
deprecated
|
The total amount that has been refunded. Deprecation warningUse |
totalShippingPrice
(Money!)
deprecated
|
The total cost of shipping. Deprecation warningUse |
totalTax
(Money)
deprecated
|
The total cost of taxes. Deprecation warningUse |
On this page
Fields
edges
([OrderEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |