Skip to main content
interface

An object with an ID field to support global identification, in accordance with the Relay specification. This interface is used by the node and nodes queries.

•ID!
non-null

A globally-unique ID.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

Details about the gift card used on the checkout.

•MoneyV2!
non-null

The amount that was taken from the gift card by applying it.

•MoneyV2!
non-null

The amount left on the gift card.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The last characters of the gift card.

Anchor to presentmentAmountUsedpresentmentAmountUsed
•MoneyV2!
non-null

The amount that was applied to the checkout in its currency.

•MoneyV2!
non-nullDeprecated
•MoneyV2!
non-nullDeprecated
Anchor to ArticleArticle
•OBJECT

An article in an online store blog.

•ArticleAuthor

The article's author.

•Blog!
non-null

The blog that the article belongs to.

•CommentConnection!
non-null

List of comments posted on the article.

•String!
non-null

Stripped content of the article, single line with HTML tags removed.

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The content of the article, complete with HTML formatting.

•String

Stripped excerpt of the article, single line with HTML tags removed.

Arguments

•Int

Truncates a string after the given length.


•HTML

The excerpt of the article, complete with HTML formatting.

•String!
non-null

A human-friendly unique string for the Article automatically generated from its title.

•ID!
non-null

A globally-unique ID.

•Image

The image associated with the article.

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

•[Metafield]!
non-null

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

•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

•DateTime!
non-null

The date and time when the article was published.

•SEO

The article’s SEO information.

•[String!]!
non-null

A categorization that a article can be tagged with.

•String!
non-null

The article’s name.

•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

•ArticleAuthor!
non-nullDeprecated
•OBJECT

An online store blog.

•Article

Find an article by its handle.

•ArticleConnection!
non-null

List of the blog's articles.

•[ArticleAuthor!]!
non-null

The authors who have contributed to the blog.

•String!
non-null

A human-friendly unique string for the Blog automatically generated from its title.

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

•[Metafield]!
non-null

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

•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

•SEO

The blog's SEO information.

•String!
non-null

The blogs’s title.

•OBJECT

A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. Learn how to interact with a cart during a customer's session.

•[AppliedGiftCard!]!
non-null

The gift cards that have been applied to the cart.

•Attribute

An attribute associated with the cart.

•[Attribute!]!
non-null

The attributes associated with the cart. Attributes are represented as key-value pairs.

•CartBuyerIdentity!
non-null

Information about the buyer that's interacting with the cart.

•URL!
non-null

The URL of the checkout for the cart.

•CartCost!
non-null

The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The cost field uses the buyerIdentity field to determine international pricing.

•DateTime!
non-null

The date and time when the cart was created.

•CartDelivery!
non-null

The delivery properties of the cart.

•CartDeliveryGroupConnection!
non-null

The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.

•[CartDiscountAllocation!]!
non-null

The discounts that have been applied to the entire cart.

•[CartDiscountCode!]!
non-null

The case-insensitive discount codes that the customer added at checkout.

•ID!
non-null

A globally-unique ID.

•BaseCartLineConnection!
non-null

A list of lines containing information about the items the customer intends to purchase.

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

•[Metafield]!
non-null

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

•String

A note that's associated with the cart. For example, the note can be a personalized message to the buyer.

•Int!
non-null

The total number of items in the cart.

•DateTime!
non-null

The date and time when the cart was updated.

•CartEstimatedCost!
non-nullDeprecated
•OBJECT

Represents information about the merchandise in the cart.

•Attribute

An attribute associated with the cart line.

•[Attribute!]!
non-null

The attributes associated with the cart line. Attributes are represented as key-value pairs.

•CartLineCost!
non-null

The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.

•[CartDiscountAllocation!]!
non-null

The discounts that have been applied to the cart line.

•ID!
non-null

A globally-unique ID.

•Merchandise!
non-null

The merchandise that the buyer intends to purchase.

•Int!
non-null

The quantity of the merchandise that the customer intends to purchase.

