Metafield Referencer

non-null

A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

descriptionHtml

•HTML!

non-null

The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.

events

•EventConnection!

non-null

The paginated list of events associated with the host subject.

feedback

•ResourceFeedback

Information about the collection that's provided through resource feedback.

handle

non-null

A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title Summer Catalog 2022 might have the handle summer-catalog-2022.

If the title is changed, the handle doesn't automatically change.

The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.

hasProduct

non-null

Whether the collection includes the specified product.

Anchor to idid •ID! required: The ID of the product to check.

•ID!

non-null

A globally-unique ID.

image

•Image

The image associated with the collection.

legacyResourceId

•UnsignedInt64!

non-null

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

metafield

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

metafields

non-null

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

metafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

products

•ProductConnection!

non-null

The products that are included in the collection.

publishedOnCurrentPublication

non-null

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

publishedOnPublication

•ResourcePublicationConnection!

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

resourcePublications

non-null

The list of resources that are published to a publication.

resourcePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

resourcePublicationsV2

•ResourcePublicationV2Connection!

non-null

The list of resources that are either published or staged to be published to a publication.

ruleSet

•CollectionRuleSet

For a smart (automated) collection, specifies the rules that determine whether a product is included.

seo

•SEO!

non-null

If the default SEO fields for page title and description have been modified, contains the modified information.

sortOrder

•CollectionSortOrder!

non-null

The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

templateSuffix

•String

The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid template.

title

non-null

The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.

translations

•[Translation!]!

non-null

The published translations associated with the resource.

unpublishedPublications

•PublicationConnection!

non-null

The list of publications that the resource isn't published to.

updatedAt

•MetafieldDefinitionConnection!

non-null

The date and time (ISO 8601 format) when the collection was last modified.

metafieldDefinitions

non-nullDeprecated

publicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

publications

•CollectionPublicationConnection!

non-nullDeprecated

publishedOnChannel

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

publishedOnCurrentChannel

•BuyerExperienceConfiguration

non-nullDeprecated

storefrontId

•StorefrontID!

non-nullDeprecated

unpublishedChannels

•ChannelConnection!

non-nullDeprecated

Company

•OBJECT

Represents information about a company which is also a customer of the shop.

Anchor to contactRolescontactRoles •CompanyContactRoleConnection! non-null: The list of roles for the company contacts.
Anchor to contactscontacts •CompanyContactConnection! non-null: The list of contacts in the company.
Anchor to contactsCountcontactsCount •Count: The number of contacts that belong to the company.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) at which the company was created in Shopify.
Anchor to customerSincecustomerSince •DateTime! non-null: The date and time (ISO 8601 format) at which the company became the customer.
Anchor to defaultCursordefaultCursor •String! 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.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to externalIdexternalId •String: A unique externally-supplied ID for the company.
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether the merchant added a timeline comment to the company.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lifetimeDurationlifetimeDuration •String! 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.
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 •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-null: The name of the company.
Anchor to notenote •String: A note about the company.
Anchor to ordersorders •OrderConnection! non-null: The list of the company's orders.
Anchor to ordersCountordersCount •Count: The total number of orders placed for this company, across all its locations.
Anchor to totalSpenttotalSpent •MoneyV2! non-null: The total amount spent by this company, across all its locations.
Anchor to updatedAtupdatedAt •DateTime! 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 •MetafieldDefinitionConnection! non-nullDeprecated

CompanyLocation

•OBJECT

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

billingAddress

•CompanyAddress

The address used as billing address for the location.

buyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

catalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

catalogsCount

•Count

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

company

•Company!

non-null

The company that the company location belongs to.

createdAt

non-null

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

currency

•CurrencyCode!

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.

defaultCursor

non-null

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

draftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

events

•EventConnection!

non-null

The paginated list of events associated with the host subject.

externalId

•String

A unique externally-supplied ID for the company location.

hasPriceList

non-null

Whether the company location has a price list with the specified ID.

Anchor to priceListIdpriceListId •ID! required: The price list ID to check.

hasTimelineComment

non-null

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

•ID!

non-null

A globally-unique ID.

inCatalog

non-null

Whether the company location is assigned a specific catalog.

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

locale

•String

The preferred locale of the company location.

metafield

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

metafields

non-null

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

metafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

name

•CompanyContactRoleAssignmentConnection!

non-null

The name of the company location.

note

•String

A note about the company location.

orders

•OrderConnection!

non-null

The list of orders for the company location.

ordersCount

•Count

The total number of orders placed for the location.

phone

•String

The phone number of the company location.

priceLists

•PriceListConnection!

non-null

The list of price lists for the company location.

roleAssignments

non-null

The list of roles assigned to the company location.

shippingAddress

•CompanyAddress

The address used as shipping address for the location.

staffMemberAssignments

•CompanyLocationStaffMemberAssignmentConnection!

non-null

The list of staff members assigned to the company location.

taxSettings

•CompanyLocationTaxSettings!

non-null

The tax settings for the company location.

totalSpent

•MoneyV2!

non-null

The total amount spent by the location.

updatedAt

•MetafieldDefinitionConnection!

non-null

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

market

•Market!

non-nullDeprecated

metafieldDefinitions

non-nullDeprecated

orderCount

•Int!

non-nullDeprecated

taxExemptions

•[TaxExemption!]!

non-nullDeprecated

taxRegistrationId

•String

Deprecated

Customer

•OBJECT

Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

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 addressesaddresses •[MailingAddress!]! non-null: A list of addresses associated with the customer.
Anchor to addressesV2addressesV2 •MailingAddressConnection! non-null: The addresses associated with the customer.
Anchor to amountSpentamountSpent •MoneyV2! non-null: The total amount that the customer has spent on orders in their lifetime.
Anchor to canDeletecanDelete •Boolean! 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 •DateTime! non-null: The date and time when the customer was added to the store.
Anchor to dataSaleOptOutdataSaleOptOut •Boolean! non-null: Whether the customer has opted out of having their data sold.
Anchor to defaultAddressdefaultAddress •MailingAddress: 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 •String! 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.
Anchor to eventsevents •EventConnection! non-null: A list of events associated with the customer.
Anchor to firstNamefirstName •String: The customer's first name.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image! non-null: The image associated with the customer.
Anchor to lastNamelastName •String: The customer's last name.
Anchor to lastOrderlastOrder •Order: The customer's last order.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lifetimeDurationlifetimeDuration •String! non-null: The amount of time since the customer was first added to the store.

Example: 'about 12 years'.
Anchor to localelocale •String! non-null: The customer's locale.
Anchor to mergeablemergeable •CustomerMergeable! non-null: Whether the customer can be merged with another customer.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to multipassIdentifiermultipassIdentifier •String: A unique identifier for the customer that's used with Multipass login.
Anchor to notenote •String: A note about the customer.
Anchor to numberOfOrdersnumberOfOrders •UnsignedInt64! 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.
Anchor to paymentMethodspaymentMethods •CustomerPaymentMethodConnection! non-null: A list of the customer's payment methods.
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.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: A list of the customer's subscription contracts.
Anchor to tagstags •[String!]! non-null: A comma separated list of tags that have been added to the customer.
Anchor to taxExempttaxExempt •Boolean! 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 •DateTime! non-null: The date and time when the customer was last updated.
Anchor to verifiedEmailverifiedEmail •Boolean! 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 emailemail •String Deprecated
Anchor to emailMarketingConsentemailMarketingConsent •CustomerEmailMarketingConsentState Deprecated
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-nullDeprecated
Anchor to marketmarket •Market Deprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to phonephone •String Deprecated
Anchor to smsMarketingConsentsmsMarketingConsent •CustomerSmsMarketingConsentState Deprecated
Anchor to unsubscribeUrlunsubscribeUrl •URL! non-nullDeprecated
Anchor to validEmailAddressvalidEmailAddress •Boolean! non-nullDeprecated

DeliveryCustomization

•OBJECT

A delivery customization.

Anchor to enabledenabled •Boolean! non-null: The enabled status of the delivery customization.
Anchor to errorHistoryerrorHistory •FunctionsErrorHistory: The error history on the most recent version of the delivery customization.
Anchor to functionIdfunctionId •String! non-null: The ID of the Shopify Function implementing the delivery customization.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to shopifyFunctionshopifyFunction •ShopifyFunction! non-null: The Shopify Function implementing the delivery customization.
Anchor to titletitle •String! non-null: The title of the delivery customization.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

