API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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 for the order, including refunds.

  • 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 cost of duties charged at checkout.

  • 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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

Fields

Types that return Order

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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 for the order, including refunds.

  • 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 cost of duties charged at checkout.

  • 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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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 for the order, including refunds.

  • 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 cost of duties charged at checkout.

  • 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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

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.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the order.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the order’s line items.

    Argument Description
    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 n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • cancelReason (OrderCancelReason)

    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.

    Argument Description
    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 warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

    Deprecation warning

    Use totalPriceV2 instead

  • totalRefunded (Money!) deprecated

    The total amount that has been refunded.

    Deprecation warning

    Use totalRefundedV2 instead

  • totalShippingPrice (Money!) deprecated

    The total cost of shipping.

    Deprecation warning

    Use totalShippingPriceV2 instead

  • totalTax (Money) deprecated

    The total cost of taxes.

    Deprecation warning

    Use totalTaxV2 instead

An auto-generated type for paginating through multiple Orders.

On this page

Fields

An auto-generated type which holds one Order and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Order!)

    The item at the end of OrderEdge.

Types that return OrderEdge