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 Unsupported
API version: 2020-01 Unsupported

Order object

Version unstable

An order represents an agreement to do business between a customer and a merchant.

Required access

read_orders 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

  • events (EventConnection!)

    List of internal events associated with 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.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

  • fulfillmentOrders (FulfillmentOrderConnection!)

    List of fulfillment orders with pagination.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    displayable ( Boolean )

    Whether fulfillment orders requested should be displayed to the merchant.
    Default value: false

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • assigned_location_id
    • status

    See the detailed search syntax.

    reverse ( Boolean )

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

  • lineItems (LineItemConnection!)

    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

  • localizationExtensions (LocalizationExtensionConnection!)

    List of localization extensions for 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.

    countryCodes ( [CountryCode!] )

    The country codes of the extensions.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    purposes ( [LocalizationExtensionPurpose!] )

    The purpose of the extensions.

    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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • nonFulfillableLineItems (LineItemConnection!)

    Line items that can't be fulfilled. For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. These line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments.

    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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • shippingLines (ShippingLineConnection!)

    List of line items that contains the shipping costs.

    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

  • Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.

  • billingAddress (MailingAddress)

    Mailing address provided by the customer. Not all orders have mailing addresses.

  • billingAddressMatchesShippingAddress (Boolean!)

    Whether the billing address matches the shipping address.

  • canMarkAsPaid (Boolean!)

    Whether the order can be manually marked as paid.

  • canNotifyCustomer (Boolean!)

    Whether notifications can be sent to the customer or not.

  • cancelReason (OrderCancelReason)

    Reason the order was canceled. Returns null if the order wasn't canceled.

  • cancelledAt (DateTime)

    Date and time when the order was canceled. Returns null if the order wasn't canceled.

  • capturable (Boolean!)

    Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired.

  • cartDiscountAmountSet (MoneyBag)

    Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

  • clientIp (String)

    The ip address of the client that is associated with this order.

  • closed (Boolean!)

    Whether the order is closed.

  • closedAt (DateTime)

    Date and time when the order closed. If the order is not closed, then this field is null.

  • confirmed (Boolean!)

    Whether inventory has been reserved for the order.

  • createdAt (DateTime!)

    Date and time when the order was created in Shopify.

  • currencyCode (CurrencyCode!)

    The currency of the store at the time of the order. If payment hasn't occurred, then this field is null.

  • currentCartDiscountAmountSet (MoneyBag!)

    The amount of the order-level discount minus the amounts for line items that have been returned. This doesn't include line item discounts.

  • currentSubtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • currentSubtotalPriceSet (MoneyBag!)

    The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.

  • currentTaxLines ([TaxLine!]!)

    The taxes charged for the order minus the taxes for line items that have been returned.

  • currentTotalDiscountsSet (MoneyBag!)

    The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.

  • currentTotalDutiesSet (MoneyBag)

    The total amount of duties for the order. If duties aren't applicable, then this value is null.

  • currentTotalPriceSet (MoneyBag!)

    The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.

  • currentTotalTaxSet (MoneyBag!)

    The total of all taxes applied to the order minus the taxes for line items that have been returned.

  • currentTotalWeight (UnsignedInt64!)

    The total weight (grams) of the order minus the weights for line items that have been returned.

  • customAttributes ([Attribute!]!)

    Custom information added to the order by your customer (Also referred to as note attributes).

  • customer (Customer)

    Unique identifier of the customer who placed the order. Not all orders have customers associated with them.

  • customerAcceptsMarketing (Boolean!)

    Whether the customer agreed to receive marketing materials.

  • customerJourneySummary (CustomerJourneySummary)

    Description of the customer's experience with the store leading up to the order. Loaded asynchronously, consumers should poll until the 'ready' field resolves to true.

  • customerLocale (String)

    A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be 'en', 'en-CA', 'en-PIRATE'.

  • discountCode (String)

    Discount code provided by the customer.

  • displayAddress (MailingAddress)

    Primary address of the customer, which is shown on the order.

  • displayFinancialStatus (OrderDisplayFinancialStatus)

    Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.

  • displayFulfillmentStatus (OrderDisplayFulfillmentStatus!)

    Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.

  • Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.

  • edited (Boolean!)

    Whether the order has had any edits applied or not.

  • email (String)

    Email address provided by the customer.

  • fulfillable (Boolean!)

    Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.

  • fulfillments ([Fulfillment!]!)

    List of shipments for the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • fullyPaid (Boolean!)

    Whether the order has been paid in full.

  • hasTimelineComment (Boolean!)

    Whether the merchant added timeline comments to the order.

  • id (ID!)

    Globally unique identifier.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • merchantEditable (Boolean!)

    Whether the order can be edited or not.

  • merchantEditableErrors ([String!]!)

    A list of reasons of why the order cannot be edited.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

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

  • name (String!)

    Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.

  • netPaymentSet (MoneyBag!)

    Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies.

  • note (String)

    Contents of the note associated with the order.

  • originalTotalDutiesSet (MoneyBag)

    The total amount of duties prior to any applied edits for the order. If duties aren't applicable, then this value is null.

  • originalTotalPriceSet (MoneyBag!)

    Total price of the order prior to any applied edits in shop and presentment currencies.

  • paymentCollectionDetails (OrderPaymentCollectionDetails!)

    The payment collection details for an order requiring additional payment.

  • paymentGatewayNames ([String!]!)

    List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).

  • phone (String)

    Phone number provided by the customer.

  • physicalLocation (Location)

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

  • presentmentCurrencyCode (CurrencyCode!)

    The payment currency of the customer for this order.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • processedAt (DateTime!)

    Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created.

  • publication (Publication)

    Publication that created the order.

  • refundDiscrepancySet (MoneyBag!)

    The difference between suggested and actual refund amounts. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.

  • refundable (Boolean!)

    Whether the order can be refunded.

  • refunds ([Refund!]!)

    List of refunds that have been applied to the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • requiresShipping (Boolean!)

    Whether any line item in the order requires physical shipping.

  • restockable (Boolean!)

    Whether the order can be restocked.

  • riskLevel (OrderRiskLevel!)

    Fraud risk level of the order.

  • risks ([OrderRisk!]!)

    The order risks associated with this order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • shippingAddress (MailingAddress)

    Mailing address for shipping provided by the customer.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • statusPageUrl (URL!)

    URL of webpage where the customer can check to see the order's current status.

  • subtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • subtotalPriceSet (MoneyBag)

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop and presentment currencies.

  • suggestedRefund (SuggestedRefund)

    The details of the suggested refund. This response can be used to submit a RefundCreate mutation.

    Argument Description
    refundDuties ( [RefundDutyInput!] )

    The duties from the order to include in the refund.

    refundLineItems ( [RefundLineItemInput!] )

    The line items from the order to include in the refund.

    refundShipping ( Boolean )

    Whether to refund the full shipping amount.

    shippingAmount ( Money )

    The amount to refund for shipping. Overrides refundShipping.

    suggestFullRefund ( Boolean )

    Whether a refund for all of the refundable line items on an order should be suggested. If true, the suggested refund will be formed from all refundable line items and will ignore any passed in refundLineItems.
    Default value: false

  • tags ([String!]!)

    A comma separated list of tags associated with the order. Updating tags overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.

  • taxLines ([TaxLine!]!)

    Taxes charged for the line item.

  • taxesIncluded (Boolean!)

    Whether taxes are included in the subtotal price of the order.

  • test (Boolean!)

    Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.

  • totalCapturableSet (MoneyBag!)

    Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies.

  • totalDiscountsSet (MoneyBag)

    Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies.

  • totalOutstandingSet (MoneyBag!)

    Total amount of money not yet authorized for the order.

  • totalPriceSet (MoneyBag!)

    Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

  • totalReceivedSet (MoneyBag!)

    Total amount received by the customer for the order in shop and presentment currencies.

  • totalRefundedSet (MoneyBag!)

    Total amount refunded for the order in shop and presentment currencies.

  • totalRefundedShippingSet (MoneyBag!)

    Total amount refunded for shipping in shop and presentment currencies.

  • totalShippingPriceSet (MoneyBag!)

    Total amount charged for shipping the order in shop and presentment currencies.

  • totalTaxSet (MoneyBag)

    Total of all taxes applied to the order in shop and presentment currencies.

  • totalTipReceivedSet (MoneyBag!)

    Total tip received for the order in shop and presentment currencies.

  • totalWeight (UnsignedInt64)

    Total weight (grams) of the order.

  • transactions ([OrderTransaction!]!)

    List of all transactions associated with the order.

    Argument Description
    capturable ( Boolean )

    Filter transactions by whether they are capturable. If true, then returns only transactions that represent an authorized payment that can be captured. If false, then returns all transactions.

    first ( Int )

    Truncate the array result to this size.

    manuallyResolvable ( Boolean )

    Filter transactions by whether they are manual payments. If true, then returns only transactions that are manual payments. If false, then returns all transactions.

  • unpaid (Boolean!)

    Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.

  • updatedAt (DateTime!)

    Date and time when the order was last modified.

