Skip to main content
interface

Represents an object that has a list of events.

•EventConnection!
non-null

The paginated list of events associated with the host subject.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to ArticleArticle
•OBJECT

An article in the blogging system.

•ArticleAuthor

The name of the author of the article.

•Blog!
non-null

The blog containing the article.

•HTML!
non-null

The text of the article's body, complete with HTML markup.

•CommentConnection!
non-null

List of the article's comments.

•Count

Count of comments. Limited to a maximum of 10000 by default.

•DateTime!
non-null

The date and time (ISO 8601 format) when the article was created.

•String!
non-null

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

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String!
non-null

A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

•ID!
non-null

A globally-unique ID.

•Image

The image associated with the article.

•Boolean!
non-null

Whether or not the article is visible.

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

•MetafieldConnection!
non-null

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

•DateTime

The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.

•HTML

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

•[String!]!
non-null

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

•String

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

•String!
non-null

The title of the article.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime

The date and time (ISO 8601 format) when the article was last updated.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.

•ArticleConnection!
non-null

List of the blog's articles.

•Count

Count of articles. Limited to a maximum of 10000 by default.

•CommentPolicy!
non-null

Indicates whether readers can post comments to the blog and if comments are moderated or not.

•DateTime!
non-null

The date and time when the blog was created.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•BlogFeed

FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.

•String!
non-null

A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog.

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

•MetafieldConnection!
non-null

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

•[String!]!
non-null

A list of tags associated with the 200 most recent blog articles.

•String

The name of the template a blog is using if it's using an alternate template. Returns null if a blog is using the default blog.liquid template.

•String!
non-null

The title of the blog.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime

The date and time when the blog was update.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.

There are two types of collections:

The Collection object provides information to:

  • Organize products by category, season, or promotion.
  • Automate product grouping using rules (for example, by tag, type, or price).
  • Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).
  • Manage collection visibility and publication across sales channels.
  • Add rich descriptions, images, and metadata to enhance discovery.

Note

Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.


Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.

Learn about using metafields with smart collections.

Anchor to availablePublicationsCountavailablePublicationsCount
•Count

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

•String!
non-null

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

Arguments

•Int

Truncates a string after the given length.


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

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•ResourceFeedback

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

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

•Boolean!
non-null

Whether the collection includes the specified product.

Arguments

•ID!
required

The ID of the product to check.


•ID!
non-null

A globally-unique ID.

•Image

The image associated with the collection.

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

•MetafieldConnection!
non-null

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

•ProductConnection!
non-null

The products that are included in the collection.

•Count

The number of products in the collection.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication
•Boolean!
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.

Anchor to publishedOnPublicationpublishedOnPublication
•Boolean!
non-null

Whether the resource is published to a specified publication.

Arguments

•ID!
required

The ID of the publication to check. For example, id: "gid://shopify/Publication/123".


Anchor to resourcePublicationsresourcePublications
•ResourcePublicationConnection!
non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount
•Count

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

Anchor to resourcePublicationsV2resourcePublicationsV2
•ResourcePublicationV2Connection!
non-null

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

•CollectionRuleSet

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

•SEO!
non-null

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

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

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

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

•[Translation!]!
non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications
•PublicationConnection!
non-null

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

•DateTime!
non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•Int!
non-nullDeprecated

Arguments

•Boolean
Default:true

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.


•CollectionPublicationConnection!
non-nullDeprecated
•Boolean!
non-nullDeprecated

Arguments

•ID!
required

The ID of the channel to check.


Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel
•Boolean!
non-nullDeprecated
•StorefrontID!
non-nullDeprecated
•ChannelConnection!
non-nullDeprecated
•OBJECT

A comment on an article.

•Article

The article associated with the comment.

•CommentAuthor!
non-null

The comment’s author.

•String!
non-null

The content of the comment.

•HTML!
non-null

The content of the comment, complete with HTML formatting.

•DateTime!
non-null