Anchor to sellingPlanAllocationsellingPlanAllocation
•SellingPlanAllocation

The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.

•CartLineEstimatedCost!
non-nullDeprecated
•OBJECT

A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.

•String!
non-null

Stripped description of the collection, single line with HTML tags removed.

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The description of the collection, complete with HTML formatting.

•String!
non-null

A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

•ID!
non-null

A globally-unique ID.

•Image

Image associated with the collection.

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

•[Metafield]!
non-null

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

•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

•ProductConnection!
non-null

List of products in the collection.

•SEO!
non-null

The collection's SEO information.

•String!
non-null

The collection’s name. Limit of 255 characters.

•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

•DateTime!
non-null

The date and time when the collection was last modified.

•OBJECT

A comment on an article.

•CommentAuthor!
non-null

The comment’s author.

•String!
non-null

Stripped content of the comment, single line with HTML tags removed.

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The content of the comment, complete with HTML formatting.

•ID!
non-null

A globally-unique ID.

•OBJECT

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

•DateTime!
non-null

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

•String

A unique externally-supplied ID for the company.

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

•[Metafield]!
non-null

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

•String!
non-null

The name of the company.

•DateTime!
non-null

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

•OBJECT

A company's main point of contact.

•DateTime!
non-null

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

•ID!
non-null

A globally-unique ID.

•String

The company contact's locale (language).

•String

The company contact's job title.

•DateTime!
non-null

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

•OBJECT

A company's location.

•DateTime!
non-null

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

•String

A unique externally-supplied ID for the company.

•ID!
non-null

A globally-unique ID.

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

•[Metafield]!
non-null

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

•String!
non-null

The name of the company location.

•DateTime!
non-null

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

•OBJECT

Represents information about the grouped merchandise in the cart.

•Attribute

An attribute associated with the cart line.

•[Attribute!]!
non-null

The attributes associated with the cart line. Attributes are represented as key-value pairs.

•CartLineCost!
non-null

The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.

•[CartDiscountAllocation!]!
non-null

The discounts that have been applied to the cart line.

•ID!
non-null

A globally-unique ID.

•[CartLine!]!
non-null

The components of the line item.

•Merchandise!
non-null

The merchandise that the buyer intends to purchase.

•Int!
non-null

The quantity of the merchandise that the customer intends to purchase.

Anchor to sellingPlanAllocationsellingPlanAllocation
•SellingPlanAllocation

The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.

•CartLineEstimatedCost!
non-nullDeprecated
•OBJECT

Represents a video hosted outside of Shopify.

•String

A word or phrase to share the nature or contents of a media.

•URL!
non-null

The embed URL of the video for the respective host.

•MediaHost!
non-null

The host of the external video.

•ID!
non-null

A globally-unique ID.

•MediaContentType!
non-null

The media content type.

•URL!
non-null

The origin URL of the video on the respective host.

•MediaPresentation

The presentation for a media.

•Image

The preview image for the media.

•URL!
non-nullDeprecated
•OBJECT

The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON.

•String

A word or phrase to indicate the contents of a file.

•ID!
non-null

A globally-unique ID.

•String

The MIME type of the file.

•Int

The size of the original file in bytes.

•Image

The preview image for the file.

•URL

The URL of the file.

•OBJECT

Represents a location where product inventory is held.

•LocationAddress!
non-null

The address of the location.

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

•[Metafield]!
non-null

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

•String!
non-null

The name of the location.

•OBJECT

Represents a mailing address for customers and shipping.

•String

The first line of the address. Typically the street address or PO Box number.

•String

The second line of the address. Typically the number of the apartment, suite, or unit.

•String

The name of the city, district, village, or town.

•String

The name of the customer's company or organization.

•String

The name of the country.

•CountryCode

The two-letter code for the country of the address.

For example, US.

•String

The first name of the customer.

•[String!]!
non-null

A formatted version of the address, customized by the provided arguments.

Arguments

