Comment Event Subject

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyContactRoleSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to contactscontacts

•CompanyContactConnection!

non-null

The list of contacts in the company.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyContactSortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to email •string
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to name •string
Anchor to role_name •string
Anchor to status •string
Anchor to updated_at •time

Anchor to contactsCountcontactsCount

•Count

The number of contacts that belong to the company.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) at which the company was created in Shopify.

Anchor to customerSincecustomerSince

non-null

The date and time (ISO 8601 format) at which the company became the customer.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to defaultRoledefaultRole

•CompanyContactRole

The role proposed by default for a contact at the company.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of the company's draft orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DraftOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant added a timeline comment to the company.

•ID!

non-null

A globally-unique ID.

Anchor to lifetimeDurationlifetimeDuration

non-null

The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.

Anchor to locationslocations

•CompanyLocationConnection!

non-null

The list of locations in the company.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyLocationSortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to created_at •time
Anchor to external_id •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string
Anchor to updated_at •time

Anchor to locationsCountlocationsCount

•Count

The number of locations that belong to the company.

Anchor to mainContactmainContact

•CompanyContact

The main contact for the company.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

The name of the company.

•String

A note about the company.

Anchor to ordersorders

•OrderConnection!

non-null

The list of the company's orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to ordersCountordersCount

•Count

The total number of orders placed for this company, across all its locations.

Anchor to totalSpenttotalSpent

non-null

The total amount spent by this company, across all its locations.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) at which the company was last modified.

Anchor to contactCountcontactCount

•Int!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to CompanyLocation CompanyLocation

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

•OBJECT

A location or branch of a Company that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.

Anchor to billingAddressbillingAddress

•CompanyAddress

The address used as billing address for the location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

Anchor to catalogscatalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to catalogsCountcatalogsCount

•Count

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to companycompany

•Company!

non-null

The company that the company location belongs to.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) at which the company location was created in Shopify.

Anchor to currencycurrency

non-null

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DraftOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company location.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant added a timeline comment to the company location.

•ID!

non-null

A globally-unique ID.

Anchor to inCataloginCatalog

non-null

Whether the company location is assigned a specific catalog.

Anchor to catalogIdcatalogId •ID! required: The ID of the catalog.

Anchor to localelocale

•String

The preferred locale of the company location.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

The name of the company location.

•String

A note about the company location.

Anchor to ordersorders

•OrderConnection!

non-null

The list of orders for the company location.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to ordersCountordersCount

•Count

The total number of orders placed for the location.

•CompanyContactRoleAssignmentConnection!

•String

The phone number of the company location.

Anchor to roleAssignmentsroleAssignments

non-null

The list of roles assigned to the company location.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyContactRoleAssignmentSortKeys

Default:ID

Sort the underlying list by the given key.

•CompanyLocationStaffMemberAssignmentConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to company_contact_role_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to role_name •string
Anchor to updated_at •time

Anchor to shippingAddressshippingAddress

•CompanyAddress

The address used as shipping address for the location.

Anchor to staffMemberAssignmentsstaffMemberAssignments

non-null

The list of staff members assigned to the company location.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyLocationStaffMemberAssignmentSortKeys

Default:ID

Sort the underlying list by the given key.

•StoreCreditAccountConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to company_location_id •id
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to staff_member_id •id
Anchor to updated_at •time

Anchor to storeCreditAccountsstoreCreditAccounts

non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•CompanyLocationTaxSettings!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to currency_code •string
Anchor to id •id: Filter by id range.

Anchor to taxSettingstaxSettings

non-null

The tax settings for the company location.

Anchor to totalSpenttotalSpent

non-null

The total amount spent by the location.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) at which the company location was last modified.

Anchor to marketmarket

•Market!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to Customer Customer

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to orderCountorderCount

•Int!

non-nullDeprecated

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-nullDeprecated

Anchor to taxRegistrationIdtaxRegistrationId

•String

Deprecated

•OBJECT

Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.

Tracks the customer's total spending through the amountSpent field and provides access to associated data such as payment methods and subscription contracts.

Caution

Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Anchor to addressesV2addressesV2

•MailingAddressConnection!

non-null

The addresses associated with the customer.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to amountSpentamountSpent

non-null

The total amount that the customer has spent on orders in their lifetime.

Anchor to canDeletecanDelete

non-null

Whether the merchant can delete the customer from their store.

A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.

Anchor to companyContactProfilescompanyContactProfiles

•[CompanyContact!]!

non-null

A list of the customer's company contact profiles.

Anchor to createdAtcreatedAt

non-null

The date and time when the customer was added to the store.

Anchor to dataSaleOptOutdataSaleOptOut

non-null

Whether the customer has opted out of having their data sold.

Anchor to defaultAddressdefaultAddress

The default address associated with the customer.

Anchor to defaultEmailAddressdefaultEmailAddress

•CustomerEmailAddress

The customer's default email address.

Anchor to defaultPhoneNumberdefaultPhoneNumber

•CustomerPhoneNumber

The customer's default phone number.

Anchor to displayNamedisplayName

non-null

The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.

non-null

A list of events associated with the customer.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to firstNamefirstName

