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

Show definition
"""
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.
"""
type Order implements Node {
  """
  The code of the currency used for the payment.
  """
  currencyCode: CurrencyCode!
  """
  The locale code in which this specific order happened.
  """
  customerLocale: String
  """
  The unique URL that the customer can use to access the order.
  """
  customerUrl: URL
  """
  Discounts that have been applied on the order.
  """
  discountApplications(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): DiscountApplicationConnection!
  """
  The customer's email address.
  """
  email: String
  """
  Globally unique identifier.
  """
  id: ID!
  """
  List of the order’s line items.
  """
  lineItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): OrderLineItemConnection!
  """
  Unique identifier for the order that appears on the order.
  For example, #1000 or _Store1001.
  """
  name: String!
  """
  A unique numeric identifier for the order for use by shop owner and customer.
  """
  orderNumber: Int!
  """
  The customer's phone number for receiving SMS notifications.
  """
  phone: String
  """
  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.
  """
  processedAt: DateTime!
  """
  The address to where the order will be shipped.
  """
  shippingAddress: MailingAddress
  """
  The discounts that have been allocated onto the shipping line by discount applications.
  """
  shippingDiscountAllocations: [DiscountAllocation!]!
  """
  The unique URL for the order's status page.
  """
  statusUrl: URL!
  """
  Price of the order before shipping and taxes.
  """
  subtotalPrice: Money
  """
  Price of the order before shipping and taxes.
  """
  subtotalPriceV2: MoneyV2
  """
  List of the order’s successful fulfillments.
  """
  successfulFulfillments(
    """
    Truncate the array result to this size.
    """
    first: Int
  ): [Fulfillment!]
  """
  The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).
  """
  totalPrice: Money!
  """
  The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).
  """
  totalPriceV2: MoneyV2!
  """
  The total amount that has been refunded.
  """
  totalRefunded: Money!
  """
  The total amount that has been refunded.
  """
  totalRefundedV2: MoneyV2!
  """
  The total cost of shipping.
  """
  totalShippingPrice: Money!
  """
  The total cost of shipping.
  """
  totalShippingPriceV2: MoneyV2!
  """
  The total cost of taxes.
  """
  totalTax: Money
  """
  The total cost of taxes.
  """
  totalTaxV2: MoneyV2
}

Implements

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 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: true

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 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: true

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

Deprecated fields

Show/Hide
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

Sign up for a Partner account to get started.

Sign up