Types that return Order

Mutations for Order

Implements

Deprecated fields

  • cartDiscountAmount (Money) deprecated

    Amount of the order-level discount (does not contain any line item discounts).

    Deprecation warning

    Use cartDiscountAmountSet instead

  • channel (Channel) deprecated

    Channel that created the order.

    Deprecation warning

    Use publication instead

  • customerJourney (CustomerJourney) deprecated

    Description of the customer's experience with the store leading up to the order.

    Deprecation warning

    Use customerJourneySummary instead

  • draftFulfillments ([DraftFulfillment!]!) deprecated

    List of possible fulfilments that can be made for the order (includes line items that can be partially fulfilled).

    Deprecation warning

    Use fulfillmentOrders instead

  • landingPageDisplayText (String) deprecated

    First page of the online store that the customer visited before they submitted the order, for displaying to humans.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPageHtml instead

  • landingPageUrl (URL) deprecated

    First page of the online store that the customer visited before they submitted the order.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPage instead

  • lineItemsMutable (LineItemMutableConnection!) deprecated

    List of the order's line items after any edits. Only available on Developer Preview.

    Deprecation warning

    Use lineItems instead

    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

  • location (String) deprecated

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

    Deprecation warning

    Use physicalLocation instead

  • netPayment (Money!) deprecated

    Net payment for the order, based on the total amount received - total amount refunded.

    Deprecation warning

    Use netPaymentSet instead

  • referralCode (String) deprecated

    Marketing referral code from the link that the customer clicked to visit your store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralCode instead

  • referrerDisplayText (String) deprecated

    Website that sent the customer to your online store.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralInfoHtml instead

  • referrerUrl (URL) deprecated

    Webpage where the customer clicked a link that sent them to your online store. For example, Google or randomblog.com/page1.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referrerUrl instead

  • subtotalPrice (Money) deprecated

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts).

    Deprecation warning

    Use subtotalPriceSet instead

  • totalCapturable (Money!) deprecated

    Amount authorized for the order, that is uncaptured or undercaptured.

    Deprecation warning

    Use totalCapturableSet instead

  • totalDiscounts (Money) deprecated

    Total amount discounted from the order (includes order-level and line item discounts).

    Deprecation warning

    Use totalDiscountsSet instead

  • totalPrice (Money!) deprecated

    Total amount of the order (includes taxes and discounts).

    Deprecation warning

    Use totalPriceSet instead

  • totalReceived (Money!) deprecated

    Total amount received by the customer for the order.

    Deprecation warning

    Use totalReceivedSet instead

  • totalRefunded (Money!) deprecated

    Total amount refunded for the order.

    Deprecation warning

    Use totalRefundedSet instead

  • totalShippingPrice (Money!) deprecated

    Total amount charged for shipping the order.

    Deprecation warning

    Use totalShippingPriceSet instead

  • totalTax (Money) deprecated

    Total of all taxes applied to the order.

    Deprecation warning

    Use totalTaxSet instead

  • totalTipReceived (MoneyV2!) deprecated

    Total tip amount received for the order.

    Deprecation warning

    Use totalTipReceivedSet instead