•String

The customer's first name.

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image!

non-null

The image associated with the customer.

Anchor to sizesize •Int Deprecated

Anchor to lastNamelastName

•String

The customer's last name.

Anchor to lastOrderlastOrder

•Order

The customer's last order.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to lifetimeDurationlifetimeDuration

non-null

The amount of time since the customer was first added to the store.

Example: 'about 12 years'.

Anchor to localelocale

non-null

The customer's locale.

Anchor to mergeablemergeable

•CustomerMergeable!

non-null

Whether the customer can be merged with another customer.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to multipassIdentifiermultipassIdentifier

•String

A unique identifier for the customer that's used with Multipass login.

•String

A note about the customer.

Anchor to numberOfOrdersnumberOfOrders

non-null

The number of orders that the customer has made at the store in their lifetime.

Anchor to ordersorders

•OrderConnection!

non-null

A list of the customer's orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•CustomerPaymentMethodConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to paymentMethodspaymentMethods

non-null

A list of the customer's payment methods.

Anchor to showRevokedshowRevoked •Boolean Default:false: Whether to show the customer's revoked payment method.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productSubscriberStatusproductSubscriberStatus

•CustomerProductSubscriberStatus!

non-null

Possible subscriber states of a customer defined by their subscription contracts.

Anchor to statestate

•CustomerState!

non-null

The state of the customer's account with the shop.

Please note that this only meaningful when Classic Customer Accounts is active.

Anchor to statisticsstatistics

•CustomerStatistics!

non-null

The statistics for a given customer.

Anchor to storeCreditAccountsstoreCreditAccounts

•StoreCreditAccountConnection!

non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•SubscriptionContractConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to currency_code •string
Anchor to id •id: Filter by id range.

Anchor to subscriptionContractssubscriptionContracts

non-null

A list of the customer's subscription contracts.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

A comma separated list of tags that have been added to the customer.

Anchor to taxExempttaxExempt

non-null

Whether the customer is exempt from being charged taxes on their orders.

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-null

The list of tax exemptions applied to the customer.

Anchor to updatedAtupdatedAt

non-null

The date and time when the customer was last updated.

Anchor to verifiedEmailverifiedEmail

•CustomerEmailMarketingConsentState

non-null

Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

Anchor to addressesaddresses

•[MailingAddress!]!

non-nullDeprecated

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to emailemail

•String

Deprecated

Anchor to emailMarketingConsentemailMarketingConsent

Deprecated

Anchor to hasTimelineCommenthasTimelineComment

non-nullDeprecated

Anchor to marketmarket

•Market

Deprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

•CustomerSmsMarketingConsentState

•String

Deprecated

Anchor to smsMarketingConsentsmsMarketingConsent

Deprecated

Anchor to unsubscribeUrlunsubscribeUrl

•URL!

non-nullDeprecated

Anchor to validEmailAddressvalidEmailAddress

Anchor to DraftOrder DraftOrder

non-nullDeprecated

•OBJECT

An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:

Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
Send invoices to customers to pay with a secure checkout link.
Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
Re-create orders manually from active sales channels.
Sell products at discount or wholesale rates.
Take pre-orders.

For draft orders in multiple currencies presentment_money is the source of truth for what a customer is going to be charged and shop_money is an estimate of what the merchant might receive in their shop currency.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.

Anchor to acceptAutomaticDiscountsacceptAutomaticDiscounts

Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see appliedDiscount) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.

Anchor to allowDiscountCodesInCheckoutallowDiscountCodesInCheckout

non-null

Whether discount codes are allowed during checkout of this draft order.

Anchor to allVariantPricesOverriddenallVariantPricesOverridden

non-null

Whether all variant prices have been overridden.

Anchor to anyVariantPricesOverriddenanyVariantPricesOverridden

non-null

Whether any variant prices have been overridden.

Anchor to appliedDiscountappliedDiscount

•DraftOrderAppliedDiscount

The custom order-level discount applied.

Anchor to billingAddressbillingAddress

The billing address of the customer.

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress

non-null

Whether the billing address matches the shipping address.

Anchor to completedAtcompletedAt

The date and time when the draft order was converted to a new order, and had it's status changed to Completed.

Anchor to createdAtcreatedAt

non-null

The date and time when the draft order was created in Shopify.

Anchor to currencyCodecurrencyCode

non-null

The shop currency used for calculation.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

The custom information added to the draft order on behalf of the customer.

Anchor to customercustomer

•Customer

The customer who will be sent an invoice.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to discountCodesdiscountCodes

non-null

All discount codes applied.

Anchor to emailemail

•String

The email address of the customer, which is used to send notifications.

non-null

The list of events associated with the draft order.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant has added timeline comments to the draft order.

•ID!

non-null

A globally-unique ID.

Anchor to invoiceEmailTemplateSubjectinvoiceEmailTemplateSubject

non-null

The subject defined for the draft invoice email template.

Anchor to invoiceSentAtinvoiceSentAt

The date and time when the invoice was last emailed to the customer.

Anchor to invoiceUrlinvoiceUrl

•URL

The link to the checkout, which is sent to the customer in the invoice email.