The date and time when the comment was created.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•ID!
non-null

A globally-unique ID.

•String

The IP address of the commenter.

•Boolean!
non-null

Whether or not the comment is published.

•DateTime

The date and time when the comment was published.

•CommentStatus!
non-null

The status of the comment.

•DateTime

The date and time when the comment was last updated.

•String

The user agent of the commenter.

•OBJECT

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

•CompanyContactRoleConnection!
non-null

The list of roles for the company contacts.

•CompanyContactConnection!
non-null

The list of contacts in the company.

•Count

The number of contacts that belong to the company.

•DateTime!
non-null

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

•DateTime!
non-null

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

•String!
non-null

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

•CompanyContactRole

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

•DraftOrderConnection!
non-null

The list of the company's draft orders.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String

A unique externally-supplied ID for the company.

•Boolean!
non-null

Whether the merchant added a timeline comment to the company.

•ID!
non-null

A globally-unique ID.

•String!
non-null

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

•CompanyLocationConnection!
non-null

The list of locations in the company.

•Count

The number of locations that belong to the company.

•CompanyContact

The main contact for the company.

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

•MetafieldConnection!
non-null

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

•String!
non-null

The name of the company.

•String

A note about the company.

•OrderConnection!
non-null

The list of the company's orders.

•Count

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

•MoneyV2!
non-null

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

•DateTime!
non-null

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

•Int!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•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.

•CompanyAddress

The address used as billing address for the location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration
•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

•CatalogConnection!
non-null

The list of catalogs associated with the company location.

•Count

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

•Company!
non-null

The company that the company location belongs to.

•DateTime!
non-null

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

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

•String!
non-null

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

•DraftOrderConnection!
non-null

The list of draft orders for the company location.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String

A unique externally-supplied ID for the company location.

•Boolean!
non-null

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

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether the company location is assigned a specific catalog.

Arguments

•ID!
required

The ID of the catalog.


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

•MetafieldConnection!
non-null

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

•String!
non-null

The name of the company location.

•String

A note about the company location.

•OrderConnection!
non-null

The list of orders for the company location.

•Count

The total number of orders placed for the location.

•String

The phone number of the company location.

•CompanyContactRoleAssignmentConnection!
non-null

The list of roles assigned to the company location.

•CompanyAddress

The address used as shipping address for the location.

Anchor to staffMemberAssignmentsstaffMemberAssignments
•CompanyLocationStaffMemberAssignmentConnection!
non-null

The list of staff members assigned to the company location.

•CompanyLocationTaxSettings!
non-null

The tax settings for the company location.

•MoneyV2!
non-null

The total amount spent by the location.

•DateTime!
non-null

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

•Market!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•Int!
non-nullDeprecated
•[TaxExemption!]!
non-nullDeprecated
•String
Deprecated
•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.

•[MailingAddress!]!
non-null

A list of addresses associated with the customer.

•MailingAddressConnection!
non-null

The addresses associated with the customer.

•MoneyV2!
non-null

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

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

•DateTime!
non-null

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

•Boolean!
non-null

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

•MailingAddress

The default address associated with the customer.

•CustomerEmailAddress

The customer's default email address.

•CustomerPhoneNumber

The customer's default phone number.

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

•EventConnection!
non-null

A list of events associated with the customer.

•String

The customer's first name.

•ID!
non-null

A globally-unique ID.

•Image!
non-null

The image associated with the customer.

•String

The customer's last name.

•Order

The customer's last order.

•UnsignedInt64!
non-null

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

•String!
non-null

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

Example: 'about 12 years'.

•String!
non-null

The customer's locale.

•CustomerMergeable!
non-null

Whether the customer can be merged with another customer.

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

•MetafieldConnection!
non-null

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

•String

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

•String

A note about the customer.

•UnsignedInt64!
non-null

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

•OrderConnection!
non-null

A list of the customer's orders.

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

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