Version unstable

An auto-generated type for paginating through multiple Orders.

Fields

Types that return Order

Mutations for Order

Version unstable

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

Mutations for Order

Version 2021-07 (Release candidate)

An order represents an agreement to do business between a customer and a merchant.

Required access

read_orders 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

  • events (EventConnection!)

    List of internal events associated with 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.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

  • fulfillmentOrders (FulfillmentOrderConnection!)

    List of fulfillment orders with pagination.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    displayable ( Boolean )

    Whether fulfillment orders requested should be displayed to the merchant.
    Default value: false

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • assigned_location_id
    • status

    See the detailed search syntax.

    reverse ( Boolean )

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

  • lineItems (LineItemConnection!)

    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

  • localizationExtensions (LocalizationExtensionConnection!)

    List of localization extensions for 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.

    countryCodes ( [CountryCode!] )

    The country codes of the extensions.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    purposes ( [LocalizationExtensionPurpose!] )

    The purpose of the extensions.

    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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • nonFulfillableLineItems (LineItemConnection!)

    Line items that can't be fulfilled. For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. These line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments.

    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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • shippingLines (ShippingLineConnection!)

    List of line items that contains the shipping costs.

    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

  • Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.

  • billingAddress (MailingAddress)

    Mailing address provided by the customer. Not all orders have mailing addresses.

  • billingAddressMatchesShippingAddress (Boolean!)

    Whether the billing address matches the shipping address.

  • canMarkAsPaid (Boolean!)

    Whether the order can be manually marked as paid.

  • canNotifyCustomer (Boolean!)

    Whether notifications can be sent to the customer or not.

  • cancelReason (OrderCancelReason)

    Reason the order was canceled. Returns null if the order wasn't canceled.

  • cancelledAt (DateTime)

    Date and time when the order was canceled. Returns null if the order wasn't canceled.

  • capturable (Boolean!)

    Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired.

  • cartDiscountAmountSet (MoneyBag)

    Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

  • clientIp (String)

    The ip address of the client that is associated with this order.

  • closed (Boolean!)

    Whether the order is closed.

  • closedAt (DateTime)

    Date and time when the order closed. If the order is not closed, then this field is null.

  • confirmed (Boolean!)

    Whether inventory has been reserved for the order.

  • createdAt (DateTime!)

    Date and time when the order was created in Shopify.

  • currencyCode (CurrencyCode!)

    The currency of the store at the time of the order. If payment hasn't occurred, then this field is null.

  • currentCartDiscountAmountSet (MoneyBag!)

    The amount of the order-level discount minus the amounts for line items that have been returned. This doesn't include line item discounts.

  • currentSubtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • currentSubtotalPriceSet (MoneyBag!)

    The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.

  • currentTaxLines ([TaxLine!]!)

    The taxes charged for the order minus the taxes for line items that have been returned.

  • currentTotalDiscountsSet (MoneyBag!)

    The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.

  • currentTotalDutiesSet (MoneyBag)

    The total amount of duties for the order. If duties aren't applicable, then this value is null.

  • currentTotalPriceSet (MoneyBag!)

    The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.

  • currentTotalTaxSet (MoneyBag!)

    The total of all taxes applied to the order minus the taxes for line items that have been returned.

  • currentTotalWeight (UnsignedInt64!)

    The total weight (grams) of the order minus the weights for line items that have been returned.

  • customAttributes ([Attribute!]!)

    Custom information added to the order by your customer (Also referred to as note attributes).

  • customer (Customer)

    Unique identifier of the customer who placed the order. Not all orders have customers associated with them.

  • customerAcceptsMarketing (Boolean!)

    Whether the customer agreed to receive marketing materials.

  • customerJourneySummary (CustomerJourneySummary)

    Description of the customer's experience with the store leading up to the order. Loaded asynchronously, consumers should poll until the 'ready' field resolves to true.

  • customerLocale (String)

    A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be 'en', 'en-CA', 'en-PIRATE'.

  • discountCode (String)

    Discount code provided by the customer.

  • displayAddress (MailingAddress)

    Primary address of the customer, which is shown on the order.

  • displayFinancialStatus (OrderDisplayFinancialStatus)

    Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.

  • displayFulfillmentStatus (OrderDisplayFulfillmentStatus!)

    Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.

  • Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.

  • edited (Boolean!)

    Whether the order has had any edits applied or not.

  • email (String)

    Email address provided by the customer.

  • fulfillable (Boolean!)

    Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.

  • fulfillments ([Fulfillment!]!)

    List of shipments for the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • fullyPaid (Boolean!)

    Whether the order has been paid in full.

  • hasTimelineComment (Boolean!)

    Whether the merchant added timeline comments to the order.

  • id (ID!)

    Globally unique identifier.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • merchantEditable (Boolean!)

    Whether the order can be edited or not.

  • merchantEditableErrors ([String!]!)

    A list of reasons of why the order cannot be edited.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

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

  • name (String!)

    Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.

  • netPaymentSet (MoneyBag!)

    Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies.

  • note (String)

    Contents of the note associated with the order.

  • originalTotalDutiesSet (MoneyBag)

    The total amount of duties prior to any applied edits for the order. If duties aren't applicable, then this value is null.

  • originalTotalPriceSet (MoneyBag!)

    Total price of the order prior to any applied edits in shop and presentment currencies.

  • paymentCollectionDetails (OrderPaymentCollectionDetails!)

    The payment collection details for an order requiring additional payment.

  • paymentGatewayNames ([String!]!)

    List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).

  • phone (String)

    Phone number provided by the customer.

  • physicalLocation (Location)

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

  • presentmentCurrencyCode (CurrencyCode!)

    The payment currency of the customer for this order.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • processedAt (DateTime!)

    Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created.

  • publication (Publication)

    Publication that created the order.

  • refundDiscrepancySet (MoneyBag!)

    The difference between suggested and actual refund amounts. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.

  • refundable (Boolean!)

    Whether the order can be refunded.

  • refunds ([Refund!]!)

    List of refunds that have been applied to the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • requiresShipping (Boolean!)

    Whether any line item in the order requires physical shipping.

  • restockable (Boolean!)

    Whether the order can be restocked.

  • riskLevel (OrderRiskLevel!)

    Fraud risk level of the order.

  • risks ([OrderRisk!]!)

    The order risks associated with this order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • shippingAddress (MailingAddress)

    Mailing address for shipping provided by the customer.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • subtotalPriceSet (MoneyBag)

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop and presentment currencies.

  • suggestedRefund (SuggestedRefund)

    The details of the suggested refund. This response can be used to submit a RefundCreate mutation.

    Argument Description
    refundDuties ( [RefundDutyInput!] )

    The duties from the order to include in the refund.

    refundLineItems ( [RefundLineItemInput!] )

    The line items from the order to include in the refund.

    refundShipping ( Boolean )

    Whether to refund the full shipping amount.

    shippingAmount ( Money )

    The amount to refund for shipping. Overrides refundShipping.

    suggestFullRefund ( Boolean )

    Whether a refund for all of the refundable line items on an order should be suggested. If true, the suggested refund will be formed from all refundable line items and will ignore any passed in refundLineItems.
    Default value: false

  • tags ([String!]!)

    A comma separated list of tags associated with the order. Updating tags overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.

  • taxLines ([TaxLine!]!)

    Taxes charged for the line item.

  • taxesIncluded (Boolean!)

    Whether taxes are included in the subtotal price of the order.

  • test (Boolean!)

    Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.

  • totalCapturableSet (MoneyBag!)

    Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies.

  • totalDiscountsSet (MoneyBag)

    Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies.

  • totalOutstandingSet (MoneyBag!)

    Total amount of money not yet authorized for the order.

  • totalPriceSet (MoneyBag!)

    Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

  • totalReceivedSet (MoneyBag!)

    Total amount received by the customer for the order in shop and presentment currencies.

  • totalRefundedSet (MoneyBag!)

    Total amount refunded for the order in shop and presentment currencies.

  • totalRefundedShippingSet (MoneyBag!)

    Total amount refunded for shipping in shop and presentment currencies.

  • totalShippingPriceSet (MoneyBag!)

    Total amount charged for shipping the order in shop and presentment currencies.

  • totalTaxSet (MoneyBag)

    Total of all taxes applied to the order in shop and presentment currencies.

  • totalTipReceivedSet (MoneyBag!)

    Total tip received for the order in shop and presentment currencies.

  • totalWeight (UnsignedInt64)

    Total weight (grams) of the order.

  • transactions ([OrderTransaction!]!)

    List of all transactions associated with the order.

    Argument Description
    capturable ( Boolean )

    Filter transactions by whether they are capturable. If true, then returns only transactions that represent an authorized payment that can be captured. If false, then returns all transactions.

    first ( Int )

    Truncate the array result to this size.

    manuallyResolvable ( Boolean )

    Filter transactions by whether they are manual payments. If true, then returns only transactions that are manual payments. If false, then returns all transactions.

  • unpaid (Boolean!)

    Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.

  • updatedAt (DateTime!)

    Date and time when the order was last modified.

