Has Published Translations
Published translations associated with the resource.
Anchor to FieldsFields
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
Anchor to Types implemented inTypes implemented in
- •OBJECT
An article in the blogging system.
- •Article
Author The name of the author of the article.
- Anchor to blogblog•Blog!non-null
The blog containing the article.
- Anchor to bodybody•HTML!non-null
The text of the article's body, complete with HTML markup.
- Anchor to commentscomments•Comment
Connection! non-null List of the article's comments.
- Anchor to commentsCountcomments•Count
Count Count of comments.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) when the article was created.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to handlehandle•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.
- Anchor to imageimage•Image
The image associated with the article.
- Anchor to isPublishedis•Boolean!
Published non-null Whether or not the article is visible.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to publishedAtpublished•Date
At Time The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.
- Anchor to summarysummary•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.
- Anchor to templateSuffixtemplate•String
Suffix 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 isnull
.- Anchor to titletitle•String!non-null
The title of the article.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time The date and time (ISO 8601 format) when the article was last updated.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •Article
- •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.
- Anchor to articlesarticles•Article
Connection! non-null List of the blog's articles.
- Anchor to articlesCountarticles•Count
Count Count of articles.
- Anchor to commentPolicycomment•Comment
Policy Policy! non-null Indicates whether readers can post comments to the blog and if comments are moderated or not.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the blog was created.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to feedfeed•Blog
Feed FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.
- Anchor to handlehandle•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.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! 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.
- Anchor to templateSuffixtemplate•String
Suffix 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.- Anchor to titletitle•String!non-null
The title of the blog.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time The date and time when the blog was update.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! 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:
- Custom (manual) collections: You specify the products to include in a collection.
- Smart (automated) collections: You define rules, and products matching those rules are automatically included in the collection.
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.
NoteCollections 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 availablePublicationsCountavailable•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to descriptiondescription•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.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to descriptionHtmldescription•HTML!
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.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to feedbackfeedback•Resource
Feedback Information about the collection that's provided through resource feedback.
- Anchor to handlehandle•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 handlesummer-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.
- Anchor to hasProducthas•Boolean!
Product non-null Whether the collection includes the specified product.
- •ID!required
The ID of the product to check.
Arguments
- •ID!
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the collection.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to productsproducts•Product
Connection! non-null The products that are included in the collection.
- Anchor to productsCountproducts•Count
Count The number of products in the collection.
- Anchor to publishedOnCurrentPublicationpublished•Boolean!
On Current Publication 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 publishedOnPublicationpublished•Boolean!
On Publication non-null Whether the resource is published to a specified publication.
- Anchor to publicationIdpublication•ID!
Id required The ID of the publication to check. For example,
.
Arguments
- Anchor to resourcePublicationsresource•Resource
Publications Publication Connection! non-null The list of resources that are published to a publication.
- Anchor to resourcePublicationsCountresource•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to resourcePublicationsV2resource•Resource
Publications V2 Publication V2Connection! non-null The list of resources that are either published or staged to be published to a publication.
- Anchor to ruleSetrule•Collection
Set Rule Set 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.
- Anchor to sortOrdersort•Collection
Order Sort Order! 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.
- Anchor to templateSuffixtemplate•String
Suffix 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 thecollection.custom.liquid
template. If the value isnull
, then the collection is using the defaultcollection.liquid
template.- Anchor to titletitle•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.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to unpublishedPublicationsunpublished•Publication
Publications Connection! non-null The list of publications that the resource isn't published to.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) when the collection was last modified.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to publicationCountpublication•Int!
Count non-nullDeprecated - Anchor to onlyPublishedonly•Boolean
Published Default:true Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
Arguments
- Anchor to publicationspublications•Collection
Publication Connection! non-nullDeprecated - Anchor to publishedOnChannelpublished•Boolean!
On Channel non-nullDeprecated - Anchor to channelIdchannel•ID!
Id required The ID of the channel to check.
Arguments
- Anchor to publishedOnCurrentChannelpublished•Boolean!
On Current Channel non-nullDeprecated - Anchor to storefrontIdstorefront•Storefront
Id ID! non-nullDeprecated - Anchor to unpublishedChannelsunpublished•Channel
Channels Connection! non-nullDeprecated
- •OBJECT
A shop's banner settings.
- Anchor to autoManagedauto•Boolean!
Managed non-null Indicates if the banner is auto managed.
- Anchor to enabledenabled•Boolean!non-null
Indicates if the banner is enabled.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- •OBJECT
A link to direct users to.
- Anchor to labellabel•String!non-null
A context-sensitive label for the link.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- •URL!non-null
The URL that the link visits.
- •OBJECT
A menu for display on the storefront.
- Anchor to handlehandle•String!non-null
The menu's handle.
- •ID!non-null
A globally-unique ID.
- Anchor to isDefaultis•Boolean!
Default non-null Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted.
- Anchor to itemsitems•[Menu
Item!]! non-null A list of items on the menu sorted by position.
- Anchor to titletitle•String!non-null
The menu's title.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- •OBJECT
A theme for display on the storefront.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the theme was created.
- Anchor to filesfiles•Online
Store Theme File Connection The files in the theme.
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The name of the theme, set by the merchant.
- Anchor to prefixprefix•String!non-null
The prefix of the theme.
- Anchor to processingprocessing•Boolean!non-null
Whether the theme is processing.
- Anchor to processingFailedprocessing•Boolean!
Failed non-null Whether the theme processing failed.
- Anchor to rolerole•Theme
Role! non-null The role of the theme.
- Anchor to themeStoreIdtheme•Int
Store Id The theme store ID.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the theme was last updated.
- •OBJECT
A page on the Online Store.
- Anchor to bodybody•HTML!non-null
The text content of the page, complete with HTML markup.
- Anchor to bodySummarybody•String!
Summary 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.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) of the page creation.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to handlehandle•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.
- Anchor to isPublishedis•Boolean!
Published non-null Whether or not the page is visible.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to publishedAtpublished•Date
At Time The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.
- Anchor to templateSuffixtemplate•String
Suffix The suffix of the template that's used to render the page.
- Anchor to titletitle•String!non-null
Title of the page.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) of the latest page update.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! 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 availablePublicationsCountavailable•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to bundleComponentsbundle•Product
Components Bundle Component Connection! non-null A list of components that are associated with a product in a bundle.
- Anchor to categorycategory•Taxonomy
Category The category of a product from Shopify's Standard Product Taxonomy.
- Anchor to collectionscollections•Collection
Connection! non-null A list of collections that include the product.
- Anchor to combinedListingcombined•Combined
Listing Listing 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.
- Anchor to combinedListingRolecombined•Combined
Listing Role Listings Role The role of the product in a combined listing.
If
null
, then the product isn't part of any combined listing.- Anchor to compareAtPriceRangecompare•Product
At Price Range Compare At Price Range The compare-at price range of the product in the shop's default currency.
- Anchor to contextualPricingcontextual•Product
Pricing Contextual Pricing! 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.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the product was created.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to descriptiondescription•String!non-null
A single-line description of the product, with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to descriptionHtmldescription•HTML!
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 eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to featuredMediafeatured•Media
Media The featured media associated with the product.
- Anchor to feedbackfeedback•Resource
Feedback 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 giftCardTemplateSuffixgift•String
Card Template Suffix The theme template that's used when customers view the gift card in a store.
- Anchor to handlehandle•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 hasOnlyDefaultVarianthas•Boolean!
Only Default Variant non-null Whether the product has only a single variant with the default option and value.
- Anchor to hasOutOfStockVariantshas•Boolean!
Out Of Stock Variants non-null Whether the product has variants that are out of stock.
- Anchor to hasVariantsThatRequiresComponentshas•Boolean!
Variants That Requires Components 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.
- Anchor to inCollectionin•Boolean!
Collection non-null Whether the product is in a specified collection.
- •ID!required
The ID of the collection to check. For example,
.
Arguments
- •ID!
- Anchor to isGiftCardis•Boolean!
Gift Card non-null Whether the product is a gift card.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to mediamedia•Media
Connection! non-null The media associated with the product. Valid media are images, 3D models, videos.
- Anchor to mediaCountmedia•Count
Count The total count of media that's associated with a product.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStorePreviewUrlonline•URL
Store Preview Url The preview URL for the online store.
- Anchor to onlineStoreUrlonline•URL
Store Url The product's URL on the online store. If
null
, then the product isn't published to the online store sales channel.- Anchor to optionsoptions•[Product
Option!]! non-null A list of product options. The limit is defined by the shop's resource limits for product options (
).
- Anchor to priceRangeV2price•Product
Range V2 Price Range V2! 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.
- Anchor to productTypeproduct•String!
Type non-null The product type that merchants define.
- Anchor to publishedAtpublished•Date
At Time The date and time when the product was published to the online store.
- Anchor to publishedInContextpublished•Boolean!
In Context 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.
- Anchor to contextcontext•Contextual
Publication Context! required The context used to determine publication status.
Arguments
- Anchor to publishedOnCurrentPublicationpublished•Boolean!
On Current Publication 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 publishedOnPublicationpublished•Boolean!
On Publication non-null Whether the resource is published to a specified publication.
- Anchor to publicationIdpublication•ID!
Id required The ID of the publication to check. For example,
.
Arguments
- Anchor to requiresSellingPlanrequires•Boolean!
Selling Plan non-null Whether the product can only be purchased with a selling plan. Products that are sold on subscription (
) can be updated only for online stores. If you update a product to be subscription-only (
), then the product is unpublished from all channels, except the online store.
- Anchor to resourcePublicationOnCurrentPublicationresource•Resource
Publication On Current Publication Publication V2 The resource that's either published or staged to be published to the publication.
- Anchor to resourcePublicationsresource•Resource
Publications Publication Connection! non-null The list of resources that are published to a publication.
- Anchor to resourcePublicationsCountresource•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to resourcePublicationsV2resource•Resource
Publications V2 Publication V2Connection! non-null The list of resources that are either published or staged to be published to a publication.
- Anchor to restrictedForResourcerestricted•Restricted
For Resource For Resource 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.
- Anchor to sellingPlanGroupsselling•Selling
Plan Groups Plan Group Connection! 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 sellingPlanGroupsCountselling•Count
Plan Groups 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.
- Anchor to statusstatus•Product
Status! 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
andsummer
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 themutation.
- Anchor to templateSuffixtemplate•String
Suffix The theme template that's used when customers view the product in a store.
- Anchor to titletitle•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
.- Anchor to totalInventorytotal•Int!
Inventory non-null The quantity of inventory that's in stock.
- Anchor to tracksInventorytracks•Boolean!
Inventory non-null Whether inventory tracking has been enabled for the product.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to unpublishedPublicationsunpublished•Publication
Publications Connection! non-null The list of publications that the resource isn't published to.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the product was last modified. A product's
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 variantsvariants•Product
Variant Connection! 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.
- Anchor to variantsCountvariants•Count
Count The number of variants that are associated with the product.
- Anchor to vendorvendor•String!non-null
The name of the product's vendor.
- Anchor to bodyHtmlbody•String
Html Deprecated - Anchor to customProductTypecustom•String
Product Type Deprecated - Anchor to descriptionPlainSummarydescription•String!
Plain Summary non-nullDeprecated - Anchor to featuredImagefeatured•Image
Image Deprecated - Anchor to imagesimages•Image
Connection! non-nullDeprecated - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to priceRangeprice•Product
Range Price Range! non-nullDeprecated - Anchor to productCategoryproduct•Product
Category Category Deprecated - Anchor to productPublicationsproduct•Product
Publications Publication Connection! non-nullDeprecated - Anchor to publicationCountpublication•Int!
Count non-nullDeprecated - Anchor to onlyPublishedonly•Boolean
Published Default:true Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
Arguments
- Anchor to publicationspublications•Product
Publication Connection! non-nullDeprecated - Anchor to publishedOnChannelpublished•Boolean!
On Channel non-nullDeprecated - Anchor to channelIdchannel•ID!
Id required The ID of the channel to check.
Arguments
- Anchor to publishedOnCurrentChannelpublished•Boolean!
On Current Channel non-nullDeprecated - Anchor to sellingPlanGroupCountselling•Int!
Plan Group Count non-nullDeprecated - Anchor to standardizedProductTypestandardized•Standardized
Product Type Product Type Deprecated - Anchor to storefrontIdstorefront•Storefront
Id ID! non-nullDeprecated - Anchor to totalVariantstotal•Int!
Variants non-nullDeprecated - Anchor to unpublishedChannelsunpublished•Channel
Channels Connection! non-nullDeprecated
- •OBJECT
The product property names. For example, "Size", "Color", and "Material". Variants are selected based on permutations of these options. The limit for each product property name is 255 characters.
- •ID!non-null
A globally-unique ID.
- Anchor to linkedMetafieldlinked•Linked
Metafield Metafield The metafield identifier linked to this option.
- Anchor to namename•String!non-null
The product option’s name.
- Anchor to optionValuesoption•[Product
Values Option Value!]! non-null Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.
- Anchor to positionposition•Int!non-null
The product option's position.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to valuesvalues•[String!]!non-null
The corresponding value to the product option name.
- •ID!
- •OBJECT
The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option.
- Anchor to hasVariantshas•Boolean!
Variants non-null Whether the product option value has any linked variants.
- •ID!non-null
A globally-unique ID.
- Anchor to linkedMetafieldValuelinked•String
Metafield Value The value of the linked metafield.
- Anchor to namename•String!non-null
The name of the product option value.
- Anchor to swatchswatch•Product
Option Value Swatch The swatch associated with the product option value.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- •OBJECT
The
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
object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the
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
is associated with a parent
Product
object.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:
: Used for inventory tracking
Image
: Used for variant-specific images: Used for subscriptions and selling plans
Learn more about Shopify's product model.
- Anchor to availableForSaleavailable•Boolean!
For Sale non-null Whether the product variant is available for sale.
- Anchor to barcodebarcode•String
The value of the barcode associated with the product.
- Anchor to compareAtPricecompare•Money
At Price The compare-at price of the variant in the default shop currency.
- Anchor to contextualPricingcontextual•Product
Pricing Variant Contextual Pricing! 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.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the variant was created.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to deliveryProfiledelivery•Delivery
Profile Profile The delivery profile for the variant.
- Anchor to displayNamedisplay•String!
Name non-null Display name of the variant, based on product's title + variant's title.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The featured image for the variant.
- Anchor to inventoryIteminventory•Inventory
Item Item! non-null The inventory item, which is used to query for inventory information.
- Anchor to inventoryPolicyinventory•Product
Policy Variant Inventory Policy! non-null Whether customers are allowed to place an order for the product variant when it's out of stock.
- Anchor to inventoryQuantityinventory•Int
Quantity The total sellable quantity of the variant.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to mediamedia•Media
Connection! non-null The media associated with the product variant.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to positionposition•Int!non-null
The order of the product variant in the list of product variants. The first position in the list is 1.
- Anchor to priceprice•Money!non-null
The price of the product variant in the default shop currency.
- Anchor to productproduct•Product!non-null
The product that this variant belongs to.
- Anchor to productVariantComponentsproduct•Product
Variant Components Variant Component Connection! non-null A list of the product variant components.
- Anchor to requiresComponentsrequires•Boolean!
Components non-null Whether a product variant requires components. The default value is
false
. Iftrue
, 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.- Anchor to selectedOptionsselected•[Selected
Options Option!]! non-null List of product options applied to the variant.
- Anchor to sellableOnlineQuantitysellable•Int!
Online Quantity 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.
- Anchor to sellingPlanGroupsselling•Selling
Plan Groups Plan Group Connection! non-null A list of all selling plan groups defined in the current shop associated with the product variant.
- Anchor to sellingPlanGroupsCountselling•Count
Plan Groups Count Count of selling plan groups associated with the product variant.
- •String
A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
- Anchor to taxabletaxable•Boolean!non-null
Whether a tax is charged when the product variant is sold.
- Anchor to titletitle•String!non-null
The title of the product variant.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to unitPriceMeasurementunit•Unit
Price Measurement Price Measurement The unit price measurement for the variant.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) when the product variant was last modified.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to presentmentPricespresentment•Product
Prices Variant Price Pair Connection! non-nullDeprecated - Anchor to sellingPlanGroupCountselling•Int!
Plan Group Count non-nullDeprecated - Anchor to storefrontIdstorefront•Storefront
Id ID! non-nullDeprecated - Anchor to taxCodetax•String
Code Deprecated
- •OBJECT
Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
For more information on selling plans, refer to Creating and managing selling plans.
- Anchor to billingPolicybilling•Selling
Policy Plan Billing Policy! non-null A selling plan policy which describes the recurring billing details.
- Anchor to categorycategory•Selling
Plan Category The category used to classify the selling plan for reporting purposes.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the selling plan was created.
- Anchor to deliveryPolicydelivery•Selling
Policy Plan Delivery Policy! non-null A selling plan policy which describes the delivery details.
- Anchor to descriptiondescription•String
Buyer facing string which describes the selling plan commitment.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryPolicyinventory•Selling
Policy Plan Inventory Policy When to reserve inventory for a selling plan.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
A customer-facing description of the selling plan.
If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.
- Anchor to optionsoptions•[String!]!non-null
The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same
and
values.
- Anchor to positionposition•Int
Relative position of the selling plan for display. A lower position will be displayed before a higher position.
- Anchor to pricingPoliciespricing•[Selling
Policies Plan Pricing Policy!]! non-null Selling plan pricing details.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •OBJECT
Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
- Anchor to appIdapp•String
Id The ID for app, exposed in Liquid and product JSON.
- Anchor to appliesToProductapplies•Boolean!
To Product non-null Whether the given product is directly associated to the selling plan group.
- Anchor to productIdproduct•ID!
Id required The ID of the product.
Arguments
- Anchor to appliesToProductVariantapplies•Boolean!
To Product Variant non-null Whether the given product variant is directly associated to the selling plan group.
- Anchor to productVariantIdproduct•ID!
Variant Id required The ID of the product.
Arguments
- Anchor to appliesToProductVariantsapplies•Boolean!
To Product Variants non-null Whether any of the product variants of the given product are associated to the selling plan group.
- Anchor to productIdproduct•ID!
Id required The ID of the product.
Arguments
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the selling plan group was created.
- Anchor to descriptiondescription•String
The merchant-facing description of the selling plan group.
- •ID!non-null
A globally-unique ID.
- Anchor to merchantCodemerchant•String!
Code non-null The merchant-facing label of the selling plan group.
- Anchor to namename•String!non-null
The buyer-facing label of the selling plan group.
- Anchor to optionsoptions•[String!]!non-null
The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same
and
values.
- Anchor to positionposition•Int
The relative position of the selling plan group for display.
- Anchor to productsproducts•Product
Connection! non-null Products associated to the selling plan group.
- Anchor to productsCountproducts•Count
Count A count of products associated to the selling plan group.
- Anchor to productVariantsproduct•Product
Variants Variant Connection! non-null Product variants associated to the selling plan group.
- Anchor to productVariantsCountproduct•Count
Variants Count A count of product variants associated to the selling plan group.
- Anchor to sellingPlansselling•Selling
Plans Plan Connection! non-null Selling plans associated to the selling plan group.
- Anchor to summarysummary•String
A summary of the policies associated to the selling plan group.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- •OBJECT
Represents a collection of general settings and information about the shop.
- Anchor to accountOwneraccount•Staff
Owner Member! non-null Account owner information.
- Anchor to alertsalerts•[Shop
Alert!]! non-null A list of the shop's active alert messages that appear in the Shopify admin.
- Anchor to allProductCategoriesListall•[Taxonomy
Product Categories List Category!]! non-null A list of the shop's product categories. Limit: 1000 product categories.
- Anchor to availableChannelAppsavailable•App
Channel Apps Connection! non-null The list of sales channels not currently installed on the shop.
- Anchor to billingAddressbilling•Shop
Address Address! non-null The shop's billing address information.
- Anchor to channelDefinitionsForInstalledChannelschannel•[Available
Definitions For Installed Channels Channel Definitions By Channel!]! non-null List of all channel definitions associated with a shop.
- Anchor to checkoutApiSupportedcheckout•Boolean!
Api Supported non-null Specifies whether the shop supports checkouts via Checkout API.
- Anchor to contactEmailcontact•String!
Email non-null The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
- Anchor to countriesInShippingZonescountries•Countries
In Shipping Zones In Shipping Zones! non-null Countries that have been defined in shipping zones for the shop.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the shop was created.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The three letter code for the currency that the shop sells in.
- Anchor to currencyFormatscurrency•Currency
Formats Formats! non-null How currencies are displayed on your store.
- Anchor to currencySettingscurrency•Currency
Settings Setting Connection! non-null The presentment currency settings for the shop excluding the shop's own currency.
- Anchor to customerAccountscustomer•Shop
Accounts Customer Accounts Setting! non-null Whether customer accounts are required, optional, or disabled for the shop.
- Anchor to customerAccountsV2customer•Customer
Accounts V2 Accounts V2! non-null Information about the shop's customer accounts.
- Anchor to customerTagscustomer•String
Tags Connection! non-null A list of tags that have been added to customer accounts.
- Anchor to descriptiondescription•String
The shop's meta description used in search engine results.
- Anchor to draftOrderTagsdraft•String
Order Tags Connection! non-null A list of tags that have been added to draft orders.
- Anchor to emailemail•String!non-null
The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
- Anchor to enabledPresentmentCurrenciesenabled•[Currency
Presentment Currencies Code!]! non-null The presentment currencies enabled for the shop.
- Anchor to entitlementsentitlements•Entitlements
Type! non-null The entitlements for a shop.
- Anchor to featuresfeatures•Shop
Features! non-null The set of features enabled for the shop.
- Anchor to fulfillmentServicesfulfillment•[Fulfillment
Services Service!]! non-null List of the shop's installed fulfillment services.
- Anchor to ianaTimezoneiana•String!
Timezone non-null The shop's time zone as defined by the IANA.
- •ID!non-null
A globally-unique ID.
- Anchor to marketingSmsConsentEnabledAtCheckoutmarketing•Boolean!
Sms Consent Enabled At Checkout non-null Whether SMS marketing has been enabled on the shop's checkout configuration settings.
- Anchor to merchantApprovalSignalsmerchant•Merchant
Approval Signals Approval Signals The approval signals for a shop to support onboarding to channel apps.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to myshopifyDomainmyshopify•String!
Domain non-null The shop's .myshopify.com domain name.
- Anchor to namename•String!non-null
The shop's name.
- •[Navigation
Item!]! non-null The shop's settings related to navigation.
- Anchor to orderNumberFormatPrefixorder•String!
Number Format Prefix non-null The prefix that appears before order numbers.
- Anchor to orderNumberFormatSuffixorder•String!
Number Format Suffix non-null The suffix that appears after order numbers.
- Anchor to orderTagsorder•String
Tags Connection! non-null A list of tags that have been added to orders.
- Anchor to paymentSettingspayment•Payment
Settings Settings! non-null The shop's settings related to payments.
- Anchor to planplan•Shop
Plan! non-null The shop's billing plan.
- Anchor to primaryDomainprimary•Domain!
Domain non-null The primary domain of the shop's online store.
- Anchor to resourceLimitsresource•Shop
Limits Resource Limits! non-null The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.
- Anchor to richTextEditorUrlrich•URL!
Text Editor Url non-null The URL of the rich text editor that can be used for mobile devices.
- Anchor to searchsearch•Search
Result Connection! non-null Fetches a list of admin search results by a specified query.
- Anchor to searchFilterssearch•Search
Filters Filter Options! non-null The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
- Anchor to setupRequiredsetup•Boolean!
Required non-null Whether the shop has outstanding setup steps.
- Anchor to shipsToCountriesships•[Country
To Countries Code!]! non-null The list of countries that the shop ships to.
- Anchor to shopOwnerNameshop•String!
Owner Name non-null The name of the shop owner.
- Anchor to shopPoliciesshop•[Shop
Policies Policy!]! non-null The list of all legal policies associated with a shop.
- Anchor to storefrontAccessTokensstorefront•Storefront
Access Tokens Access Token Connection! non-null The storefront access token of a private application. These are scoped per-application.
- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether applicable taxes are included in the shop's product prices.
- Anchor to taxShippingtax•Boolean!
Shipping non-null Whether the shop charges taxes for shipping.
- Anchor to timezoneAbbreviationtimezone•String!
Abbreviation non-null The shop's time zone abbreviation.
- Anchor to timezoneOffsettimezone•String!
Offset non-null The shop's time zone offset.
- Anchor to timezoneOffsetMinutestimezone•Int!
Offset Minutes non-null The shop's time zone offset expressed as a number of minutes.
- Anchor to transactionalSmsDisabledtransactional•Boolean!
Sms Disabled non-null Whether transactional SMS sent by Shopify have been disabled for a shop.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to unitSystemunit•Unit
System System! non-null The shop's unit system for weights and measures.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the shop was last updated.
- •URL!non-null
The URL of the shop's online store.
- Anchor to weightUnitweight•Weight
Unit Unit! non-null The shop's primary unit of weight for products and shipping.
- Anchor to allProductCategoriesall•[Product
Product Categories Category!]! non-nullDeprecated - Anchor to analyticsTokenanalytics•String!
Token non-nullDeprecated - Anchor to assignedFulfillmentOrdersassigned•Fulfillment
Fulfillment Orders Order Connection! non-nullDeprecated - Anchor to channelschannels•Channel
Connection! non-nullDeprecated - Anchor to collectionscollections•Collection
Connection! non-nullDeprecated - Anchor to customerscustomers•Customer
Connection! non-nullDeprecated - Anchor to domainsdomains•[Domain!]!non-nullDeprecated
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-nullDeprecated - Anchor to fulfillmentOrdersfulfillment•Fulfillment
Orders Order Connection! non-nullDeprecated - Anchor to inventoryItemsinventory•Inventory
Items Item Connection! non-nullDeprecated - Anchor to limitedPendingOrderCountlimited•Limited
Pending Order Count Pending Order Count! non-nullDeprecated - Anchor to locationslocations•Location
Connection! non-nullDeprecated - Anchor to ordersorders•Order
Connection! non-nullDeprecated - Anchor to productImagesproduct•Image
Images Connection! non-nullDeprecated - Anchor to productsproducts•Product
Connection! non-nullDeprecated - Anchor to productTagsproduct•String
Tags Connection! non-nullDeprecated - Anchor to productTypesproduct•String
Types Connection! non-nullDeprecated - Anchor to productVariantsproduct•Product
Variants Variant Connection! non-nullDeprecated - Anchor to productVendorsproduct•String
Vendors Connection! non-nullDeprecated - Anchor to publicationCountpublication•Int!
Count non-nullDeprecated - Anchor to staffMembersstaff•Staff
Members Member Connection! non-nullDeprecated - Anchor to storefrontUrlstorefront•URL!
Url non-nullDeprecated
- •OBJECT
Policy that a merchant has configured for their store, such as their refund or privacy policy.
- Anchor to bodybody•HTML!non-null
The text of the policy. The maximum size is 512kb.
- Anchor to createdAtcreated•Date!
At non-null The date and time (ISO 8601 format) when the policy was created.
- •ID!non-null
A globally-unique ID.
- Anchor to titletitle•String!non-null
The translated title of the policy. For example, Refund Policy or Politique de remboursement.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to typetype•Shop
Policy Type! non-null The shop policy type.
- Anchor to updatedAtupdated•Date!
At non-null The date and time (ISO 8601 format) when the policy was last modified.
- •URL!non-null
The public URL of the policy.