•CustomerStatistics!
non-null

The statistics for a given customer.

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

•[String!]!
non-null

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

•Boolean!
non-null

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

•[TaxExemption!]!
non-null

The list of tax exemptions applied to the customer.

•DateTime!
non-null

The date and time when the customer was last updated.

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

•String
Deprecated
Anchor to emailMarketingConsentemailMarketingConsent
•CustomerEmailMarketingConsentState
Deprecated
•Boolean!
non-nullDeprecated
•Market
Deprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•String
Deprecated
•CustomerSmsMarketingConsentState
Deprecated
•URL!
non-nullDeprecated
•Boolean!
non-nullDeprecated
•OBJECT

The DiscountAutomaticBxgy object lets you manage buy X get Y discounts (BXGY) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.

The DiscountAutomaticBxgy object stores information about automatic BXGY discounts that apply to specific products and variants, collections, or all items in a cart.

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


Note

The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.


•Int!
non-null

The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.

•DiscountCombinesWith!
non-null

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

•DateTime!
non-null

The date and time when the discount was created.

•DiscountCustomerBuys!
non-null

The items eligible for the discount and the required quantity of each to receive the discount.

•DiscountCustomerGets!
non-null

The items in the order that qualify for the discount, their quantities, and the total value of the discount.

•[DiscountClass!]!
non-null

The classes of the discount.

•DateTime

The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify null.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•DateTime!
non-null

The date and time when the discount becomes active and is available to customers.

•DiscountStatus!
non-null

The status of the discount that describes its availability, expiration, or pending activation.

•String!
non-null

A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.

•String!
non-null

The discount's name that displays to merchants in the Shopify admin and to customers.

•DateTime!
non-null

The date and time when the discount was updated.

•Int

The maximum number of times that the discount can be applied to an order.

•MerchandiseDiscountClass!
non-nullDeprecated
•ID!
non-nullDeprecated
•Int!
non-nullDeprecated
•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.

•DiscountAutomatic!
non-null

A discount that's applied automatically when an order meets specific criteria. Learn more about automatic discounts.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

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

•MetafieldConnection!
non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•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.

•DiscountCode!
non-null

The underlying code discount object.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

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

•MetafieldConnection!
non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•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.

•Discount!
non-null

A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

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

•MetafieldConnection!
non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
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
•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 anyVariantPricesOverriddenanyVariantPricesOverridden
•Boolean!
non-null

Whether any variant prices have been overridden.

•DraftOrderAppliedDiscount

The custom order-level discount applied.

•MailingAddress

The billing address of the customer.

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress
•Boolean!
non-null

Whether the billing address matches the shipping address.

•DateTime

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

•DateTime!
non-null

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

•CurrencyCode!
non-null

The shop currency used for calculation.

•[Attribute!]!
non-null

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

•Customer

The customer who will be sent an invoice.

•String!
non-null

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

•[String!]!
non-null

All discount codes applied.

•String

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

•EventConnection!
non-null

The list of events associated with the draft order.

•Boolean!
non-null

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

•ID!
non-null

A globally-unique ID.

Anchor to invoiceEmailTemplateSubjectinvoiceEmailTemplateSubject
•String!
non-null

The subject defined for the draft invoice email template.

•DateTime

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

•URL

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

•UnsignedInt64!
non-null

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

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

•LocalizedFieldConnection!
non-null

List of localized fields for the resource.

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

•MetafieldConnection!
non-null

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

•String!
non-null

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

•String

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

•Order

The order that was created from the draft order.

•PaymentTerms

The associated payment terms for this draft order.

•String

The assigned phone number.

•[DraftOrderPlatformDiscount!]!
non-null

The list of platform discounts applied.

•String

The purchase order number.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode
•CurrencyCode!
non-null

The payment currency used for calculation.

•PurchasingEntity

The purchasing entity.

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

•MailingAddress

The shipping address of the customer.

•ShippingLine