Anchor to legacyResourceIdlegacyResourceId

•DraftOrderLineItemConnection!

non-null

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

Anchor to lineItemslineItems

non-null

The list of the line items in the draft order.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice

non-null

A subtotal of the line items and corresponding discounts, excluding shipping charges, shipping discounts, taxes, or order discounts.

Anchor to localizedFieldslocalizedFields

•LocalizedFieldConnection!

non-null

List of localized fields for the resource.

Arguments

Anchor to countryCodescountryCodes

The country codes of the extensions.

Anchor to purposespurposes

•[LocalizedFieldPurpose!]

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

The identifier for the draft order, which is unique within the store. For example, #D1223.

Anchor to note2note2

•String

The text from an optional note attached to the draft order.

Anchor to orderorder

•Order

The order that was created from the draft order.

Anchor to paymentTermspaymentTerms

•PaymentTerms

The associated payment terms for this draft order.

•[DraftOrderPlatformDiscount!]!

•String

The assigned phone number.

Anchor to platformDiscountsplatformDiscounts

non-null

The list of platform discounts applied.

Anchor to poNumberpoNumber

•String

The purchase order number.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode

non-null

The payment currency used for calculation.

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntity

The purchasing entity.

Anchor to readyready

non-null

Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.

Anchor to reserveInventoryUntilreserveInventoryUntil

The time after which inventory will automatically be restocked.

Anchor to shippingAddressshippingAddress

The shipping address of the customer.

Anchor to shippingLineshippingLine

•ShippingLine

The line item containing the shipping information and costs.

Anchor to statusstatus

•DraftOrderStatus!

non-null

The status of the draft order.

Anchor to subtotalPriceSetsubtotalPriceSet

non-null

The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.

non-null

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

Anchor to taxesIncludedtaxesIncluded

non-null

Whether the line item prices include taxes.

Anchor to taxExempttaxExempt

non-null

Whether the draft order is tax exempt.

Anchor to taxLinestaxLines

•[TaxLine!]!

non-null

The list of of taxes lines charged for each line item and shipping line.

Anchor to totalDiscountsSettotalDiscountsSet

non-null

Total discounts.

Anchor to totalLineItemsPriceSettotalLineItemsPriceSet

non-null

Total price of line items, excluding discounts.

Anchor to totalPriceSettotalPriceSet

non-null

The total price, includes taxes, shipping charges, and discounts.

Anchor to totalQuantityOfLineItemstotalQuantityOfLineItems

•Int!

non-null

The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.

Anchor to totalShippingPriceSettotalShippingPriceSet

non-null

The total shipping price.

Anchor to totalTaxSettotalTaxSet

non-null

The total tax.

Anchor to totalWeighttotalWeight

non-null

The total weight in grams of the draft order.

Anchor to transformerFingerprinttransformerFingerprint

•String

Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.

Anchor to updatedAtupdatedAt

non-null

The date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.

Anchor to visibleToCustomervisibleToCustomer

•LocalizationExtensionConnection!

non-null

Whether the draft order will be visible to the customer on the self-serve portal.

Anchor to warningswarnings

•[DraftOrderWarning!]!

non-null

The list of warnings raised while calculating.

Anchor to localizationExtensionslocalizationExtensions

non-nullDeprecated

Arguments

Anchor to countryCodescountryCodes

•[LocalizationExtensionPurpose!]

The country codes of the extensions.

Anchor to purposespurposes

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to marketNamemarketName

Anchor to InventoryTransfer InventoryTransfer

non-nullDeprecated

Anchor to marketRegionCountryCodemarketRegionCountryCode

•CountryCode!

non-nullDeprecated

Anchor to subtotalPricesubtotalPrice

•Money!

non-nullDeprecated

Anchor to totalPricetotalPrice

•Money!

non-nullDeprecated

Anchor to totalShippingPricetotalShippingPrice

•Money!

non-nullDeprecated

Anchor to totalTaxtotalTax

•Money!

non-nullDeprecated

•OBJECT

Tracks the movement of InventoryItem objects between Location objects. A transfer includes origin and destination information, InventoryTransferLineItem objects with quantities, and shipment details.

Transfers progress through multiple statuses. The transfer maintains LocationSnapshot objects of location details to preserve historical data even if locations change or are deleted later.

Anchor to dateCreateddateCreated

The date and time the inventory transfer was created in UTC format.

Anchor to destinationdestination

•LocationSnapshot

Snapshot of the destination location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil.

non-null

The list of events associated with the inventory transfer.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant has added timeline comments to the inventory transfer.

•InventoryTransferLineItemConnection!

•ID!

non-null

A globally-unique ID.

Anchor to lineItemslineItems

non-null

The line items associated with the inventory transfer.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.

Anchor to lineItemsCountlineItemsCount

•Count

The number of line items associated with the inventory transfer. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

The name of the inventory transfer.

•InventoryShipmentConnection!

•String

Additional note attached to the inventory transfer.

Anchor to originorigin

•LocationSnapshot

Snapshot of the origin location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil.

Anchor to receivedQuantityreceivedQuantity

•Int!

non-null

The total quantity of items received in the transfer.

