Choose a version:

Product

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 FieldsFields

availablePublicationsCount

•Count

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

bundleComponents

•ProductBundleComponentConnection!

non-null

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

Deprecated fields

bodyHtml

•String

Deprecated

customProductType

•String

Deprecated

descriptionPlainSummary

•String!

non-nullDeprecated

featuredImage

•Image

Deprecated

images

•ImageConnection!

non-nullDeprecated

metafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

priceRange

•ProductPriceRange!

non-nullDeprecated

productCategory

•ProductCategory

Deprecated

productPublications

•ProductPublicationConnection!

non-nullDeprecated

publicationCount

•Int!

non-nullDeprecated

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

publications

•ProductPublicationConnection!

non-nullDeprecated

publishedOnChannel

•Boolean!

non-nullDeprecated

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

publishedOnCurrentChannel

•Boolean!

non-nullDeprecated

sellingPlanGroupCount

•Int!

non-nullDeprecated

standardizedProductType

•StandardizedProductType

Deprecated

storefrontId

•StorefrontID!

non-nullDeprecated

totalVariants

•Int!

non-nullDeprecated

unpublishedChannels

•ChannelConnection!

non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to product product •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.
Anchor to productByIdentifier productByIdentifier •query: Return a product by an identifier.
Anchor to products products •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.
Anchor to productByHandle productByHandle •query Deprecated

Was this section helpful?

Anchor to MutationsMutations

Anchor to combinedListingUpdate combinedListingUpdate •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:

Parent products

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.
Anchor to priceListFixedPricesByProductUpdate priceListFixedPricesByProductUpdate •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.
Anchor to productCreate productCreate •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.
Anchor to productDuplicate productDuplicate •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.
Anchor to productJoinSellingPlanGroups productJoinSellingPlanGroups •mutation: Adds multiple selling plan groups to a product.
Anchor to productLeaveSellingPlanGroups productLeaveSellingPlanGroups •mutation: Removes multiple groups from a product.
Anchor to productOptionsCreate productOptionsCreate •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:

productOptionUpdate

productOptionsReorder

productOptionsDelete

productVariantsBulkCreate

productVariantsBulkUpdate

productSet

Learn more about the product model and adding product data.
Anchor to productOptionsDelete productOptionsDelete •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:

productOptionsCreate

productOptionUpdate

productOptionsReorder

productVariantsBulkCreate

productVariantsBulkUpdate

productSet

Learn more about the product model and adding product data.
Anchor to productOptionsReorder productOptionsReorder •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:

"Red / Small"

"Green / Medium"

"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:

"Small / Green"

"Small / Red"

"Small / Blue"

"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:

productOptionsCreate

productOptionsDelete

productVariantsBulkCreate

productVariantsBulkUpdate

productSet

Learn more about the product model and managing product data.
Anchor to productOptionUpdate productOptionUpdate •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:

productOptionsCreate

productOptionsDelete

productOptionsReorder

productVariantsBulkCreate

productVariantsBulkUpdate

productSet

Learn more about the product model and adding product data.
Anchor to productSet productSet •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:

productVariantsBulkCreate

productVariantsBulkUpdate

productVariantsBulkDelete

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

productOptionsCreate

productOptionUpdate

productOptionsReorder

productOptionsDelete

Learn more about syncing product data from an external source.
Anchor to productUpdate productUpdate •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.
Anchor to productVariantAppendMedia productVariantAppendMedia •mutation: Appends media from a product to variants of the product.
Anchor to productVariantDetachMedia productVariantDetachMedia •mutation: Detaches media from product variants.
Anchor to productVariantsBulkCreate productVariantsBulkCreate •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:

productOptionsCreate

productOptionUpdate

productOptionsReorder

productOptionsDelete

Learn more about the product model and adding product data.
Anchor to productVariantsBulkDelete productVariantsBulkDelete •mutation: Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Anchor to productVariantsBulkReorder productVariantsBulkReorder •mutation: Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Anchor to productVariantsBulkUpdate productVariantsBulkUpdate •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:

productOptionsCreate

productOptionUpdate

productOptionsReorder

productOptionsDelete

Learn more about the product model and adding product data.