The line item containing the shipping information and costs.

•DraftOrderStatus!
non-null

The status of the draft order.

•MoneyBag!
non-null

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

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

•Boolean!
non-null

Whether the line item prices include taxes.

•Boolean!
non-null

Whether the draft order is tax exempt.

•[TaxLine!]!
non-null

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

•MoneyBag!
non-null

Total discounts.

Anchor to totalLineItemsPriceSettotalLineItemsPriceSet
•MoneyBag!
non-null

Total price of line items.

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

•MoneyBag!
non-null

The total tax.

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

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

•Boolean!
non-null

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

•[DraftOrderWarning!]!
non-null

The list of warnings raised while calculating.

Anchor to localizationExtensionslocalizationExtensions
•LocalizationExtensionConnection!
non-nullDeprecated
•String!
non-nullDeprecated
Anchor to marketRegionCountryCodemarketRegionCountryCode
•CountryCode!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•OBJECT

Represents the intention to move inventory between locations.

•DateTime

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

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

•EventConnection!
non-null

The list of events associated with the inventory transfer.

•Boolean!
non-null

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

•ID!
non-null

A globally-unique ID.

•InventoryTransferLineItemConnection!
non-null

The line items associated with the inventory transfer.

•Count

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

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

•MetafieldConnection!
non-null

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

•String!
non-null

The name of the inventory transfer.

•String

Additional note attached to the inventory transfer.

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

•Int!
non-null

The total quantity of items received in the transfer.

•String

The reference name of the inventory transfer.

•InventoryShipmentConnection!
non-null

The shipments associated with the inventory transfer.

•InventoryTransferStatus!
non-null

The current status of the transfer.

•[String!]!
non-null

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

•Int!
non-null

The total quantity of items being transferred.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•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.

•[AdditionalFee!]!
non-null

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

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

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

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

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

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress
•Boolean!
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.

•OrderCancellation

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

•DateTime

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

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

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

•Boolean!
non-null

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

•Boolean!
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
•MoneyBag

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

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

•String

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

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

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

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

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

•DateTime!
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!
non-null

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

Anchor to currentCartDiscountAmountSetcurrentCartDiscountAmountSet
•MoneyBag!
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
•MoneyBag!
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
•MoneyBag!
non-null

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

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

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
•MoneyBag!
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
•MoneyBag

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

Anchor to currentTotalPriceSetcurrentTotalPriceSet
•MoneyBag!
non-null

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

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

•UnsignedInt64!
non-null

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

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

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

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

•String

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

•[String!]!
non-null

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

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

Anchor to displayFinancialStatusdisplayFinancialStatus
•OrderDisplayFinancialStatus

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.

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

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

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

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

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

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

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

•[Fulfillment!]!
non-null

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

•Count

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

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

•Boolean!
non-null

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

•ID!
non-null

A globally-unique ID.

•UnsignedInt64!
non-null

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

•LineItemConnection!
non-null

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

•LocalizedFieldConnection!
non-null

List of localized fields for the resource.

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.

•Boolean!
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
•[String!]!
non-null

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

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

•MetafieldConnection!
non-null

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

•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. Use this field to identify orders in the Shopify admin and for order tracking.

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

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

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

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

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
•MoneyBag!
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
•OrderPaymentCollectionDetails!
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.

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

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.

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

•DateTime!
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

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

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

•Boolean!
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
•MoneyBag!
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.

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

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

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

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

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

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

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

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

•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

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

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

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

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

•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

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.

•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

•Audience

Specifies the intended audience for the status page URL.

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

•MoneyBag

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.

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

•[String!]!
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.

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

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

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

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

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

•MoneyBag

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

•MoneyBag!
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).

•MoneyBag!
non-null

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

•MoneyBag!
non-null

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

•MoneyBag!
non-null

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

Anchor to totalRefundedShippingSettotalRefundedShippingSet
•MoneyBag!
non-null

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