DiscountAutomaticNode

•OBJECT

The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

Anchor to automaticDiscountautomaticDiscount •DiscountAutomatic! non-null: A discount that's applied automatically when an order meets specific criteria. Learn more about automatic discounts.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

DiscountCodeNode

•OBJECT

The DiscountCodeNode object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

Anchor to codeDiscountcodeDiscount •DiscountCode! non-null: The underlying code discount object.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

DiscountNode

•OBJECT

The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to orders, products, or shipping, and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store.

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.

Anchor to discountdiscount •Discount! non-null: A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

DraftOrder

•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 •Boolean: 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 •Boolean! non-null: Whether discount codes are allowed during checkout of this draft order.
Anchor to allVariantPricesOverriddenallVariantPricesOverridden •Boolean! non-null: Whether all variant prices have been overridden.
Anchor to amountDueLaterSetamountDueLaterSet •MoneyBag! non-null: The amount due later. When there are payment terms, this is the total price minus the deposit amount (if any). When there are no payment terms, this is 0.
Anchor to amountDueNowSetamountDueNowSet •MoneyBag! non-null: The amount due now. When there are payment terms this is the value of the deposit (0 by default). When there are no payment terms, this is the total price.
Anchor to anyVariantPricesOverriddenanyVariantPricesOverridden •Boolean! non-null: Whether any variant prices have been overridden.
Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom order-level discount applied.
Anchor to billingAddressbillingAddress •MailingAddress: The billing address of the customer.
Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress •Boolean! non-null: Whether the billing address matches the shipping address.
Anchor to bypassCartValidationsbypassCartValidations •Boolean: Whether to bypass cart validations on this draft order.
Anchor to completedAtcompletedAt •DateTime: 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 •DateTime! non-null: The date and time when the draft order was created in Shopify.
Anchor to currencyCodecurrencyCode •CurrencyCode! 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 •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to depositdeposit •DepositConfiguration: The portion required to be paid at checkout.
Anchor to discountCodesdiscountCodes •[String!]! non-null: All discount codes applied.
Anchor to emailemail •String: The email address of the customer, which is used to send notifications.
Anchor to eventsevents •EventConnection! non-null: The list of events associated with the draft order.
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether the merchant has added timeline comments to the draft order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to invoiceEmailTemplateSubjectinvoiceEmailTemplateSubject •String! non-null: The subject defined for the draft invoice email template.
Anchor to invoiceSentAtinvoiceSentAt •DateTime: 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 •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lineItemslineItems •DraftOrderLineItemConnection! non-null: The list of the line items in the draft order.
Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice •MoneyBag! non-null: A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
Anchor to localizedFieldslocalizedFields •LocalizedFieldConnection! non-null: List of localized fields for the resource.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! 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.
Anchor to phonephone •String: The assigned phone number.
Anchor to platformDiscountsplatformDiscounts •[DraftOrderPlatformDiscount!]! non-null: The list of platform discounts applied.
Anchor to poNumberpoNumber •String: The purchase order number.
Anchor to presentmentCurrencyCodepresentmentCurrencyCode •CurrencyCode! non-null: The payment currency used for calculation.
Anchor to purchasingEntitypurchasingEntity •PurchasingEntity: The purchasing entity.
Anchor to readyready •Boolean! 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 •DateTime: The time after which inventory will automatically be restocked.
Anchor to shippingAddressshippingAddress •MailingAddress: 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 •MoneyBag! non-null: The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
Anchor to tagstags •[String!]! 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 •Boolean! non-null: Whether the line item prices include taxes.
Anchor to taxExempttaxExempt •Boolean! 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 •MoneyBag! non-null: Total discounts.
Anchor to totalLineItemsPriceSettotalLineItemsPriceSet •MoneyBag! non-null: Total price of line items.
Anchor to totalPriceSettotalPriceSet •MoneyBag! 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 •MoneyBag! non-null: The total shipping price.
Anchor to totalTaxSettotalTaxSet •MoneyBag! non-null: The total tax.
Anchor to totalWeighttotalWeight •UnsignedInt64! 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 •DateTime! 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 •Boolean! 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 •LocalizationExtensionConnection! non-nullDeprecated
Anchor to marketNamemarketName •String! 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

