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

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    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.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    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.