Anchor to totalShippingPriceSettotalShippingPriceSet
•MoneyBag!
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.

•MoneyBag

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

•MoneyBag!
non-null

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

•UnsignedInt64

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

•[OrderTransaction!]!
non-null

A list of transactions associated with the order.

•Count

The number of transactions associated with the order.

•Boolean!
non-null

Whether no payments have been made for the order.

•DateTime!
non-null

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

•Money
Deprecated
•Channel
Deprecated
•CustomerJourney
Deprecated
Anchor to landingPageDisplayTextlandingPageDisplayText
•String
Deprecated
•URL
Deprecated
Anchor to localizationExtensionslocalizationExtensions
•LocalizationExtensionConnection!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•Money!
non-nullDeprecated
•Location
Deprecated
•String
Deprecated
•String
Deprecated
•URL
Deprecated
•OrderRiskLevel!
non-nullDeprecated
•[OrderRisk!]!
non-nullDeprecated
•Money
Deprecated
•Money!
non-nullDeprecated
•Money
Deprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money!
non-nullDeprecated
•Money
Deprecated
•MoneyV2!
non-nullDeprecated
•OBJECT

A page on the Online Store.

•HTML!
non-null

The text content of the page, complete with HTML markup.

•String!
non-null

The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.

•DateTime!
non-null

The date and time (ISO 8601 format) of the page creation.

•String!
non-null

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

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String!
non-null

A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether or not the page is visible.

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

•MetafieldConnection!
non-null

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

•DateTime

The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.

•String

The suffix of the template that's used to render the page.

•String!
non-null

Title of the page.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime!
non-null

The date and time (ISO 8601 format) of the latest page update.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

We recommend using the types and queries detailed at Getting started with discounts instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.

•Int

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

•PriceRuleAllocationMethod!
non-null

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

•App

The application that created the price rule.

•DiscountCombinesWith!
non-null

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

•DateTime!
non-null

The date and time when the price rule was created.

•PriceRuleCustomerSelection!
non-null

The customers that can use this price rule.

•[DiscountClass!]!
non-null

The classes of the discount.

•PriceRuleDiscountCodeConnection!
non-null

List of the price rule's discount codes.

•Count

How many discount codes associated with the price rule.

•DateTime

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

•EventConnection!
non-null

The paginated list of events associated with the price rule.

•[PriceRuleFeature!]!
non-null

A list of the price rule's features.

•Boolean!
non-null

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

•ID!
non-null

A globally-unique ID.

•PriceRuleItemEntitlements!
non-null

The items to which the price rule applies.

•PriceRuleLineItemPrerequisites!
non-null

The items required for the price rule to be applicable.

•UnsignedInt64!
non-null

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

•Boolean!
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
•PriceRulePrerequisiteToEntitlementQuantityRatio

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

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

•DateTime!
non-null

The date and time when the price rule starts.

•PriceRuleStatus!
non-null

The status of the price rule.

•String

A detailed summary of the price rule.

•PriceRuleTarget!
non-null

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

•String!
non-null

The title of the price rule.

•MoneyV2

The total sales from orders where the price rule was used.

•Int!
non-null

The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.

•Int

The maximum number of times that the price rule can be used in total.

•PriceRuleValidityPeriod!
non-null

A time period during which a price rule is applicable.

•PricingValue!
non-null

The value of the price rule.

•DiscountClass!
non-nullDeprecated
Anchor to entitlementToPrerequisiteQuantityRatioentitlementToPrerequisiteQuantityRatio
•PriceRuleEntitlementToPrerequisiteQuantityRatio
Deprecated
•[PriceRuleTrait!]!
non-nullDeprecated
•PriceRuleValue!
non-nullDeprecated
•OBJECT

The Product object lets you manage products in a merchant’s store.

Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.

Learn more about working with Shopify's product model, including limitations and considerations.

Anchor to availablePublicationsCountavailablePublicationsCount
•Count

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