Anchor to referenceNamereferenceName

•String

The reference name of the inventory transfer.

Anchor to shipmentsshipments

non-null

The shipments associated with the inventory transfer.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to statusstatus

•InventoryTransferStatus!

non-null

The current status of the transfer.

non-null

A list of tags that have been added to the inventory transfer.

Anchor to totalQuantitytotalQuantity

•Int!

non-null

The total quantity of items being transferred.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to Order Order

•OBJECT

The Order object represents a customer's request to purchase one or more products from a store. Use the Order object to handle the complete purchase lifecycle from checkout to fulfillment.

Use the Order object when you need to:

Display order details on customer account pages or admin dashboards.
Create orders for phone sales, wholesale customers, or subscription services.
Update order information like shipping addresses, notes, or fulfillment status.
Process returns, exchanges, and partial refunds.
Generate invoices, receipts, and shipping labels.

The Order object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.

Note

Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders, read_orders, and write_orders scopes.

Caution

Only use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Learn more about building apps for orders and fulfillment.

Anchor to additionalFeesadditionalFees

•[AdditionalFee!]!

non-null

A list of additional fees applied to an order, such as duties, import fees, or tax lines.

Anchor to agreementsagreements

•SalesAgreementConnection!

non-null

A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to happened_at •time
Anchor to id •id: Filter by id range.

Anchor to alertsalerts

•[ResourceAlert!]!

non-null

A list of messages that appear on the Orders page in the Shopify admin. These alerts provide merchants with important information about an order's status or required actions.

Anchor to appapp

•OrderApp

The application that created the order. For example, "Online Store", "Point of Sale", or a custom app name. Use this to identify the order source for attribution and fulfillment workflows. Learn more about building apps for orders and fulfillment.

Anchor to billingAddressbillingAddress

The billing address associated with the payment method selected by the customer for an order. Returns null if no billing address was provided during checkout.

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress

non-null

Whether the billing address matches the shipping address. Returns true if both addresses are the same, and false if they're different or if an address is missing.

Anchor to cancellationcancellation

•OrderCancellation

Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any staff notes.

Anchor to cancelledAtcancelledAt

The date and time in ISO 8601 format when an order was canceled. Returns null if the order hasn't been canceled.

Anchor to cancelReasoncancelReason

•OrderCancelReason

The reason provided for an order cancellation. For example, a merchant might cancel an order if there's insufficient inventory. Returns null if the order hasn't been canceled.

Anchor to canMarkAsPaidcanMarkAsPaid

non-null

Whether an order can be manually marked as paid. Returns false if the order is already paid, is canceled, has pending Shopify Payments transactions, or has a negative payment amount.

Anchor to canNotifyCustomercanNotifyCustomer

non-null

Whether order notifications can be sent to the customer. Returns true if the customer has a valid email address.

Anchor to capturablecapturable

non-null

Whether an authorized payment for an order can be captured. Returns true if an authorized payment exists that hasn't been fully captured yet. Learn more about capturing payments.

Anchor to cartDiscountAmountSetcartDiscountAmountSet

The total discount amount applied at the time the order was created, displayed in both shop and presentment currencies, before returns, refunds, order edits, and cancellations. This field only includes discounts applied to the entire order.

Anchor to channelInformationchannelInformation

•ChannelInformation

Details about the sales channel that created the order, such as the channel app type and channel name, which helps to track order sources.

Anchor to clientIpclientIp

•String

The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis.

Anchor to closedclosed

non-null

Whether an order is closed. An order is considered closed if all its line items have been fulfilled or canceled, and all financial transactions are complete.

Anchor to closedAtclosedAt

The date and time ISO 8601 format when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns null if the order isn't closed.

Anchor to confirmationNumberconfirmationNumber

•String

A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example, XPAV284CT) and isn't guaranteed to be unique across orders.

Anchor to confirmedconfirmed

non-null

Whether inventory has been reserved for an order. Returns true if inventory quantities for an order's line items have been reserved. Learn more about managing inventory quantities and states.

Anchor to createdAtcreatedAt

non-null

The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.

Anchor to currencyCodecurrencyCode

non-null

The shop currency when the order was placed. For example, "USD" or "CAD".

Anchor to currentCartDiscountAmountSetcurrentCartDiscountAmountSet

non-null

The current total of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations. This includes discount codes, automatic discounts, and other promotions that affect the whole order rather than individual line items. To get the original discount amount at the time of order creation, use the cartDiscountAmountSet field.

Anchor to currentShippingPriceSetcurrentShippingPriceSet

non-null

The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.

Anchor to currentSubtotalLineItemsQuantitycurrentSubtotalLineItemsQuantity

•Int!

non-null

The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations.

Anchor to currentSubtotalPriceSetcurrentSubtotalPriceSet

non-null

The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.

Anchor to currentTaxLinescurrentTaxLines

•[TaxLine!]!

non-null

A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same rate and title.

Anchor to currentTotalAdditionalFeesSetcurrentTotalAdditionalFeesSet

The current total of all additional fees for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. Additional fees can include charges such as duties, import fees, and special handling.

Anchor to currentTotalDiscountsSetcurrentTotalDiscountsSet