Types that return Order

Mutations for Order

Implements

Deprecated fields

  • cartDiscountAmount (Money) deprecated

    Amount of the order-level discount (does not contain any line item discounts).

    Deprecation warning

    Use cartDiscountAmountSet instead

  • channel (Channel) deprecated

    Channel that created the order.

    Deprecation warning

    Use publication instead

  • customerJourney (CustomerJourney) deprecated

    Description of the customer's experience with the store leading up to the order.

    Deprecation warning

    Use customerJourneySummary instead

  • draftFulfillments ([DraftFulfillment!]!) deprecated

    List of possible fulfilments that can be made for the order (includes line items that can be partially fulfilled).

    Deprecation warning

    Use fulfillmentOrders instead

  • landingPageDisplayText (String) deprecated

    First page of the online store that the customer visited before they submitted the order, for displaying to humans.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPageHtml instead

  • landingPageUrl (URL) deprecated

    First page of the online store that the customer visited before they submitted the order.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPage instead

  • lineItemsMutable (LineItemMutableConnection!) deprecated

    List of the order's line items after any edits. Only available on Developer Preview.

    Deprecation warning

    Use lineItems instead

    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

  • location (String) deprecated

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

    Deprecation warning

    Use physicalLocation instead

  • netPayment (Money!) deprecated

    Net payment for the order, based on the total amount received - total amount refunded.

    Deprecation warning

    Use netPaymentSet instead

  • referralCode (String) deprecated

    Marketing referral code from the link that the customer clicked to visit your store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralCode instead

  • referrerDisplayText (String) deprecated

    Website that sent the customer to your online store.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralInfoHtml instead

  • referrerUrl (URL) deprecated

    Webpage where the customer clicked a link that sent them to your online store. For example, Google or randomblog.com/page1.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referrerUrl instead

  • subtotalPrice (Money) deprecated

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts).

    Deprecation warning

    Use subtotalPriceSet instead

  • totalCapturable (Money!) deprecated

    Amount authorized for the order, that is uncaptured or undercaptured.

    Deprecation warning

    Use totalCapturableSet instead

  • totalDiscounts (Money) deprecated

    Total amount discounted from the order (includes order-level and line item discounts).

    Deprecation warning

    Use totalDiscountsSet instead

  • totalPrice (Money!) deprecated

    Total amount of the order (includes taxes and discounts).

    Deprecation warning

    Use totalPriceSet instead

  • totalReceived (Money!) deprecated

    Total amount received by the customer for the order.

    Deprecation warning

    Use totalReceivedSet instead

  • totalRefunded (Money!) deprecated

    Total amount refunded for the order.

    Deprecation warning

    Use totalRefundedSet instead

  • totalShippingPrice (Money!) deprecated

    Total amount charged for shipping the order.

    Deprecation warning

    Use totalShippingPriceSet instead

  • totalTax (Money) deprecated

    Total of all taxes applied to the order.

    Deprecation warning

    Use totalTaxSet instead

  • totalTipReceived (MoneyV2!) deprecated

    Total tip amount received for the order.

    Deprecation warning

    Use totalTipReceivedSet instead

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple Orders.