•Boolean
Default:false

Whether to include the customer's name in the formatted address.

•Boolean
Default:true

Whether to include the customer's company in the formatted address.


•String

A comma-separated list of the values for city, province, and country.

•ID!
non-null

A globally-unique ID.

•String

The last name of the customer.

•Float

The latitude coordinate of the customer address.

•Float

The longitude coordinate of the customer address.

•String

The full name of the customer, based on firstName and lastName.

•String

A unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.

•String

The region of the address, such as the province, state, or district.

•String

The alphanumeric code for the region.

For example, ON.

•String

The zip or postal code of the address.

•String
Deprecated
•OBJECT

A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to the Shopify Markets conceptual overview.

•String!
non-null

A human-readable unique string for the market automatically generated from its title.

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

•[Metafield]!
non-null

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

•OBJECT

Represents a Shopify hosted image.

•String

A word or phrase to share the nature or contents of a media.

•ID!
non-null

A globally-unique ID.

•Image

The image for the media.

•MediaContentType!
non-null

The media content type.

•MediaPresentation

The presentation for a media.

•Image

The preview image for the media.

•OBJECT

A media presentation.

•JSON

A JSON object representing a presentation view.

Arguments

•MediaPresentationFormat!
required

The format to transform the settings.


•ID!
non-null

A globally-unique ID.

•OBJECT

A navigation menu representing a hierarchy of hyperlinks (items).

•String!
non-null

The menu's handle.

•ID!
non-null

A globally-unique ID.

•[MenuItem!]!
non-null

The menu's child items.

•Int!
non-null

The count of items on the menu.

•String!
non-null

The menu's title.

•OBJECT

A menu item within a parent menu.

•ID!
non-null

A globally-unique ID.

•[MenuItem!]!
non-null

The menu item's child items.

•MenuItemResource

The linked resource.

•ID

The ID of the linked resource.

•[String!]!
non-null

The menu item's tags to filter a collection.

•String!
non-null

The menu item's title.

•MenuItemType!
non-null

The menu item's type.

•URL

The menu item's URL.

•OBJECT

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

•DateTime!
non-null

The date and time when the storefront metafield was created.

•String

The description of a metafield.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The unique identifier for the metafield within its namespace.

•String!
non-null

The container for a group of metafields that the metafield is associated with.

•MetafieldParentResource!
non-null

The type of resource that the metafield is attached to.

•MetafieldReference

Returns a reference object if the metafield's type is a resource reference.

•MetafieldReferenceConnection

A list of reference objects if the metafield's type is a resource reference list.

•String!
non-null

The type name of the metafield. Refer to the list of supported types.

•DateTime!
non-null

The date and time when the metafield was last updated.

•String!
non-null

The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

•OBJECT

An instance of a user-defined model based on a MetaobjectDefinition.

•MetaobjectField

Accesses a field of the object by key.

•[MetaobjectField!]!
non-null

All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.

•String!
non-null

The unique handle of the metaobject. Useful as a custom ID.

•ID!
non-null

A globally-unique ID.

•URL

The URL used for viewing the metaobject on the shop's Online Store. Returns null if the metaobject definition doesn't have the online_store capability.

•MetaobjectSEO

The metaobject's SEO information. Returns null if the metaobject definition doesn't have the renderable capability.

•String!
non-null

The type of the metaobject. Defines the namespace of its associated metafields.

•DateTime!
non-null

The date and time when the metaobject was last updated.

•OBJECT

Represents a Shopify hosted 3D model.

•String

A word or phrase to share the nature or contents of a media.

•ID!
non-null

A globally-unique ID.

•MediaContentType!
non-null

The media content type.

•MediaPresentation

The presentation for a media.

•Image

The preview image for the media.

•[Model3dSource!]!
non-null

The sources for a 3d model.

•OBJECT

An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

•MailingAddress

The address associated with the payment method.

•DateTime

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

•OrderCancelReason

The reason for the order's cancellation. Returns null if the order wasn't canceled.