non-null

The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.

Anchor to currentTotalDutiesSetcurrentTotalDutiesSet

The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.

Anchor to currentTotalPriceSetcurrentTotalPriceSet

non-null

The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.

Anchor to currentTotalTaxSetcurrentTotalTaxSet

non-null

The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies.

Anchor to currentTotalWeightcurrentTotalWeight

non-null

The total weight of the order after returns and refunds, in grams.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes.

Anchor to customercustomer

•Customer

The customer who placed an order. Returns null if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about customer accounts.

Anchor to customerAcceptsMarketingcustomerAcceptsMarketing

•DiscountApplicationConnection!

non-null

Whether the customer agreed to receive marketing emails at the time of purchase. Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns. Learn more about building customer segments.

Anchor to customerJourneySummarycustomerJourneySummary

•CustomerJourneySummary

The customer's visits and interactions with the online store before placing the order. Use this to understand customer behavior, attribution sources, and marketing effectiveness to optimize your sales funnel.

Anchor to customerLocalecustomerLocale

•String

The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language.

Anchor to discountApplicationsdiscountApplications

non-null

A list of discounts that are applied to the order, excluding order edits and refunds. Includes discount codes, automatic discounts, and other promotions that reduce the order total.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to discountCodediscountCode

•String

The discount code used for an order. Returns null if no discount code was applied.

Anchor to discountCodesdiscountCodes

non-null

The discount codes used for the order. Multiple codes can be applied to a single order.

Anchor to displayAddressdisplayAddress

•OrderDisplayFinancialStatus

The primary address of the customer, prioritizing shipping address over billing address when both are available. Returns null if neither shipping address nor billing address was provided.

Anchor to displayFinancialStatusdisplayFinancialStatus

An order's financial status for display in the Shopify admin.

Anchor to displayFulfillmentStatusdisplayFulfillmentStatus

•OrderDisplayFulfillmentStatus!

non-null

The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the FulfillmentOrder object.

Anchor to disputesdisputes

•[OrderDisputeSummary!]!

non-null

A list of payment disputes associated with the order, such as chargebacks or payment inquiries. Disputes occur when customers challenge transactions with their bank or payment provider.

Anchor to dutiesIncludeddutiesIncluded

non-null

Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders.

Anchor to editededited

non-null

Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices.

Anchor to emailemail

•String

The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns null if no email address was provided during checkout.

Anchor to estimatedTaxesestimatedTaxes

non-null

Whether taxes on the order are estimated. This field returns false when taxes on the order are finalized and aren't subject to any changes.

non-null

A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to fulfillablefulfillable

•FulfillmentOrderConnection!

non-null

Whether there are line items that can be fulfilled. This field returns false when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.

Anchor to fulfillmentOrdersfulfillmentOrders

non-null

A list of fulfillment orders for an order. Each fulfillment order groups line items that are fulfilled together, allowing an order to be processed in parts if needed.

Arguments

Anchor to displayabledisplayable

Default:false

If false, all fulfillment orders will be returned. If true, fulfillment orders that are normally hidden from the merchant will be excluded. For example, fulfillment orders that were closed after being combined or moved are hidden.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to assigned_location_id •id
Anchor to id •id: Filter by id range.
Anchor to status •string
Anchor to updated_at •time

Anchor to fulfillmentsfulfillments

•[Fulfillment!]!

non-null

A list of shipments for the order. Fulfillments represent the physical shipment of products to customers.

Anchor to firstfirst •Int: Truncate the array result to this size.
Anchor to queryquery •String: Optional query string to filter fulfillments by timestamps. Examples: created_at:>='2024-05-07T08:37:00Z' updated_at:<'2025-05-07T08:37:00Z', created_at:'2024-05-07T08:37:00Z'

Anchor to fulfillmentsCountfulfillmentsCount

•Count

The total number of fulfillments for the order, including canceled ones.

Anchor to fullyPaidfullyPaid

non-null

Whether the order has been paid in full. This field returns true when the total amount received equals or exceeds the order total.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant has added a timeline comment to the order.

•ID!

non-null

A globally-unique ID.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to lineItemslineItems

•LineItemConnection!

non-null

A list of the order's line items. Line items represent the individual products and quantities that make up the order.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to localizedFieldslocalizedFields

•LocalizedFieldConnection!

non-null

List of localized fields for the resource.

Arguments

Anchor to countryCodescountryCodes

The country codes of the extensions.

Anchor to purposespurposes

•[LocalizedFieldPurpose!]

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to merchantBusinessEntitymerchantBusinessEntity

•BusinessEntity!

non-null

The legal business structure that the merchant operates under for this order, such as an LLC, corporation, or partnership. Used for tax reporting, legal compliance, and determining which business entity is responsible for the order.

Anchor to merchantEditablemerchantEditable

non-null

Whether the order can be edited by the merchant. Returns false for orders that can't be modified, such as canceled orders or orders with specific payment statuses.

Anchor to merchantEditableErrorsmerchantEditableErrors

non-null

A list of reasons why the order can't be edited. For example, canceled orders can't be edited.

Anchor to merchantOfRecordAppmerchantOfRecordApp