On this page

Fields

Version 2021-07 (Release candidate)

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

Version 2021-04 (Latest)

An order represents an agreement to do business between a customer and a merchant.

Required access

read_orders 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

  • events (EventConnection!)

    List of internal events associated with 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.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

  • fulfillmentOrders (FulfillmentOrderConnection!)

    List of fulfillment orders with pagination.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    displayable ( Boolean )

    Whether fulfillment orders requested should be displayed to the merchant.
    Default value: false

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • assigned_location_id
    • status

    See the detailed search syntax.

    reverse ( Boolean )

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

  • lineItems (LineItemConnection!)

    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

  • localizationExtensions (LocalizationExtensionConnection!)

    List of localization extensions for 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.

    countryCodes ( [CountryCode!] )

    The country codes of the extensions.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    purposes ( [LocalizationExtensionPurpose!] )

    The purpose of the extensions.

    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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • nonFulfillableLineItems (LineItemConnection!)

    Line items that can't be fulfilled. For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. These line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments.

    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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • shippingLines (ShippingLineConnection!)

    List of line items that contains the shipping costs.

    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

  • Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.

  • billingAddress (MailingAddress)

    Mailing address provided by the customer. Not all orders have mailing addresses.

  • billingAddressMatchesShippingAddress (Boolean!)

    Whether the billing address matches the shipping address.

  • canMarkAsPaid (Boolean!)

    Whether the order can be manually marked as paid.

  • canNotifyCustomer (Boolean!)

    Whether notifications can be sent to the customer or not.

  • cancelReason (OrderCancelReason)

    Reason the order was canceled. Returns null if the order wasn't canceled.

  • cancelledAt (DateTime)

    Date and time when the order was canceled. Returns null if the order wasn't canceled.

  • capturable (Boolean!)

    Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired.

  • cartDiscountAmountSet (MoneyBag)

    Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

  • clientIp (String)

    The ip address of the client that is associated with this order.

  • closed (Boolean!)

    Whether the order is closed.

  • closedAt (DateTime)

    Date and time when the order closed. If the order is not closed, then this field is null.

  • confirmed (Boolean!)

    Whether inventory has been reserved for the order.

  • createdAt (DateTime!)

    Date and time when the order was created in Shopify.

  • currencyCode (CurrencyCode!)

    The currency of the store at the time of the order. If payment hasn't occurred, then this field is null.

  • currentCartDiscountAmountSet (MoneyBag!)

    The amount of the order-level discount minus the amounts for line items that have been returned. This doesn't include line item discounts.

  • currentSubtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • currentSubtotalPriceSet (MoneyBag!)

    The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.

  • currentTaxLines ([TaxLine!]!)

    The taxes charged for the order minus the taxes for line items that have been returned.

  • currentTotalDiscountsSet (MoneyBag!)

    The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.

  • currentTotalDutiesSet (MoneyBag)

    The total amount of duties for the order. If duties aren't applicable, then this value is null.

  • currentTotalPriceSet (MoneyBag!)

    The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.

  • currentTotalTaxSet (MoneyBag!)

    The total of all taxes applied to the order minus the taxes for line items that have been returned.

  • currentTotalWeight (UnsignedInt64!)

    The total weight (grams) of the order minus the weights for line items that have been returned.

  • customAttributes ([Attribute!]!)

    Custom information added to the order by your customer (Also referred to as note attributes).

  • customer (Customer)

    Unique identifier of the customer who placed the order. Not all orders have customers associated with them.

  • customerAcceptsMarketing (Boolean!)

    Whether the customer agreed to receive marketing materials.

  • customerJourneySummary (CustomerJourneySummary)

    Description of the customer's experience with the store leading up to the order. Loaded asynchronously, consumers should poll until the 'ready' field resolves to true.

  • customerLocale (String)

    A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be 'en', 'en-CA', 'en-PIRATE'.

  • discountCode (String)

    Discount code provided by the customer.

  • displayAddress (MailingAddress)

    Primary address of the customer, which is shown on the order.

  • displayFinancialStatus (OrderDisplayFinancialStatus)

    Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.

  • displayFulfillmentStatus (OrderDisplayFulfillmentStatus!)

    Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.

  • Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.

  • edited (Boolean!)

    Whether the order has had any edits applied or not.

  • email (String)

    Email address provided by the customer.

  • fulfillable (Boolean!)

    Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.

  • fulfillments ([Fulfillment!]!)

    List of shipments for the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • fullyPaid (Boolean!)

    Whether the order has been paid in full.

  • hasTimelineComment (Boolean!)

    Whether the merchant added timeline comments to the order.

  • id (ID!)

    Globally unique identifier.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • merchantEditable (Boolean!)

    Whether the order can be edited or not.

  • merchantEditableErrors ([String!]!)

    A list of reasons of why the order cannot be edited.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

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

  • name (String!)

    Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.

  • netPaymentSet (MoneyBag!)

    Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies.

  • note (String)

    Contents of the note associated with the order.

  • originalTotalDutiesSet (MoneyBag)

    The total amount of duties prior to any applied edits for the order. If duties aren't applicable, then this value is null.

  • originalTotalPriceSet (MoneyBag!)

    Total price of the order prior to any applied edits in shop and presentment currencies.

  • paymentCollectionDetails (OrderPaymentCollectionDetails!)

    The payment collection details for an order requiring additional payment.

  • paymentGatewayNames ([String!]!)

    List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).

  • phone (String)

    Phone number provided by the customer.

  • physicalLocation (Location)

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

  • presentmentCurrencyCode (CurrencyCode!)

    The payment currency of the customer for this order.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • processedAt (DateTime!)

    Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created.

  • publication (Publication)

    Publication that created the order.

  • refundDiscrepancySet (MoneyBag!)

    The difference between suggested and actual refund amounts. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.

  • refundable (Boolean!)

    Whether the order can be refunded.

  • refunds ([Refund!]!)

    List of refunds that have been applied to the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • requiresShipping (Boolean!)

    Whether any line item in the order requires physical shipping.

  • restockable (Boolean!)

    Whether the order can be restocked.

  • riskLevel (OrderRiskLevel!)

    Fraud risk level of the order.

  • risks ([OrderRisk!]!)

    The order risks associated with this order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • shippingAddress (MailingAddress)

    Mailing address for shipping provided by the customer.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • subtotalPriceSet (MoneyBag)

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop and presentment currencies.

  • suggestedRefund (SuggestedRefund)

    The details of the suggested refund. This response can be used to submit a RefundCreate mutation.

    Argument Description
    refundDuties ( [RefundDutyInput!] )

    The duties from the order to include in the refund.

    refundLineItems ( [RefundLineItemInput!] )

    The line items from the order to include in the refund.

    refundShipping ( Boolean )

    Whether to refund the full shipping amount.

    shippingAmount ( Money )

    The amount to refund for shipping. Overrides refundShipping.

    suggestFullRefund ( Boolean )

    Whether a refund for all of the refundable line items on an order should be suggested. If true, the suggested refund will be formed from all refundable line items and will ignore any passed in refundLineItems.
    Default value: false

  • tags ([String!]!)

    A comma separated list of tags associated with the order. Updating tags overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.

  • taxLines ([TaxLine!]!)

    Taxes charged for the line item.

  • taxesIncluded (Boolean!)

    Whether taxes are included in the subtotal price of the order.

  • test (Boolean!)

    Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.

  • totalCapturableSet (MoneyBag!)

    Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies.

  • totalDiscountsSet (MoneyBag)

    Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies.

  • totalOutstandingSet (MoneyBag!)

    Total amount of money not yet authorized for the order.

  • totalPriceSet (MoneyBag!)

    Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

  • totalReceivedSet (MoneyBag!)

    Total amount received by the customer for the order in shop and presentment currencies.

  • totalRefundedSet (MoneyBag!)

    Total amount refunded for the order in shop and presentment currencies.

  • totalRefundedShippingSet (MoneyBag!)

    Total amount refunded for shipping in shop and presentment currencies.

  • totalShippingPriceSet (MoneyBag!)

    Total amount charged for shipping the order in shop and presentment currencies.

  • totalTaxSet (MoneyBag)

    Total of all taxes applied to the order in shop and presentment currencies.

  • totalTipReceivedSet (MoneyBag!)

    Total tip received for the order in shop and presentment currencies.

  • totalWeight (UnsignedInt64)

    Total weight (grams) of the order.

  • transactions ([OrderTransaction!]!)

    List of all transactions associated with the order.

    Argument Description
    capturable ( Boolean )

    Filter transactions by whether they are capturable. If true, then returns only transactions that represent an authorized payment that can be captured. If false, then returns all transactions.

    first ( Int )

    Truncate the array result to this size.

    manuallyResolvable ( Boolean )

    Filter transactions by whether they are manual payments. If true, then returns only transactions that are manual payments. If false, then returns all transactions.

  • unpaid (Boolean!)

    Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.

  • updatedAt (DateTime!)

    Date and time when the order was last modified.

