Order

Required access

unauthenticated_read_customers access scope

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.

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 {
  # Globally unique identifier.
  id: ID!

  # 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

  # The customer's email address.
  email: String

  # List of the order’s line items.
  lineItems(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): OrderLineItemConnection!

  # A unique numeric identifier for the order for use by shop owner and customer.
  orderNumber: Int!

  # The customer's phone number.
  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 unique URL for the order's status page.
  statusUrl: URL!

  # Price of the order before shipping and taxes.
  subtotalPrice: Money

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

  # The total amount that has been refunded.
  totalRefunded: Money!

  # The total cost of shipping.
  totalShippingPrice: Money!

  # The total cost of taxes.
  totalTax: Money
}

Implements

Connections

lineItems   (OrderLineItemConnection!)

List of the order’s line items.

Argument Type Default 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 false

Reverse the order of the underlying list.

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.

orderNumber   (Int!)

A unique numeric identifier for the order for use by shop owner and customer.

phone   (String)

The customer's phone number.

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.

statusUrl   (URL!)

The unique URL for the order's status page.

subtotalPrice   (Money)

Price of the order before shipping and taxes.

totalPrice   (Money!)

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

totalRefunded   (Money!)

The total amount that has been refunded.

totalShippingPrice   (Money!)

The total cost of shipping.

totalTax   (Money)

The total cost of taxes.