FulfillmentOrder

•OBJECT

The FulfillmentOrder object represents either an item or a group of items in an Order that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.

Fulfillment orders represent the work which is intended to be done in relation to an order. When fulfillment has started for one or more line items, a Fulfillment is created by a merchant or third party to represent the ongoing or completed work of fulfillment.

See below for more details on creating fulfillments.

Note

Shopify creates fulfillment orders automatically when an order is created. It is not possible to manually create fulfillment orders.

See below for more details on the lifecycle of a fulfillment order.

Retrieving fulfillment orders

Fulfillment orders from an order

All fulfillment orders related to a given order can be retrieved with the Order.fulfillmentOrders connection.

API access scopes govern which fulfillments orders are returned to clients. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders.

Fulfillment orders assigned to the app for fulfillment

Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the assignedFulfillmentOrders connection. Use the assignmentStatus argument to control whether all assigned fulfillment orders should be returned or only those where a merchant has sent a fulfillment request and it has yet to be responded to.

The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.

All fulfillment orders

Apps can retrieve all fulfillment orders with the fulfillmentOrders query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, which are accessible to the app according to the fulfillment order access scopes it was granted with.

The lifecycle of a fulfillment order

Fulfillment Order Creation

After an order is created, a background worker performs the order routing process which determines which locations will be responsible for fulfilling the purchased items. Once the order routing process is complete, one or more fulfillment orders will be created and assigned to these locations. It is not possible to manually create fulfillment orders.

Once a fulfillment order has been created, it will have one of two different lifecycles depending on the type of location which the fulfillment order is assigned to.

The lifecycle of a fulfillment order at a merchant managed location

Fulfillment orders are completed by creating fulfillments. Fulfillments represents the work done.

For digital products a merchant or an order management app would create a fulfilment once the digital asset has been provisioned. For example, in the case of a digital gift card, a merchant would to do this once the gift card has been activated - before the email has been shipped.

On the other hand, for a traditional shipped order, a merchant or an order management app would create a fulfillment after picking and packing the items relating to a fulfillment order, but before the courier has collected the goods.

Learn about managing fulfillment orders as an order management app.

The lifecycle of a fulfillment order at a location which is managed by a fulfillment service

For fulfillment orders which are assigned to a location that is managed by a fulfillment service, a merchant or an Order Management App can send a fulfillment request to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to accept or reject this fulfillment request.

Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant or order management app and instead a cancellation request must be submitted to the fulfillment service.

Once a fulfillment service accepts a fulfillment request, then after they are ready to pack items and send them for delivery, they create fulfillments with the fulfillmentCreate mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the fulfillmentTrackingInfoUpdate mutation.

Learn about managing fulfillment orders as a fulfillment service.

API access scopes

Fulfillment orders are governed by the following API access scopes:

The read_merchant_managed_fulfillment_orders and write_merchant_managed_fulfillment_orders access scopes grant access to fulfillment orders assigned to merchant-managed locations.
The read_assigned_fulfillment_orders and write_assigned_fulfillment_orders access scopes are intended for fulfillment services. These scopes grant access to fulfillment orders assigned to locations that are being managed by fulfillment services.
The read_third_party_fulfillment_orders and write_third_party_fulfillment_orders access scopes grant access to fulfillment orders assigned to locations managed by other fulfillment services.

Fulfillment service app access scopes

Usually, fulfillment services have the write_assigned_fulfillment_orders access scope and don't have the *_third_party_fulfillment_orders or *_merchant_managed_fulfillment_orders access scopes. The app will only have access to the fulfillment orders assigned to their location (or multiple locations if the app registers multiple fulfillment services on the shop). The app will not have access to fulfillment orders assigned to merchant-managed locations or locations owned by other fulfillment service apps.

Order management app access scopes

Order management apps will usually request write_merchant_managed_fulfillment_orders and write_third_party_fulfillment_orders access scopes. This will allow them to manage all fulfillment orders on behalf of a merchant.

If an app combines the functions of an order management app and a fulfillment service, then the app should request all access scopes to manage all assigned and all unassigned fulfillment orders.

Notifications about fulfillment orders

Fulfillment services are required to register a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified whenever a merchant submits a fulfillment or cancellation request.