•ProductBundleComponentConnection!
non-null

A list of components that are associated with a product in a bundle.

•TaxonomyCategory

The category of a product from Shopify's Standard Product Taxonomy.

•CollectionConnection!
non-null

A list of collections that include the product.

•CombinedListing

A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.

•CombinedListingsRole

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.

•ProductCompareAtPriceRange

The compare-at price range of the product in the shop's default currency.

•ProductContextualPricing!
non-null

The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. Only active markets are considered in the price resolution.

•DateTime!
non-null

The date and time when the product was created.

•String!
non-null

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

•String!
non-null

A single-line description of the product, with HTML tags removed.

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•Media

The featured media associated with the product.

•ResourceFeedback

The information that lets merchants know what steps they need to take to make sure that the app is set up correctly.

For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product".

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix
•String

The theme template that's used when customers view the gift card in a store.

•String!
non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but no spaces. The handle is used in the online store URL for the product.

Anchor to hasOnlyDefaultVarianthasOnlyDefaultVariant
•Boolean!
non-null

Whether the product has only a single variant with the default option and value.

Anchor to hasOutOfStockVariantshasOutOfStockVariants
•Boolean!
non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents
•Boolean!
non-null

Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether the product is in a specified collection.

Arguments

•ID!
required

The ID of the collection to check. For example, id: "gid://shopify/Collection/123".


•Boolean!
non-null

Whether the product is a gift card.

•UnsignedInt64!
non-null

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

•MediaConnection!
non-null

The media associated with the product. Valid media are images, 3D models, videos.

•Count

The total count of media that's associated with a product.

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

•MetafieldConnection!
non-null

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

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl
•URL

The preview URL for the online store.

•URL

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

•[ProductOption!]!
non-null

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

•ProductPriceRangeV2!
non-null

The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.

•ProductComponentTypeConnection!
non-null

A list of products that contain at least one variant associated with at least one of the current products' variants via group relationship.

Anchor to productComponentsCountproductComponentsCount
•Count

A count of unique products that contain at least one variant associated with at least one of the current products' variants via group relationship.

•ProductConnection!
non-null

A list of products that has a variant that contains any of this product's variants as a component.

•String!
non-null

The product type that merchants define.

•DateTime

The date and time when the product was published to the online store.

•Boolean!
non-null

Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.

Arguments

•ContextualPublicationContext!
required

The context used to determine publication status.


Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication
•Boolean!
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.

Anchor to publishedOnPublicationpublishedOnPublication
•Boolean!
non-null

Whether the resource is published to a specified publication.

Arguments

•ID!
required

The ID of the publication to check. For example, id: "gid://shopify/Publication/123".


•Boolean!
non-null

Whether the product can only be purchased with a selling plan. Products that are sold on subscription (requiresSellingPlan: true) can be updated only for online stores. If you update a product to be subscription-only (requiresSellingPlan:false), then the product is unpublished from all channels, except the online store.

Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication
•ResourcePublicationV2

The resource that's either published or staged to be published to the publication.

Anchor to resourcePublicationsresourcePublications
•ResourcePublicationConnection!
non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount
•Count

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

Anchor to resourcePublicationsV2resourcePublicationsV2
•ResourcePublicationV2Connection!
non-null

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

Anchor to restrictedForResourcerestrictedForResource
•RestrictedForResource

Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.

•SellingPlanGroupConnection!
non-null

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount
•Count

A count of selling plan groups that are associated with the product.

•SEO!
non-null

The SEO title and description that are associated with a product.

•ProductStatus!
non-null

The product status, which controls visibility across all sales channels.

•[String!]!
non-null

A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the sports and summer tags to products that are associated with sportwear for summer.

Updating tags overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the tagsAdd mutation.

•String

The theme template that's used when customers view the product in a store.

•String!
non-null

The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

•Int!
non-null

The quantity of inventory that's in stock.

•Boolean!
non-null