•OrderApp

The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking.

Anchor to netPaymentSetnetPaymentSet

non-null

The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.

Anchor to nonFulfillableLineItemsnonFulfillableLineItems

•LineItemConnection!

non-null

A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

•String

The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes.

Anchor to numbernumber

•Int!

non-null

The order number used to generate the name using the store's configured order number prefix/suffix. This number isn't guaranteed to follow a consecutive integer sequence (e.g. 1, 2, 3..), nor is it guaranteed to be unique across multiple stores, or even for a single store.

Anchor to originalTotalAdditionalFeesSetoriginalTotalAdditionalFeesSet

The total amount of all additional fees, such as import fees or taxes, that were applied when an order was created. Returns null if additional fees aren't applicable.

Anchor to originalTotalDutiesSetoriginalTotalDutiesSet

The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use currentTotalDutiesSet to retrieve the current duties amount after adjustments.

Anchor to originalTotalPriceSetoriginalTotalPriceSet

•OrderPaymentCollectionDetails!

non-null

The total price of the order at the time of order creation, in shop and presentment currencies. Use this to compare the original order value against the current total after edits, returns, or refunds.

Anchor to paymentCollectionDetailspaymentCollectionDetails

non-null

The payment collection details for the order, including payment status, outstanding amounts, and collection information. Use this to understand when and how payments should be collected, especially for orders with deferred or installment payment terms.

Anchor to paymentGatewayNamespaymentGatewayNames

non-null

A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".

Anchor to paymentTermspaymentTerms

•PaymentTerms

The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns null if no specific payment terms were set for the order.

•String

The phone number associated with the customer for this order. Useful for contacting customers about shipping updates, delivery notifications, or order issues. Returns null if no phone number was provided during checkout.

Anchor to poNumberpoNumber

•String

The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode

non-null

The currency used by the customer when placing the order. For example, "USD", "EUR", or "CAD". This may differ from the shop's base currency when serving international customers or using multi-currency pricing.

Anchor to processedAtprocessedAt

non-null

The date and time in ISO 8601 format when the order was processed. This date and time might not match the date and time when the order was created.

Anchor to productNetworkproductNetwork

non-null

Whether the customer also purchased items from other stores in the network.

Anchor to publicationpublication

•Publication

The sales channel that the order was created from, such as the Online Store or Shopify POS.

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntity

The business entity that placed the order, including company details and purchasing relationships. Used for B2B transactions to track which company or organization is responsible for the purchase and payment terms.

Anchor to refundablerefundable

non-null

Whether the order can be refunded based on its payment transactions. Returns false for orders with no eligible payment transactions, such as fully refunded orders or orders with non-refundable payment methods.

Anchor to refundDiscrepancySetrefundDiscrepancySet

non-null

The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.

Anchor to refundsrefunds

•[Refund!]!

non-null

A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments.

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to registeredSourceUrlregisteredSourceUrl

•URL

The URL of the source that the order originated from, if found in the domain registry. Returns null if the source URL isn't in the domain registry.

Anchor to requiresShippingrequiresShipping

non-null

Whether the order requires physical shipping to the customer. Returns false for digital-only orders (such as gift cards or downloadable products) and true for orders with physical products that need delivery. Use this to determine shipping workflows and logistics requirements.

Anchor to restockablerestockable

non-null

Whether any line items on the order can be restocked into inventory. Returns false for digital products, custom items, or items that can't be resold.

Anchor to retailLocationretailLocation

•Location

The physical location where a retail order is created or completed, except for draft POS orders completed using the "mark as paid" flow in the Shopify admin, which return null. Transactions associated with the order might have been processed at a different location.

Anchor to returnsreturns

•ReturnConnection!

non-null

The returns associated with the order. Contains information about items that customers have requested to return, including return reasons, status, and refund details. Use this to track and manage the return process for order items.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to status •string

Anchor to returnStatusreturnStatus

•OrderReturnStatus!

non-null

The order's aggregated return status for display purposes. Indicates the overall state of returns for the order, helping merchants track and manage the return process.

Anchor to riskrisk

•OrderRiskSummary!

non-null

The risk assessment summary for the order. Provides fraud analysis and risk scoring to help you identify potentially fraudulent orders. Use this to make informed decisions about order fulfillment and payment processing.

Anchor to shippingAddressshippingAddress

The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns null for digital orders or orders that don't require shipping.

Anchor to shippingLineshippingLine

•ShippingLine

A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs.

Anchor to shippingLinesshippingLines

•ShippingLineConnection!

non-null

The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order.

Anchor to includeRemovalsincludeRemovals •Boolean Default:false: Whether results should contain removed shipping lines.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to shopifyProtectshopifyProtect

•ShopifyProtectOrderSummary

The Shopify Protect details for the order, including fraud protection status and coverage information. Shopify Protect helps protect eligible orders against fraudulent chargebacks. Returns null if Shopify Protect is disabled for the shop or the order isn't eligible for protection. Learn more about Shopify Protect.

Anchor to sourceIdentifiersourceIdentifier

•String

A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The receiptNumber field is derived from this value for POS orders.