Both merchants and apps can subscribe to the fulfillment order webhooks to be notified whenever fulfillment order related domain events occur.

Learn about fulfillment workflows.

Anchor to assignedLocationassignedLocation •FulfillmentOrderAssignedLocation! non-null: The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.

The fulfillment order's assigned location might change in the following cases:

The fulfillment order has been entirely moved to a new location. For example, the fulfillmentOrderMove mutation has been called, and you see the original fulfillment order in the movedFulfillmentOrder field within the mutation's response.

Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the OPEN, SCHEDULED, or ON_HOLD status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).
Anchor to channelIdchannelId •ID: ID of the channel that created the order.
Anchor to createdAtcreatedAt •DateTime! non-null: Date and time when the fulfillment order was created.
Anchor to deliveryMethoddeliveryMethod •DeliveryMethod: Delivery method of this fulfillment order.
Anchor to destinationdestination •FulfillmentOrderDestination: The destination where the items should be sent.
Anchor to fulfillAtfulfillAt •DateTime: The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the fulfill_at date for a subscription order might be the 1st of each month, a pre-order fulfill_at date would be nil, and a standard order fulfill_at date would be the order creation date.
Anchor to fulfillByfulfillBy •DateTime: The latest date and time by which all items in the fulfillment order need to be fulfilled.
Anchor to fulfillmentHoldsfulfillmentHolds •[FulfillmentHold!]! non-null: The fulfillment holds applied on the fulfillment order.
Anchor to fulfillmentOrdersForMergefulfillmentOrdersForMerge •FulfillmentOrderConnection! non-null: Fulfillment orders eligible for merging with the given fulfillment order.
Anchor to fulfillmentsfulfillments •FulfillmentConnection! non-null: A list of fulfillments for the fulfillment order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to internationalDutiesinternationalDuties •FulfillmentOrderInternationalDuties: The duties delivery method of this fulfillment order.
Anchor to lineItemslineItems •FulfillmentOrderLineItemConnection! non-null: A list of the fulfillment order's line items.
Anchor to locationsForMovelocationsForMove •FulfillmentOrderLocationForMoveConnection! non-null: A list of locations that the fulfillment order can potentially move to.
Anchor to merchantRequestsmerchantRequests •FulfillmentOrderMerchantRequestConnection! non-null: A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order.
Anchor to orderorder •Order! non-null: The order that's associated with the fulfillment order.
Anchor to orderIdorderId •ID! non-null: ID of the order that's associated with the fulfillment order.
Anchor to orderNameorderName •String! 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.
Anchor to orderProcessedAtorderProcessedAt •DateTime! non-null: The date and time when the order was processed. This date and time might not match the date and time when the order was created.
Anchor to requestStatusrequestStatus •FulfillmentOrderRequestStatus! non-null: The request status of the fulfillment order.
Anchor to statusstatus •FulfillmentOrderStatus! non-null: The status of the fulfillment order.
Anchor to supportedActionssupportedActions •[FulfillmentOrderSupportedAction!]! non-null: The actions that can be performed on this fulfillment order.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the fulfillment order was last updated.

Location

•OBJECT

Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have fulfills_online_orders: true and are configured with a shipping rate, pickup enabled or local delivery will be able to sell from their storefront.