Whether inventory tracking has been enabled for the product.

•[Translation!]!
non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications
•PublicationConnection!
non-null

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

•DateTime!
non-null

The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

•ProductVariantConnection!
non-null

A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2000 variants.

•Count

The number of variants that are associated with the product.

•String!
non-null

The name of the product's vendor.

•String
Deprecated
•String
Deprecated
Anchor to descriptionPlainSummarydescriptionPlainSummary
•String!
non-nullDeprecated
•Image
Deprecated
•ImageConnection!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•ProductPriceRange!
non-nullDeprecated
•ProductCategory
Deprecated
•ProductPublicationConnection!
non-nullDeprecated
•Int!
non-nullDeprecated

Arguments

•Boolean
Default:true

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.


•ProductPublicationConnection!
non-nullDeprecated
•Boolean!
non-nullDeprecated

Arguments

•ID!
required

The ID of the channel to check.


Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel
•Boolean!
non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount
•Int!
non-nullDeprecated
Anchor to standardizedProductTypestandardizedProductType
•StandardizedProductType
Deprecated
•StorefrontID!
non-nullDeprecated
•Int!
non-nullDeprecated
•ChannelConnection!
non-nullDeprecated
•OBJECT

The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

  • Tracking inventory for each variant
  • Setting unique prices for each variant
  • Assigning barcodes and SKUs to connect variants to fulfillment services
  • Attaching variant-specific images and media
  • Setting delivery and tax requirements
  • Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

Learn more about Shopify's product model.

•Boolean!
non-null

Whether the product variant is available for sale.

•String

The value of the barcode associated with the product.

•Money

The compare-at price of the variant in the default shop currency.

•ProductVariantContextualPricing!
non-null

The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution.

•DateTime!
non-null

The date and time when the variant was created.

•String!
non-null

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

•DeliveryProfile

The delivery profile for the variant.

•String!
non-null

Display name of the variant, based on product's title + variant's title.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•ID!
non-null

A globally-unique ID.

•Image

The featured image for the variant.

•InventoryItem!
non-null

The inventory item, which is used to query for inventory information.

•ProductVariantInventoryPolicy!
non-null

Whether customers are allowed to place an order for the product variant when it's out of stock.

•Int

The total sellable quantity of the variant.

•UnsignedInt64!
non-null

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

•MediaConnection!
non-null

The media associated with the product variant.

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

•MetafieldConnection!
non-null

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

•Int!
non-null

The order of the product variant in the list of product variants. The first position in the list is 1.

•Money!
non-null

The price of the product variant in the default shop currency.

•Product!
non-null

The product that this variant belongs to.

•ProductConnection!
non-null

A list of products that have product variants that contain this variant as a product component.

Anchor to productVariantComponentsproductVariantComponents
•ProductVariantComponentConnection!
non-null

A list of the product variant components.

•Boolean!
non-null

Whether a product variant requires components. The default value is false. If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.

•[SelectedOption!]!
non-null

List of product options applied to the variant.

Anchor to sellableOnlineQuantitysellableOnlineQuantity
•Int!
non-null

The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.

•SellingPlanGroupConnection!
non-null

A list of all selling plan groups defined in the current shop associated with the product variant.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount
•Count

Count of selling plan groups associated with the product variant.

•Boolean!
non-null

Whether to show the unit price for this product variant.

•String

A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.

•Boolean!
non-null

Whether a tax is charged when the product variant is sold.

•String!
non-null

The title of the product variant.

•[Translation!]!
non-null

The published translations associated with the resource.

•MoneyV2

The unit price value for the variant based on the variant measurement.

Anchor to unitPriceMeasurementunitPriceMeasurement
•UnitPriceMeasurement

The unit price measurement for the variant.

•DateTime!
non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•ProductVariantPricePairConnection!
non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount
•Int!
non-nullDeprecated
•StorefrontID!
non-nullDeprecated
•String
Deprecated

Was this section helpful?