Anchor to sourceNamesourceName

•String

The name of the source associated with the order, such as "web", "mobile_app", or "pos". Use this field to identify the platform where the order was placed.

Anchor to staffMemberstaffMember

•StaffMember

The staff member who created or is responsible for the order. Useful for tracking which team member handled phone orders, manual orders, or order modifications. Returns null for orders created directly by customers through the online store.

Anchor to statusPageUrlstatusPageUrl

•URL!

non-null

The URL where customers can check their order's current status, including tracking information and delivery updates. Provides order tracking links in emails, apps, or customer communications.

Arguments

Anchor to audienceaudience

•Audience

Specifies the intended audience for the status page URL.

Anchor to notificationUsagenotificationUsage

•NotificationUsage

Specifies the intended notification usage for the status page URL.

Anchor to subtotalLineItemsQuantitysubtotalLineItemsQuantity

•Int!

non-null

The sum of quantities for all line items that contribute to the order's subtotal price. This excludes quantities for items like tips, shipping costs, or gift cards that don't affect the subtotal. Use this to quickly understand the total item count for pricing calculations.

Anchor to subtotalPriceSetsubtotalPriceSet

The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If taxesIncluded is true, then the subtotal also includes tax.

Anchor to suggestedRefundsuggestedRefund

•SuggestedRefund

A calculated refund suggestion for the order based on specified line items, shipping, and duties. Use this to preview refund amounts, taxes, and processing fees before creating an actual refund.

Arguments

Anchor to shippingAmountshippingAmount

•Money

The amount to refund for shipping. Overrides the refundShipping argument.

Anchor to refundShippingrefundShipping

Whether to refund the full shipping amount.

Anchor to refundLineItemsrefundLineItems

•[RefundLineItemInput!]

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

Anchor to refundDutiesrefundDuties

•[RefundDutyInput!]

The duties from the order to include in the refund.

Anchor to suggestFullRefundsuggestFullRefund

Default:false

Whether the suggested refund should be created from all refundable line items on the order. If true, the refundLineItems argument will be ignored.

Anchor to refundMethodAllocationrefundMethodAllocation

•RefundMethodAllocation

Default:ORIGINAL_PAYMENT_METHODS

Specifies which refund methods to allocate the suggested refund amount to.

non-null

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.

Anchor to taxesIncludedtaxesIncluded

non-null

Whether taxes are included in the subtotal price of the order. When true, the subtotal and line item prices include tax amounts. When false, taxes are calculated and displayed separately.

Anchor to taxExempttaxExempt

non-null

Whether taxes are exempt on the order. Returns true for orders where the customer or business has a valid tax exemption, such as non-profit organizations or tax-free purchases. Use this to understand if tax calculations were skipped during checkout.

Anchor to taxLinestaxLines

•[TaxLine!]!

non-null

A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same rate and title.

Anchor to testtest

non-null

Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa.

Anchor to totalCapturableSettotalCapturableSet

non-null

The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.

Anchor to totalCashRoundingAdjustmenttotalCashRoundingAdjustment

•CashRoundingAdjustment!

non-null

The total rounding adjustment applied to payments or refunds for an order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination.

Anchor to totalDiscountsSettotalDiscountsSet

The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.

Anchor to totalOutstandingSettotalOutstandingSet

non-null

The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).

Anchor to totalPriceSettotalPriceSet

non-null

The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.

Anchor to totalReceivedSettotalReceivedSet

non-null

The total amount received from the customer before returns, in shop and presentment currencies.

Anchor to totalRefundedSettotalRefundedSet

non-null

The total amount that was refunded, in shop and presentment currencies.

Anchor to totalRefundedShippingSettotalRefundedShippingSet

non-null

The total amount of shipping that was refunded, in shop and presentment currencies.

Anchor to totalShippingPriceSettotalShippingPriceSet

non-null

The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded.

Anchor to totalTaxSettotalTaxSet

The total tax amount before returns, in shop and presentment currencies.

Anchor to totalTipReceivedSettotalTipReceivedSet

non-null

The sum of all tip amounts for the order, in shop and presentment currencies.

Anchor to totalWeighttotalWeight

•UnsignedInt64

The total weight of the order before returns, in grams.

Anchor to transactionstransactions

•[OrderTransaction!]!

non-null

A list of transactions associated with the order.

Anchor to firstfirst •Int: Truncate the array result to this size.
Anchor to capturablecapturable •Boolean: Filter transactions by whether they are capturable.
Anchor to manuallyResolvablemanuallyResolvable •Boolean: Filter transactions by whether they can be resolved manually. For example, fully captured or voided transactions aren't manually resolvable.

Anchor to transactionsCounttransactionsCount

•Count

The number of transactions associated with the order.

Anchor to unpaidunpaid

non-null

Whether no payments have been made for the order.

Anchor to updatedAtupdatedAt

•LocalizationExtensionConnection!

non-null

The date and time in ISO 8601 format when the order was last modified.

Anchor to cartDiscountAmountcartDiscountAmount

•Money

Deprecated

Anchor to channelchannel

•Channel

Deprecated

Anchor to customerJourneycustomerJourney

•CustomerJourney