Anchor to activatableactivatable •Boolean! non-null: Whether the location can be reactivated. If false, then trying to activate the location with the LocationActivate mutation will return an error that describes why the location can't be activated.
Anchor to addressaddress •LocationAddress! non-null: The address of this location.
Anchor to addressVerifiedaddressVerified •Boolean! non-null: Whether the location address has been verified.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) that the location was added to a shop.
Anchor to deactivatabledeactivatable •Boolean! non-null: Whether this location can be deactivated. If true, then the location can be deactivated by calling the LocationDeactivate mutation. If false, then calling the mutation to deactivate it will return an error that describes why the location can't be deactivated.
Anchor to deactivatedAtdeactivatedAt •String: The date and time (ISO 8601 format) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as "2019-09-07T15:50:00Z".
Anchor to deletabledeletable •Boolean! non-null: Whether this location can be deleted.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: Name of the service provider that fulfills from this location.
Anchor to fulfillsOnlineOrdersfulfillsOnlineOrders •Boolean! non-null: Whether this location can fulfill online orders.
Anchor to hasActiveInventoryhasActiveInventory •Boolean! non-null: Whether this location has active inventory.
Anchor to hasUnfulfilledOrdershasUnfulfilledOrders •Boolean! non-null: Whether this location has orders that need to be fulfilled.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inventoryLevelinventoryLevel •InventoryLevel: The quantities of an inventory item at this location.
Anchor to inventoryLevelsinventoryLevels •InventoryLevelConnection! non-null: A list of the quantities of the inventory items that can be stocked at this location.
Anchor to isActiveisActive •Boolean! non-null: Whether the location is active. A deactivated location can be activated (change isActive: true) if it has activatable set to true by calling the locationActivate mutation.
Anchor to isFulfillmentServiceisFulfillmentService •Boolean! non-null: Whether this location is a fulfillment service.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to localPickupSettingsV2localPickupSettingsV2 •DeliveryLocalPickupSettings: Local pickup settings for the location.
Anchor to metafieldmetafield •Metafield: 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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-null: The name of the location.
Anchor to shipsInventoryshipsInventory •Boolean! non-null: Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
Anchor to suggestedAddressessuggestedAddresses •[LocationSuggestedAddress!]! non-null: List of suggested addresses for this location (empty if none).
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the location was last updated.
Anchor to isPrimaryisPrimary •Boolean! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

Market

•OBJECT

A market is a group of one or more regions that you want to target for international sales. By creating a market, you can configure a distinct, localized shopping experience for customers from a specific area of the world. For example, you can change currency, configure international pricing, or add market-specific domains or subfolders.

assignedCustomization

non-null

Whether the market has a customization with the given ID.

Anchor to customizationIdcustomizationId •ID! required: The ID of the customization that the market has been assigned to.

catalogs

•MarketCatalogConnection!

non-null

The catalogs that belong to the market.

catalogsCount

•Count

The number of catalogs that belong to the market.

conditions

•MarketConditions

The conditions under which a visitor is in the market.

currencySettings

•MarketCurrencySettings

The market’s currency settings.

handle

non-null

A short, human-readable unique identifier for the market. This is changeable by the merchant.

•ID!

non-null

A globally-unique ID.

metafield

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

metafields

non-null

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

metafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

name

•MarketWebPresenceConnection!

non-null

The name of the market. Not shown to customers.

priceInclusions

•MarketPriceInclusions

The inclusive pricing strategy for a market. This determines if prices include duties and / or taxes.

status

•MarketStatus!

non-null

Status of the market. Replaces the enabled field.

type

•MarketType!

non-null

The type of the market.

webPresences

non-null

The market’s web presences, which defines its SEO strategy. This can be a different domain, subdomain, or subfolders of the primary domain. Each web presence comprises one or more language variants. If a market doesn't have any web presences, then the market is accessible on the primary market's domains using country selectors.

enabled

•MetafieldDefinitionConnection!

non-nullDeprecated

metafieldDefinitions

non-nullDeprecated

priceList

•PriceList

Deprecated

primary

non-nullDeprecated

regions

•MarketRegionConnection!

non-nullDeprecated

webPresence

•MarketWebPresence

Deprecated

Metaobject

•OBJECT

Provides an object instance represented by a MetaobjectDefinition.

Anchor to capabilitiescapabilities •MetaobjectCapabilityData! non-null: Metaobject capabilities for this Metaobject.
Anchor to createdAtcreatedAt •DateTime! non-null: When the object was created.
Anchor to createdBycreatedBy •App! non-null: The app used to create the object.
Anchor to createdByAppcreatedByApp •App! non-null: The app used to create the object.
Anchor to createdByStaffcreatedByStaff •StaffMember: The staff member who created the metaobject.
Anchor to definitiondefinition •MetaobjectDefinition! non-null: The MetaobjectDefinition that models this object type.
Anchor to displayNamedisplayName •String! non-null: The preferred display name field value of the metaobject.
Anchor to fieldfield •MetaobjectField: The field for an object key, or null if the key has no field definition.
Anchor to fieldsfields •[MetaobjectField!]! non-null: All ordered fields of the metaobject with their definitions and values.
Anchor to handlehandle •String! non-null: The unique handle of the object, useful as a custom ID.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to referencedByreferencedBy •MetafieldRelationConnection! non-null: List of back references metafields that belong to the resource.
Anchor to thumbnailFieldthumbnailField •MetaobjectField: The recommended field to visually represent this metaobject. May be a file reference or color field.
Anchor to typetype •String! non-null: The type of the metaobject.
Anchor to updatedAtupdatedAt •DateTime! non-null: When the object was last updated.
Anchor to appapp •App! non-nullDeprecated
Anchor to staffMemberstaffMember •StaffMember Deprecated

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.