Types that return Order

Mutations for Order

Implements

Deprecated fields

  • cartDiscountAmount (Money) deprecated

    Amount of the order-level discount (does not contain any line item discounts).

    Deprecation warning

    Use cartDiscountAmountSet instead

  • channel (Channel) deprecated

    Channel that created the order.

    Deprecation warning

    Use publication instead

  • customerJourney (CustomerJourney) deprecated

    Description of the customer's experience with the store leading up to the order.

    Deprecation warning

    Use customerJourneySummary instead

  • draftFulfillments ([DraftFulfillment!]!) deprecated

    List of possible fulfilments that can be made for the order (includes line items that can be partially fulfilled).

    Deprecation warning

    Use fulfillmentOrders instead

  • landingPageDisplayText (String) deprecated

    First page of the online store that the customer visited before they submitted the order, for displaying to humans.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPageHtml instead

  • landingPageUrl (URL) deprecated

    First page of the online store that the customer visited before they submitted the order.

    Deprecation warning

    Use customerJourneySummary.lastVisit.landingPage instead

  • lineItemsMutable (LineItemMutableConnection!) deprecated

    List of the order's line items after any edits. Only available on Developer Preview.

    Deprecation warning

    Use lineItems instead

    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

  • location (String) deprecated

    If the order was processed using Shopify POS, then this is its location as provided by the merchant.

    Deprecation warning

    Use physicalLocation instead

  • netPayment (Money!) deprecated

    Net payment for the order, based on the total amount received - total amount refunded.

    Deprecation warning

    Use netPaymentSet instead

  • referralCode (String) deprecated

    Marketing referral code from the link that the customer clicked to visit your store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralCode instead

  • referrerDisplayText (String) deprecated

    Website that sent the customer to your online store.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referralInfoHtml instead

  • referrerUrl (URL) deprecated

    Webpage where the customer clicked a link that sent them to your online store. For example, Google or randomblog.com/page1.

    Deprecation warning

    Use customerJourneySummary.lastVisit.referrerUrl instead

  • subtotalPrice (Money) deprecated

    Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts).

    Deprecation warning

    Use subtotalPriceSet instead

  • totalCapturable (Money!) deprecated

    Amount authorized for the order, that is uncaptured or undercaptured.

    Deprecation warning

    Use totalCapturableSet instead

  • totalDiscounts (Money) deprecated

    Total amount discounted from the order (includes order-level and line item discounts).

    Deprecation warning

    Use totalDiscountsSet instead

  • totalPrice (Money!) deprecated

    Total amount of the order (includes taxes and discounts).

    Deprecation warning

    Use totalPriceSet instead

  • totalReceived (Money!) deprecated

    Total amount received by the customer for the order.

    Deprecation warning

    Use totalReceivedSet instead

  • totalRefunded (Money!) deprecated

    Total amount refunded for the order.

    Deprecation warning

    Use totalRefundedSet instead

  • totalShippingPrice (Money!) deprecated

    Total amount charged for shipping the order.

    Deprecation warning

    Use totalShippingPriceSet instead

  • totalTax (Money) deprecated

    Total of all taxes applied to the order.

    Deprecation warning

    Use totalTaxSet instead

  • totalTipReceived (MoneyV2!) deprecated

    Total tip amount received for the order.

    Deprecation warning

    Use totalTipReceivedSet instead

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple Orders.

