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.
Fields and connections
The number of publications that a resource is published to, without feedback errors.
A list of components that are associated with a product in a bundle.
The category of a product from Shopify's Standard Product Taxonomy.
A list of collections that include the product.
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.
The role of the product in a combined listing.
If
null, then the product isn't part of any combined listing.The compare-at price range of the product in the shop's default currency.
The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location.
The date and time when the product was created.
A default cursor that returns the single next record, sorted ascending by ID.
A single-line description of the product, with HTML tags removed.
The description of the product, with HTML tags. For example, the description might include bold
<strong></strong>and italic<i></i>text.The featured media associated with the product.
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".
The theme template that's used when customers view the gift card in a store.
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.Whether the product has only a single variant with the default option and value.
Whether the product has variants that are out of stock.
Whether at least one of the product variants requires bundle components.
Learn more about store eligibility for bundles.
A globally-unique ID.
Whether the product is in a specified collection.
Whether the product is a gift card.
The ID of the corresponding resource in the REST Admin API.
The media associated with the product. Valid media are images, 3D models, videos.
The total count of media that's associated with a product.
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
The preview URL for the online store.
The product's URL on the online store. If
null, then the product isn't published to the online store sales channel.A list of product options. The limit is defined by the shop's resource limits for product options (
).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.
The product type that merchants define.
The date and time when the product was published to the online store.
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.
Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
Whether the resource is published to a specified publication.
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.The resource that's either published or staged to be published to the publication.
The list of resources that are published to a publication.
The number of publications that a resource is published to, without feedback errors.
The list of resources that are either published or staged to be published to a publication.
A list of all selling plan groups that are associated with the product either directly, or through the product's variants.
A count of selling plan groups that are associated with the product.
The SEO title and description that are associated with a product.
The product status, which controls visibility across all sales channels.
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sportsandsummertags to products that are associated with sportwear for summer.Updating
tagsoverwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use themutation.The theme template that's used when customers view the product in a store.
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.The quantity of inventory that's in stock.
Whether inventory tracking has been enabled for the product.
The published translations associated with the resource.
The list of publications that the resource isn't published to.
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.A list of variants associated with the product.
The number of variants that are associated with the product.
The name of the product's vendor.
Returns a Product resource by ID.
Return a product by its handle.
Returns a list of products.
Mutations
Add, remove and update
s of a given Product.s are comprised of multiple products to create a single listing. There are two kinds of products used in a:- Parent products
- Child products
The parent product is created with a
with aof. 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.
Updates the fixed prices for all variants for a product on a price list. You can use the
mutation to set or remove a fixed price for all variants of a product associated with the price list.Creates media for a product.
Creates a product.
Learn more about the product model and adding product data.
Deletes media for a product.
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: falseargument in this mutation to perform the duplication asynchronously.Adds multiple selling plan groups to a product.
Removes multiple groups from a product.
Updates a product option.
Creates options on a product.
Deletes the specified options.
Reorders options and option values on a product, causing product variants to alter their position.
Options order take precedence over option values order. Depending on the existing product variants, some input orders might not be achieved.
Example: Existing product variants: ["Red / Small", "Green / Medium", "Blue / Small"].
New order: [ { name: "Size", values: [{ name: "Small" }, { name: "Medium" }], name: "Color", values: [{ name: "Green" }, { name: "Red" }, { name: "Blue" }] } ].
Description: Variants with "Green" value are expected to appear before variants with "Red" and "Blue" values. However, "Size" option appears before "Color".
Therefore, output will be: ["Small / "Red", "Small / Blue", "Medium / Green"].
Creates or updates a product in a single request.
Use this mutation when syncing information from an external data source into Shopify.
When using this mutation to update a product, specify that product's
idin the input.Any list field (e.g. collections, metafields, variants) will be updated so that all included entries are either created or updated, and all existing entries not included will be deleted.
All other fields will be updated to the value passed. Omitted fields will not be updated.
When run in synchronous mode, the
mutation has an input limit of 100 variants. If you anticipate any of your use cases requiring support for more than 100 variants, please use the mutation in asynchronous mode (default).When run in synchronous mode, you will get the product back in the response.
In asynchronous mode, you will instead get a ProductSetOperation object back. You can then use the productOperation query to retrieve the updated product data. This query uses the
object to check the status of the operation and to retrieve the details of the updated product and its variants.If you need to update a subset of variants, use one of the bulk variant mutations:
If you need to update options, use one of the product option mutations:
See our guide to sync product data from an external source for more.
Updates media for a product.
Updates a product.
For versions
2024-01and older: If you update a product and only include some variants in the update, then any variants not included will be deleted.To safely manage variants without the risk of deleting excluded variants, use productVariantsBulkUpdate.
If you want to update a single variant, then use productVariantUpdate.
Appends media from a product to variants of the product.
Detaches media from product variants.
Creates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Updates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.