additionalFees

•[AdditionalFee!]!

non-null

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

agreements

•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.

alerts

•[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.

app

•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.

billingAddress

•MailingAddress

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.

billingAddressMatchesShippingAddress

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.

cancellation

•OrderCancellation

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

cancelledAt

•DateTime

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

cancelReason

•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.

canMarkAsPaid

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.

canNotifyCustomer

non-null

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

capturable

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.

cartDiscountAmountSet

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.

channelInformation

•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.

clientIp

•String

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

closed

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.

closedAt

•DateTime

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.

confirmationNumber

•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.

confirmed

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.

createdAt

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.

currencyCode

•CurrencyCode!

non-null

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

currentCartDiscountAmountSet

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.

currentShippingPriceSet

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.

currentSubtotalLineItemsQuantity

•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.

currentSubtotalPriceSet

non-null

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

currentTaxLines

•[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.

currentTotalAdditionalFeesSet

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.

currentTotalDiscountsSet

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.

currentTotalDutiesSet

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

currentTotalPriceSet

non-null

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

currentTotalTaxSet

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.

currentTotalWeight

•UnsignedInt64!

non-null

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

customAttributes

•[Attribute!]!

non-null

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

customer

•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.

customerAcceptsMarketing

•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.

customerJourneySummary

•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.

customerLocale

•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.

discountApplications

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.

discountCode

•String

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

discountCodes

•[String!]!

non-null

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

displayAddress

•MailingAddress

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.

displayFinancialStatus

•OrderDisplayFinancialStatus

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

displayFulfillmentStatus

•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.

displayRefundStatus

•OrderDisplayRefundStatus

The status of the refund(s) that can be shown to the merchant. Mostly used when a refund is in a deferred state (for example, it was not yet sent to the payments provider).

disputes

•[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.

dutiesIncluded

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.

edited

non-null

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

•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.

estimatedTaxes

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.

events

•EventConnection!

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.

fulfillable

•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.

fulfillmentOrders

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.

fulfillments

•[Fulfillment!]!

non-null

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

fulfillmentsCount

•Count

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

fullyPaid

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.

hasTimelineComment

non-null

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

•ID!

non-null

A globally-unique ID.

incotermInformation

•IncotermInformation

Information about the incoterm used for the order.

legacyResourceId

•UnsignedInt64!

non-null

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

lineItems

•LineItemConnection!

non-null

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

localizedFields

•LocalizedFieldConnection!

non-null

List of localized fields for the resource.

merchantBusinessEntity

•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.

merchantEditable

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.

merchantEditableErrors

•[String!]!

non-null

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

merchantOfRecordApp

•OrderApp

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

metafield

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

metafields

non-null

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

metafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

name

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.

netPaymentSet

non-null

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

nonFulfillableLineItems

•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.

note

•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.

number

•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.

originalTotalAdditionalFeesSet

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.

originalTotalDutiesSet

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.

originalTotalPriceSet

•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.

paymentCollectionDetails

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.

paymentGatewayNames

•[String!]!

non-null

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

paymentTerms

•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.

phone

•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.

poNumber

•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.

presentmentCurrencyCode

•CurrencyCode!

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.

processedAt

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.

publication

•Publication

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

purchasingEntity

•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.

refundable

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.

refundDiscrepancySet

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.

refunds

•[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.

registeredSourceUrl

•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.

requiresShipping

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.

restockable

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.

retailLocation

•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.

returns

•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.

returnStatus

•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.

risk

•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.

shippingAddress

•MailingAddress

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.

shippingLine

•ShippingLine

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

shippingLines

•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.

shopifyProtect

•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.

sourceIdentifier

•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.

sourceName

•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.

staffMember

•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.

statusPageUrl

•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.

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.

subtotalLineItemsQuantity

•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.

subtotalPriceSet