On this page

Fields

Version 2021-04 (Latest)

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

Version 2021-01

An order represents an agreement to do business between a customer and a merchant.

Required access

read_orders 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

  • events (EventConnection!)

    List of internal events associated with 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.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

  • fulfillmentOrders (FulfillmentOrderConnection!)

    List of fulfillment orders with pagination.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    displayable ( Boolean )

    Whether fulfillment orders requested should be displayed to the merchant.
    Default value: false

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • assigned_location_id
    • status

    See the detailed search syntax.

    reverse ( Boolean )

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

  • lineItems (LineItemConnection!)

    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

  • localizationExtensions (LocalizationExtensionConnection!)

    List of localization extensions for 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.

    countryCodes ( [CountryCode!] )

    The country codes of the extensions.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    purposes ( [LocalizationExtensionPurpose!] )

    The purpose of the extensions.

    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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • nonFulfillableLineItems (LineItemConnection!)

    Line items that can't be fulfilled. For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. These line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments.

    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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • shippingLines (ShippingLineConnection!)

    List of line items that contains the shipping costs.

    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

  • Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.

  • billingAddress (MailingAddress)

    Mailing address provided by the customer. Not all orders have mailing addresses.

  • billingAddressMatchesShippingAddress (Boolean!)

    Whether the billing address matches the shipping address.

  • canMarkAsPaid (Boolean!)

    Whether the order can be manually marked as paid.

  • canNotifyCustomer (Boolean!)

    Whether notifications can be sent to the customer or not.

  • cancelReason (OrderCancelReason)

    Reason the order was canceled. Returns null if the order wasn't canceled.

  • cancelledAt (DateTime)

    Date and time when the order was canceled. Returns null if the order wasn't canceled.

  • capturable (Boolean!)

    Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired.

  • cartDiscountAmountSet (MoneyBag)

    Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

  • clientIp (String)

    The ip address of the client that is associated with this order.

  • closed (Boolean!)

    Whether the order is closed.

  • closedAt (DateTime)

    Date and time when the order closed. If the order is not closed, then this field is null.

  • confirmed (Boolean!)

    Whether inventory has been reserved for the order.

  • createdAt (DateTime!)

    Date and time when the order was created in Shopify.

  • currencyCode (CurrencyCode!)

    The currency of the store at the time of the order. If payment hasn't occurred, then this field is null.

  • currentCartDiscountAmountSet (MoneyBag!)

    The amount of the order-level discount minus the amounts for line items that have been returned. This doesn't include line item discounts.

  • currentSubtotalLineItemsQuantity (Int!)

    The sum of the quantities for the line items that contribute to the order's subtotal.

  • currentSubtotalPriceSet (MoneyBag!)

    The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.

  • currentTaxLines ([TaxLine!]!)

    The taxes charged for the order minus the taxes for line items that have been returned.

  • currentTotalDiscountsSet (MoneyBag!)

    The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.

  • currentTotalDutiesSet (MoneyBag)

    The total amount of duties for the order. If duties aren't applicable, then this value is null.

  • currentTotalPriceSet (MoneyBag!)

    The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.

  • currentTotalTaxSet (MoneyBag!)

    The total of all taxes applied to the order minus the taxes for line items that have been returned.

  • currentTotalWeight (UnsignedInt64!)

    The total weight (grams) of the order minus the weights for line items that have been returned.

  • customAttributes ([Attribute!]!)

    Custom information added to the order by your customer (Also referred to as note attributes).

  • customer (Customer)

    Unique identifier of the customer who placed the order. Not all orders have customers associated with them.

  • customerAcceptsMarketing (Boolean!)

    Whether the customer agreed to receive marketing materials.

  • customerJourneySummary (CustomerJourneySummary)

    Description of the customer's experience with the store leading up to the order. Loaded asynchronously, consumers should poll until the 'ready' field resolves to true.

  • customerLocale (String)

    A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be 'en', 'en-CA', 'en-PIRATE'.

  • discountCode (String)

    Discount code provided by the customer.

  • displayAddress (MailingAddress)

    Primary address of the customer, which is shown on the order.

  • displayFinancialStatus (OrderDisplayFinancialStatus)

    Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.

  • displayFulfillmentStatus (OrderDisplayFulfillmentStatus!)

    Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.

  • Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.

  • edited (Boolean!)

    Whether the order has had any edits applied or not.

  • email (String)

    Email address provided by the customer.

  • fulfillable (Boolean!)

    Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.

  • fulfillments ([Fulfillment!]!)

    List of shipments for the order.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • fullyPaid (Boolean!)

    Whether the order has been paid in full.

  • hasTimelineComment (Boolean!)

    Whether the merchant added timeline comments to the order.

  • id (ID!)

    Globally unique identifier.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • merchantEditable (Boolean!)