Skip to main content
object

Requires read_products access scope.

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.

Deprecated fields

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

Was this section helpful?

query

Retrieves a product by its ID. A product is an item that a merchant can sell in their store.

Use the product query when you need to:

  • Access essential product data (for example, title, description, price, images, SEO metadata, and metafields).
  • Build product detail pages and manage inventory.
  • Handle international sales with localized pricing and content.
  • Manage product variants and product options.

Learn more about working with Shopify's product model.

query

Return a product by an identifier.

query

Retrieves a list of products in a store. Products are the items that merchants can sell in their store.

Use the products query when you need to:

  • Build a browsing interface for a product catalog.
  • Create product searching, sorting, and filtering experiences.
  • Implement product recommendations.
  • Sync product data with external systems.

The products query supports pagination to handle large product catalogs and saved searches for frequently used product queries.

The products query returns products with their associated metadata, including:

  • Basic product information (for example, title, description, vendor, and type)
  • Product options and product variants, with their prices and inventory
  • Media attachments (for example, images and videos)
  • SEO metadata
  • Product categories and tags
  • Product availability and publishing statuses

Learn more about working with Shopify's product model.

query
Deprecated

Was this section helpful?

mutation

Add, remove and update CombinedListings of a given Product.

CombinedListings are comprised of multiple products to create a single listing. There are two kinds of products used in a CombinedListing:

  1. Parent products
  2. Child products

The parent product is created with a productCreate with a CombinedListingRole of PARENT. Once created, you can associate child products with the parent product using this mutation. Parent products represent the idea of a product (e.g. Shoe).

Child products represent a particular option value (or combination of option values) of a parent product. For instance, with your Shoe parent product, you may have several child products representing specific colors of the shoe (e.g. Shoe - Blue). You could also have child products representing more than a single option (e.g. Shoe - Blue/Canvas, Shoe - Blue/Leather, etc...).

The combined listing is the association of parent product to one or more child products.

Learn more about Combined Listings.

mutation

Updates the fixed prices for all variants for a product on a price list. You can use the priceListFixedPricesByProductUpdate mutation to set or remove a fixed price for all variants of a product associated with the price list.

mutation

Creates a product with attributes such as title, description, vendor, and media.

The productCreate mutation helps you create many products at once, avoiding the tedious or time-consuming process of adding them one by one in the Shopify admin. Common examples include creating products for a new collection, launching a new product line, or adding seasonal products.

You can define product options and values, allowing you to create products with different variations like sizes or colors. You can also associate media files to your products, including images and videos.

The productCreate mutation only supports creating a product with its initial product variant. To create multiple product variants for a single product and manage prices, use the productVariantsBulkCreate mutation.


Note

The productCreate mutation has a throttle that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than 1,000 new product variants can be created per day.


After you create a product, you can make subsequent edits to the product using one of the following mutations:

  • publishablePublish: Used to publish the product and make it available to customers. The productCreate mutation creates products in an unpublished state by default, so you must perform a separate operation to publish the product.
  • productUpdate: Used to update a single product, such as changing the product's title, description, vendor, or associated media.
  • productSet: Used to perform multiple operations on products, such as creating or modifying product options and variants.

Learn more about the product model and adding product data.

mutation

Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, you can instead duplicate the product asynchronously.

In API version 2024-10 and higher, include synchronous: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Metafield values are not duplicated if the unique values capability is enabled.

mutation

Adds multiple selling plan groups to a product.

mutation

Removes multiple groups from a product.

mutation

Creates one or more options on a product, such as size, color, or material. Each option includes a name, position, and a list of values. The combination of a product option and value creates a product variant.

Use the productOptionsCreate mutation for the following use cases:

  • Add product choices: Add a new option, like "Size" (Small, Medium, Large) or "Color" (Red, Blue, Green), to an existing product so customers can select their preferred variant.
  • Enable personalization features: Add options such as "Engraving text" to let customers customize their purchase.
  • Offer seasonal or limited edition products: Add a new value (for example, "Holiday red") to an existing option to support limited-time or seasonal variants.
  • Integrate with apps that manage product configuration: Allow third-party apps to add options, like "Bundle size", when customers select or customize product bundles.
  • Link options to metafields: Associate a product option with a custom metafield, like "Fabric code", for richer integrations with other systems or apps.