Deprecated

Anchor to landingPageDisplayTextlandingPageDisplayText

•String

Deprecated

Anchor to landingPageUrllandingPageUrl

•URL

Deprecated

Anchor to localizationExtensionslocalizationExtensions

non-nullDeprecated

Arguments

Anchor to countryCodescountryCodes

•[LocalizationExtensionPurpose!]

The country codes of the extensions.

Anchor to purposespurposes

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to netPaymentnetPayment

•Money!

non-nullDeprecated

Anchor to physicalLocationphysicalLocation

•Location

Deprecated

Anchor to referralCodereferralCode

•String

Deprecated

Anchor to referrerDisplayTextreferrerDisplayText

•String

Deprecated

Anchor to referrerUrlreferrerUrl

•URL

Deprecated

Anchor to riskLevelriskLevel

•OrderRiskLevel!

non-nullDeprecated

Anchor to risksrisks

•[OrderRisk!]!

non-nullDeprecated

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to subtotalPricesubtotalPrice

•Money

Deprecated

Anchor to totalCapturabletotalCapturable

•Money!

non-nullDeprecated

Anchor to totalDiscountstotalDiscounts

•Money

Deprecated

Anchor to totalPricetotalPrice

•Money!

non-nullDeprecated

Anchor to totalReceivedtotalReceived

•Money!

non-nullDeprecated

Anchor to totalRefundedtotalRefunded

•Money!

non-nullDeprecated

Anchor to totalShippingPricetotalShippingPrice

•Money!

non-nullDeprecated

Anchor to totalTaxtotalTax

•Money

Deprecated

Anchor to totalTipReceivedtotalTipReceived

Anchor to PriceRule PriceRule

non-nullDeprecated

•OBJECT

A set of conditions, including entitlements and prerequisites, that must be met for a discount code to apply.

Note

Use the types and queries included our discount tutorials instead. These will replace the GraphQL Admin API's PriceRule object and DiscountCode union, and the REST Admin API's deprecatedPriceRule resource.

Anchor to allocationLimitallocationLimit

•Int

The maximum number of times that the price rule can be allocated onto an order.

Anchor to allocationMethodallocationMethod

•PriceRuleAllocationMethod!

non-null

The method by which the price rule's value is allocated to its entitled items.

Anchor to appapp

•App

The application that created the price rule.

Anchor to combinesWithcombinesWith

•DiscountCombinesWith!

non-null

The discount classes that you can use in combination with Shopify discount types.

Anchor to createdAtcreatedAt

•PriceRuleCustomerSelection!

non-null

The date and time when the price rule was created.

Anchor to customerSelectioncustomerSelection

non-null

The customers that can use this price rule.

Anchor to discountClassesdiscountClasses

•[DiscountClass!]!

non-null

The classes of the discount.

Anchor to discountCodesdiscountCodes

•PriceRuleDiscountCodeConnection!

non-null

List of the price rule's discount codes.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DiscountCodeSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to times_used •integer

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to discountCodesCountdiscountCodesCount

•Count

How many discount codes associated with the price rule.

Anchor to endsAtendsAt

The date and time when the price rule ends. For open-ended price rules, use null.

non-null

The paginated list of events associated with the price rule.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to featuresfeatures

•[PriceRuleFeature!]!

non-null

A list of the price rule's features.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Indicates whether there are any timeline comments on the price rule.

•PriceRuleLineItemPrerequisites!

•ID!

non-null

A globally-unique ID.

Anchor to itemEntitlementsitemEntitlements

•PriceRuleItemEntitlements!

non-null

The items to which the price rule applies.

Anchor to itemPrerequisitesitemPrerequisites

non-null

The items required for the price rule to be applicable.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to oncePerCustomeroncePerCustomer

•PriceRulePrerequisiteToEntitlementQuantityRatio

non-null

Whether the price rule can be applied only once per customer.

Anchor to prerequisiteQuantityRangeprerequisiteQuantityRange

•PriceRuleQuantityRange

The number of the entitled items must fall within this range for the price rule to be applicable.

Anchor to prerequisiteShippingPriceRangeprerequisiteShippingPriceRange

•PriceRuleMoneyRange

The shipping cost must fall within this range for the price rule to be applicable.

Anchor to prerequisiteSubtotalRangeprerequisiteSubtotalRange

•PriceRuleMoneyRange

The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.

Anchor to prerequisiteToEntitlementQuantityRatioprerequisiteToEntitlementQuantityRatio

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

Anchor to shareableUrlsshareableUrls

•[PriceRuleShareableUrl!]!

non-null

URLs that can be used to share the discount.

Anchor to shippingEntitlementsshippingEntitlements

•PriceRuleShippingLineEntitlements!

non-null

The shipping lines to which the price rule applies.

Anchor to startsAtstartsAt

non-null

The date and time when the price rule starts.

Anchor to statusstatus

•PriceRuleStatus!

non-null

The status of the price rule.

Anchor to summarysummary

•String

A detailed summary of the price rule.

Anchor to targettarget

•PriceRuleTarget!

non-null

The type of lines (line_item or shipping_line) to which the price rule applies.

Anchor to titletitle