•CurrencyCode!
non-null

The code of the currency used for the payment.

Anchor to currentSubtotalPricecurrentSubtotalPrice
•MoneyV2!
non-null

The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.

•MoneyV2

The total cost of duties for the order, including refunds.

•MoneyV2!
non-null

The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.

Anchor to currentTotalShippingPricecurrentTotalShippingPrice
•MoneyV2!
non-null

The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.

•MoneyV2!
non-null

The total of all taxes applied to the order, excluding taxes for returned line items.

•[Attribute!]!
non-null

A list of the custom attributes added to the order. For example, whether an order is a customer's first.

•String

The locale code in which this specific order happened.

•URL

The unique URL that the customer can use to access the order.

Anchor to discountApplicationsdiscountApplications
•DiscountApplicationConnection!
non-null

Discounts that have been applied on the order.

•Boolean!
non-null

Whether the order has had any edits applied or not.

•String

The customer's email address.

•OrderFinancialStatus

The financial status of the order.

•OrderFulfillmentStatus!
non-null

The fulfillment status for the order.

•ID!
non-null

A globally-unique ID.

•OrderLineItemConnection!
non-null

List of the order’s line items.

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

•[Metafield]!
non-null

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

•String!
non-null

Unique identifier for the order that appears on the order. For example, #1000 or _Store1001.

•Int!
non-null

A unique numeric identifier for the order for use by shop owner and customer.

•MoneyV2

The total cost of duties charged at checkout.

•MoneyV2!
non-null

The total price of the order before any applied edits.

•String

The customer's phone number for receiving SMS notifications.

•DateTime!
non-null

The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.

•MailingAddress

The address to where the order will be shipped.

Anchor to shippingDiscountAllocationsshippingDiscountAllocations
•[DiscountAllocation!]!
non-null

The discounts that have been allocated onto the shipping line by discount applications.

•URL!
non-null

The unique URL for the order's status page.

•MoneyV2

Price of the order before shipping and taxes.

Anchor to successfulFulfillmentssuccessfulFulfillments
•[Fulfillment!]

List of the order’s successful fulfillments.

•MoneyV2!
non-null

The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

•MoneyV2!
non-null

The total amount that has been refunded.

•MoneyV2!
non-null

The total cost of shipping.

•MoneyV2

The total cost of taxes.

•MoneyV2
Deprecated
•MoneyV2!
non-nullDeprecated
•MoneyV2!
non-nullDeprecated
Anchor to totalShippingPriceV2totalShippingPriceV2
•MoneyV2!
non-nullDeprecated
•MoneyV2
Deprecated
•OBJECT

Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store.

•HTML!
non-null

The description of the page, complete with HTML formatting.

•String!
non-null

Summary of the page body.

•DateTime!
non-null

The timestamp of the page creation.

•String!
non-null

A human-friendly unique string for the page automatically generated from its title.

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

•[Metafield]!
non-null

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

•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

•SEO

The page's SEO information.

•String!
non-null

The title of the page.

•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

•DateTime!
non-null

The timestamp of the latest page update.

•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 products and collections.

•[ProductVariant!]!
non-null

A list of variants whose selected options differ with the provided selected options by one, ordered by variant id. If selected options are not provided, adjacent variants to the first available variant is returned.

Note that this field returns an array of variants. In most cases, the number of variants in this array will be low. However, with a low number of options and a high number of values per option, the number of variants returned here can be high. In such cases, it recommended to avoid using this field.

This list of variants can be used in combination with the options field to build a rich variant picker that includes variant availability or other variant information.

•Boolean!
non-null

Indicates if at least one product variant is available for sale.

•TaxonomyCategory

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

•CollectionConnection!
non-null

A list of collections that include the product.

•ProductPriceRange!
non-null

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

•DateTime!
non-null

The date and time when the product was created.

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

Anchor to encodedVariantAvailabilityencodedVariantAvailability
•String