Note

The productOptionsCreate mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant. If you use the CREATE variant strategy, consider the maximum allowed number of variants for each product (100 by default, and 2,048 if you've enabled the Extended Variants developer preview).


After you create product options, you can further manage a product's configuration using related mutations:

Learn more about the product model and adding product data.

mutation

Deletes one or more options from a product. Product options define the choices available for a product, such as size, color, or material.


Caution

Removing an option can affect a product's variants and their configuration. Deleting an option might also delete associated option values and, depending on the chosen strategy, might affect variants.


Use the productOptionsDelete mutation for the following use cases:

  • Simplify product configuration: Remove obsolete or unnecessary options (for example, discontinue "Material" if all variants are now the same material).
  • Clean up after seasonal or limited-time offerings: Delete options that are no longer relevant (for example, "Holiday edition").
  • Automate catalog management: Enable apps or integrations to programmatically remove options as product data changes.

Note

The productOptionsDelete mutation enforces strict data integrity for product options and variants. All option positions must remain sequential, and every remaining option must be used by at least one variant.


After you delete a product option, you can further manage a product's configuration using related mutations:

Learn more about the product model and adding product data.

mutation

Reorders the options and option values on a product, updating the order in which product variants are presented to customers.

The productOptionsReorder mutation accepts a list of product options, each identified by id or name, and an optional list of values (also by id or name) specifying the new order. The order of options in the mutation's input determines their new positions (for example, the first option becomes option1). The order of values within each option determines their new positions. The mutation recalculates the order of variants based on the new option and value order.

Suppose a product has the following variants:

  1. "Red / Small"
  2. "Green / Medium"
  3. "Blue / Small"

You reorder options and values:

options: [
{ name: "Size", values: [{ name: "Small" }, { name: "Medium" }] },
{ name: "Color", values: [{ name: "Green" }, { name: "Red" }, { name: "Blue" }] }
]

The resulting variant order will be:

  1. "Small / Green"
  2. "Small / Red"
  3. "Small / Blue"
  4. "Medium / Green"

Use the productOptionsReorder mutation for the following use cases:

  • Change the order of product options: For example, display "Color" before "Size" in a store.
  • Reorder option values within an option: For example, show "Red" before "Blue" in a color picker.
  • Control the order of product variants: The order of options and their values determines the sequence in which variants are listed and selected.
  • Highlight best-selling options: Present the most popular or relevant options and values first.
  • Promote merchandising strategies: Highlight seasonal colors, limited editions, or featured sizes.

Note

The productOptionsReorder mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant.


After you reorder product options, you can further manage a product's configuration using related mutations:

Learn more about the product model and managing product data.

mutation

Updates an option on a product, such as size, color, or material. Each option includes a name, position, and a list of values. The combination of a product option and value creates a product variant.

Use the productOptionUpdate mutation for the following use cases:

  • Update product choices: Modify an existing option, like "Size" (Small, Medium, Large) or "Color" (Red, Blue, Green), so customers can select their preferred variant.
  • Enable personalization features: Update an option (for example, "Engraving text") to let customers customize their purchase.
  • Offer seasonal or limited edition products: Update a value (for example, "Holiday red") on an existing option to support limited-time or seasonal variants.
  • Integrate with apps that manage product configuration: Allow third-party apps to update options, like "Bundle size", when customers select or customize product bundles.
  • Link options to metafields: Associate a product option with a custom metafield, like "Fabric code", for richer integrations with other systems or apps.

Note

The productOptionUpdate mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant.


After you update a product option, you can further manage a product's configuration using related mutations:

Learn more about the product model and adding product data.

mutation

Performs multiple operations to create or update products in a single request.

Use the productSet mutation to sync information from an external data source into Shopify, manage large product catalogs, and perform batch updates. The mutation is helpful for bulk product management, including price adjustments, inventory updates, and product lifecycle management.

The behavior of productSet depends on the type of field it's modifying:

  • For list fields: Creates new entries, updates existing entries, and deletes existing entries that aren't included in the mutation's input. Common examples of list fields include collections, metafields, and variants.

  • For all other field types: Updates only the included fields. Any omitted fields will remain unchanged.


Note

By default, stores have a limit of 100 product variants for each product. You can create a development store and enable the Extended Variants developer preview to create or update a maximum of 2,048 product variants in a single operation.


You can run productSet in one of the following modes:

  • Synchronously: Returns the updated product in the response.
  • Asynchronously: Returns a ProductSetOperation object. Use the productOperation query to check the status of the operation and retrieve details of the updated product and its product variants.

If you need to only manage product variants, then use one of the following mutations:

If you need to only manage product options, then use one of the following mutations:

Learn more about syncing product data from an external source.

mutation

Updates a product with attributes such as title, description, vendor, and media.

The productUpdate mutation helps you modify many products at once, avoiding the tedious or time-consuming process of updating them one by one in the Shopify admin. Common examples including updating product details like status or tags.

The productUpdate mutation doesn't support updating product variants. To update multiple product variants for a single product and manage prices, use the productVariantsBulkUpdate mutation.


Note

The productUpdate mutation has a throttle that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than 1,000 new product variants can be updated per day.


After updating a product, you can make additional changes using one of the following mutations:

  • productSet: Used to perform multiple operations on products, such as creating or modifying product options and variants.
  • publishablePublish: Used to publish the product and make it available to customers, if the product is currently unpublished.

Learn more about the product model and adding product data.

mutation

Appends media from a product to variants of the product.

mutation

Detaches media from product variants.

mutation

Creates multiple product variants for a single product in one operation. You can run this mutation directly or as part of a bulk operation for large-scale catalog updates.

Use the productVariantsBulkCreate mutation to efficiently add new product variants—such as different sizes, colors, or materials—to an existing product. The mutation is helpful if you need to add product variants in bulk, such as importing from an external system.

The mutation supports:

  • Creating variants with custom options and values
  • Associating media (for example, images, videos, and 3D models) with the product or its variants
  • Handling complex product configurations

Note

By default, stores have a limit of 100 product variants for each product. You can create a development store and enable the Extended Variants developer preview to create a maximum of 2,048 product variants in a single operation.


After creating variants, you can make additional changes using one of the following mutations:

  • productVariantsBulkUpdate: Updates multiple product variants for a single product in one operation.
  • productSet: Used to perform multiple operations on products, such as creating or modifying product options and variants.

You can also specifically manage product options through related mutations:

Learn more about the product model and adding product data.

mutation

Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

mutation

Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

mutation

Updates multiple product variants for a single product in one operation. You can run this mutation directly or as part of a bulk operation for large-scale catalog updates.

Use the productVariantsBulkUpdate mutation to efficiently modify product variants—such as different sizes, colors, or materials—associated with an existing product. The mutation is helpful if you need to update a product's variants in bulk, such as importing from an external system.

The mutation supports:

  • Updating variants with custom options and values
  • Associating media (for example, images, videos, and 3D models) with the product or its variants
  • Handling complex product configurations

Note

By default, stores have a limit of 100 product variants for each product. You can create a development store and enable the Extended Variants developer preview to update a maximum of 2,048 product variants in a single operation.


After creating variants, you can make additional changes using the productSet mutation, which is used to perform multiple operations on products, such as creating or modifying product options and variants.

You can also specifically manage product options through related mutations:

Learn more about the product model and adding product data.

Deprecated mutations

mutation
Deprecated
mutation
Deprecated
mutation
Deprecated
mutation
Deprecated
mutation
Deprecated
mutation
Deprecated

Was this section helpful?