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.

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 {
  id: ID!

  # The reason why the order was cancelled.
  # If the order was not cancelled, this value is `null`.
  cancelReason: OrderCancelReason

  # The date and time when the order was cancelled.
  # If the order was not cancelled, this value is `null.`
  cancelledAt: DateTime

  # The date and time when the order was created.
  createdAt: DateTime!

  # The code of the currency used for the payment.
  currencyCode: CurrencyCode!

  # The order’s URL for a customer.
  customerUrl: URL

  # Displays financial status of order payment processing.
  displayFinancialStatus: OrderDisplayFinancialStatus

  # Displays fulfillment status of the order.
  displayFulfillmentStatus: OrderDisplayFulfillmentStatus!

  # The customer's email address.
  email: String

  # List of the order’s line items.
  lineItems(first: Int!, after: String, 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

  # 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

  # The date and time when the order was last modified.
  updatedAt: DateTime!
}

Implements

Connections

lineItems   (OrderLineItemConnection!)

List of the order’s line items.

Argument Type Default Description
after String
first required Int
reverse Boolean false

Fields

cancelReason   (OrderCancelReason)

The reason why the order was cancelled. If the order was not cancelled, this value is null.

cancelledAt   (DateTime)

The date and time when the order was cancelled. If the order was not cancelled, this value is null.

createdAt   (DateTime!)

The date and time when the order was created.

currencyCode   (CurrencyCode!)

The code of the currency used for the payment.

customerUrl   (URL)

The order’s URL for a customer.

displayFinancialStatus   (OrderDisplayFinancialStatus)

Displays financial status of order payment processing.

displayFulfillmentStatus   (OrderDisplayFulfillmentStatus!)

Displays fulfillment status of the order.

email   (String)

The customer's email address.

id   (ID!)

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.

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.

updatedAt   (DateTime!)

The date and time when the order was last modified.