An encoded string containing all option value combinations with a corresponding variant that is currently available for sale.

Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0

:, ,, and - are control characters. : indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2. , indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes. indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present. - indicates a continuous range of option values. ex: 0 1-3 4

Decoding process:

Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"

Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:

[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).

Anchor to encodedVariantExistenceencodedVariantExistence
•String

An encoded string containing all option value combinations with a corresponding variant.

Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0

:, ,, and - are control characters. : indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2. , indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes. indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present. - indicates a continuous range of option values. ex: 0 1-3 4

Decoding process:

Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"

Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:

[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).

•Image

The featured image for the product.

This field is functionally equivalent to images(first: 1).

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

•ID!
non-null

A globally-unique ID.

•ImageConnection!
non-null

List of images associated with the product.

•Boolean!
non-null

Whether the product is a gift card.

•MediaConnection!
non-null

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

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

•[Metafield]!
non-null

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

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

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

•String!
non-null

The product type that merchants define.

•DateTime!
non-null

The date and time when the product was published to the channel.

•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 selectedOrFirstAvailableVariantselectedOrFirstAvailableVariant
•ProductVariant

Find an active product variant based on selected options, availability or the first variant.

All arguments are optional. If no selected options are provided, the first available variant is returned. If no variants are available, the first variant is returned.

•SellingPlanGroupConnection!
non-null

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

•SEO!
non-null

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

•[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 GraphQL Admin API's tagsAdd mutation.

•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

The quantity of inventory that's in stock.

•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

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

Anchor to variantBySelectedOptionsvariantBySelectedOptions
•ProductVariant

Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

•ProductVariantConnection!
non-null

A list of variants that are associated with the product.

•Count

The number of variants that are associated with the product.

•String!
non-null

The name of the product's vendor.

•OBJECT

Product property names like "Size", "Color", and "Material" that the customers can select. Variants are selected based on permutations of these options. 255 characters limit each.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The product option’s name.

•[ProductOptionValue!]!
non-null

The corresponding option value to the product option.

•[String!]!
non-nullDeprecated
•OBJECT

The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option.

Anchor to firstSelectableVariantfirstSelectableVariant
•ProductVariant

The product variant that combines this option value with the lowest-position option values for all other options.

This field will always return a variant, provided a variant including this option value exists.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The name of the product option value.

•ProductOptionValueSwatch

The swatch of the product option value.

•OBJECT

A product variant represents a different version of a product, such as differing sizes or differing colors.

•Boolean!
non-null

Indicates if the product variant is available for sale.

•String

The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.

•MoneyV2

The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

•ProductVariantComponentConnection!
non-null

List of bundles components included in the variant considering only fixed bundles.

•Boolean!
non-null

Whether a product is out of stock but still available for purchase (used for backorders).

•ProductVariantConnection!
non-null

List of bundles that include this variant considering only fixed bundles.

•ID!
non-null

A globally-unique ID.

•Image

Image associated with the product variant. This field falls back to the product image if no image is available.

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

•[Metafield]!
non-null

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

•MoneyV2!
non-null

The product variant’s price.

•Product!
non-null

The product object that the product variant belongs to.

•Int

The total sellable quantity of the variant for online sales channels.

•QuantityPriceBreakConnection!
non-null

A list of quantity breaks for the product variant.

•QuantityRule!
non-null

The quantity rule for the product variant in a given context.

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

•Boolean!
non-null

Whether a customer needs to provide a shipping address when placing an order for the product variant.

•[SelectedOption!]!
non-null

List of product options applied to the variant.

Anchor to sellingPlanAllocationssellingPlanAllocations
•SellingPlanAllocationConnection!
non-null

Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

Anchor to shopPayInstallmentsPricingshopPayInstallmentsPricing
•ShopPayInstallmentsProductVariantPricing

The Shop Pay Installments pricing information for the product variant.

•String

The SKU (stock keeping unit) associated with the variant.

•StoreAvailabilityConnection!
non-null

The in-store pickup availability of this variant by location.

•Boolean!
non-null

Whether tax is charged when the product variant is sold.

•String!
non-null

The product variant’s title.

•MoneyV2

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

Anchor to unitPriceMeasurementunitPriceMeasurement
•UnitPriceMeasurement

The unit price measurement for the variant.

•Float

The weight of the product variant in the unit system specified with weight_unit.

•WeightUnit!
non-null

Unit of measurement for weight.

•MoneyV2
Deprecated
•MoneyV2!
non-nullDeprecated
•OBJECT

Shop represents a collection of the general settings and information about the shop.

•Brand

The shop's branding configuration.

•String

The URL for the customer account (only present if shop has a customer account vanity domain).

•String

A description of the shop.

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

•[Metafield]!
non-null

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

•String!
non-null

A string representing the way currency is formatted when the currency isn’t specified.

•String!
non-null

The shop’s name.

•PaymentSettings!
non-null

Settings related to payments.

•Domain!
non-null

The primary domain of the shop’s Online Store.

•ShopPolicy

The shop’s privacy policy.

•ShopPolicy

The shop’s refund policy.

•ShopPolicy

The shop’s shipping policy.

•[CountryCode!]!
non-null

Countries that the shop ships to.

Anchor to shopPayInstallmentsPricingshopPayInstallmentsPricing
•ShopPayInstallmentsPricing

The Shop Pay Installments pricing information for the shop.

•ShopPolicyWithDefault

The shop’s subscription policy.

•ShopPolicy

The shop’s terms of service.

•OBJECT

The financing plan in Shop Pay Installments.

•ID!
non-null

A globally-unique ID.

•MoneyV2!
non-null

The maximum price to qualify for the financing plan.

•MoneyV2!
non-null

The minimum price to qualify for the financing plan.

•[ShopPayInstallmentsFinancingPlanTerm!]!
non-null

The terms of the financing plan.

•OBJECT

The terms of the financing plan in Shop Pay Installments.

•Int!
non-null

The annual percentage rate (APR) of the financing plan.

•ShopPayInstallmentsFinancingPlanFrequency!
non-null

The payment frequency for the financing plan.

•ID!
non-null

A globally-unique ID.

•Count

The number of installments for the financing plan.

•ShopPayInstallmentsLoan!
non-null

The type of loan for the financing plan.

•OBJECT

The shop pay installments pricing information for a product variant.

•Boolean!
non-null

Whether the product variant is available.

•Boolean!
non-null

Whether the product variant is eligible for Shop Pay Installments.

•MoneyV2!
non-null

The full price of the product variant.

•ID!
non-null

The ID of the product variant.

•Count

The number of payment terms available for the product variant.

•MoneyV2!
non-null

The price per term for the product variant.

•OBJECT

Policy that a merchant has configured for their store, such as their refund or privacy policy.

•String!
non-null

Policy text, maximum size of 64kb.

•String!
non-null

Policy’s handle.

•ID!
non-null

A globally-unique ID.

•String!
non-null

Policy’s title.

•URL!
non-null

Public URL to the policy.

•OBJECT

The taxonomy category for the product.

•[TaxonomyCategory!]!
non-null

All parent nodes of the current taxonomy category.

•ID!
non-null

A static identifier for the taxonomy category.

•String!
non-null

The localized name of the taxonomy category.

•OBJECT

A redirect on the online store.

•ID!
non-null

The ID of the URL redirect.

•String!
non-null

The old path to be redirected from. When the user visits this path, they'll be redirected to the target location.

•String!
non-null

The target location where the user will be redirected to.

•OBJECT

Represents a Shopify hosted video.

•String

A word or phrase to share the nature or contents of a media.

•ID!
non-null

A globally-unique ID.

•MediaContentType!
non-null

The media content type.

•MediaPresentation

The presentation for a media.

•Image

The preview image for the media.

•[VideoSource!]!
non-null

The sources for a video.


Was this section helpful?