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)
- bundleComponents (ProductBundleComponentConnection!)
- bundleConsolidatedOptions ([ComponentizedProductsBundleConsolidatedOption!])
- category (TaxonomyCategory)
- collections (CollectionConnection!)
- combinedListing (CombinedListing)
- combinedListingRole (CombinedListingsRole)
- compareAtPriceRange (ProductCompareAtPriceRange)
- contextualPricing (ProductContextualPricing!)
- createdAt (DateTime!)
- defaultCursor (String!)
- description (String!)
- descriptionHtml (HTML!)
- events (EventConnection!)
- featuredMedia (Media)
- feedback (ResourceFeedback)
- giftCardTemplateSuffix (String)
- handle (String!)
- hasOnlyDefaultVariant (Boolean!)
- hasOutOfStockVariants (Boolean!)
- hasVariantsThatRequiresComponents (Boolean!)
- id (ID!)
- inCollection (Boolean!)
- isGiftCard (Boolean!)
- legacyResourceId (UnsignedInt64!)
- media (MediaConnection!)
- mediaCount (Count)
- metafield (Metafield)
- metafields (MetafieldConnection!)
- onlineStorePreviewUrl (URL)
- onlineStoreUrl (URL)
- options ([ProductOption!]!)
- priceRangeV2 (ProductPriceRangeV2!)
- productComponents (ProductComponentTypeConnection!)
- productComponentsCount (Count)
- productParents (ProductConnection!)
- productType (String!)
- publishedAt (DateTime)
- publishedInContext (Boolean!)
- publishedOnPublication (Boolean!)
- requiresSellingPlan (Boolean!)
- resourcePublications (ResourcePublicationConnection!)
- resourcePublicationsCount (Count)
- resourcePublicationsV2 (ResourcePublicationV2Connection!)
- restrictedForResource (RestrictedForResource)
- sellingPlanGroups (SellingPlanGroupConnection!)
- sellingPlanGroupsCount (Count)
- seo (SEO!)
- status (ProductStatus!)
- tags ([String!]!)
- templateSuffix (String)
- title (String!)
- totalInventory (Int!)
- tracksInventory (Boolean!)
- translations ([Translation!]!)
- unpublishedPublications (PublicationConnection!)
- updatedAt (DateTime!)
- variants (ProductVariantConnection!)
- variantsCount (Count)
- vendor (String!)
- Anchor to availablePublicationsCountavailablePublicationsCount•Count
The number of publications that a resource is published to, without feedback errors.
- Anchor to bundleComponentsbundleComponents•ProductBundleComponentConnection!non-null
A list of components that are associated with a product in a bundle.
- Anchor to bundleConsolidatedOptionsbundleConsolidatedOptions•[ComponentizedProductsBundleConsolidatedOption!]
A list of consolidated options for a product in a bundle.
- Anchor to categorycategory•TaxonomyCategory
The category of a product from Shopify's Standard Product Taxonomy.
- Anchor to collectionscollections•CollectionConnection!non-null
A list of collections that include the product.
- Anchor to combinedListingcombinedListing•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.
- Anchor to combinedListingRolecombinedListingRole•CombinedListingsRole
The role of the product in a combined listing.
If
null, then the product isn't part of any combined listing.- Anchor to compareAtPriceRangecompareAtPriceRange•ProductCompareAtPriceRange
The compare-at price range of the product in the shop's default currency.
- Anchor to contextualPricingcontextualPricing•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.
- Anchor to createdAtcreatedAt•DateTime!non-null
The date and time when the product was created.
- Anchor to defaultCursordefaultCursor•String!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 descriptionHtmldescriptionHtml•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•EventConnection!non-null
The paginated list of events associated with the host subject.
- Anchor to featuredMediafeaturedMedia•Media
The featured media associated with the product.
- Anchor to feedbackfeedback•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.
- 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 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.
- Anchor to inCollectioninCollection•Boolean!non-null
Whether the product is in a specified collection.
- Anchor to isGiftCardisGiftCard•Boolean!non-null
Whether the product is a gift card.
- Anchor to legacyResourceIdlegacyResourceId•UnsignedInt64!non-null
The ID of the corresponding resource in the REST Admin API.
- Anchor to mediamedia•MediaConnection!non-null
The media associated with the product. Valid media are images, 3D models, videos.
- Anchor to mediaCountmediaCount•Count
The total count of media that's associated with a product.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•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.
- Anchor to onlineStoreUrlonlineStoreUrl•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•[ProductOption!]!non-null
A list of product options. The limit is defined by the shop's resource limits for product options (
Shop.resourceLimits.maxProductOptions).- Anchor to priceRangeV2priceRangeV2•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.
- Anchor to productComponentsproductComponents•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.
- Anchor to productParentsproductParents•ProductConnection!non-null
A list of products that has a variant that contains any of this product's variants as a component.
- Anchor to productTypeproductType•String!non-null
The product type that merchants define.
- Anchor to publishedAtpublishedAt•DateTime
The date and time when the product was published to the online store.
- Anchor to publishedInContextpublishedInContext•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.
- Anchor to publishedOnPublicationpublishedOnPublication•Boolean!non-null
Whether the resource is published to a specified publication.
- Anchor to requiresSellingPlanrequiresSellingPlan•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 resourcePublicationsresourcePublications•ResourcePublicationConnection!non-null
The list of resources that are published to a publication.
- Anchor to resourcePublicationsCountresourcePublicationsCount•Count
The total number of publications that a resource is published to, including publications with feedback errors. To get a count that excludes publications with feedback errors, use
availablePublicationsCount.- Anchor to resourcePublicationsV2resourcePublicationsV2•ResourcePublicationV2Connection!non-null
The list of resources that are either published or staged to be published to a publication. By default, only publications to
APPcatalog types are returned. ForProductandProductVariant, use thecatalogTypeargument to retrieve publications for other catalog types, such asCOMPANY_LOCATION(B2B) orMARKET.Collectiononly supports publications toAPPcatalog types.- 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.
- Anchor to sellingPlanGroupssellingPlanGroups•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.
- Anchor to statusstatus•ProductStatus!non-null
The product status, which controls visibility across all sales channels.
- Anchor to tagstags•[String!]!non-null
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 thetagsAddmutation.- Anchor to templateSuffixtemplateSuffix•String
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 totalInventorytotalInventory•Int!non-null
The quantity of inventory that's in stock.
- Anchor to tracksInventorytracksInventory•Boolean!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 unpublishedPublicationsunpublishedPublications•PublicationConnection!non-null
The list of publications that the resource isn't published to.
- Anchor to updatedAtupdatedAt•DateTime!non-null
The date and time when the product was last modified. A product's
updatedAtvalue 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•ProductVariantConnection!non-null
A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2048 variants.
- Anchor to variantsCountvariantsCount•Count
The number of variants that are associated with the product.
- Anchor to vendorvendor•String!non-null
The name of the product's vendor.
Deprecated fields
- bodyHtml (String): deprecated
- customProductType (String): deprecated
- descriptionPlainSummary (String!): deprecated
- featuredImage (Image): deprecated
- images (ImageConnection!): deprecated
- metafieldDefinitions (MetafieldDefinitionConnection!): deprecated
- priceRange (ProductPriceRange!): deprecated
- productCategory (ProductCategory): deprecated
- productPublications (ProductPublicationConnection!): deprecated
- publicationCount (Int!): deprecated
- publications (ProductPublicationConnection!): deprecated
- publishedOnChannel (Boolean!): deprecated
- publishedOnCurrentChannel (Boolean!): deprecated
- publishedOnCurrentPublication (Boolean!): deprecated
- resourcePublicationOnCurrentPublication (ResourcePublicationV2): deprecated
- sellingPlanGroupCount (Int!): deprecated
- standardizedProductType (StandardizedProductType): deprecated
- storefrontId (StorefrontID!): deprecated
- totalVariants (Int!): deprecated
- unpublishedChannels (ChannelConnection!): deprecated
- Anchor to bodyHtmlbodyHtml•StringDeprecated
- Anchor to customProductTypecustomProductType•StringDeprecated
- Anchor to descriptionPlainSummarydescriptionPlainSummary•String!non-nullDeprecated
- Anchor to featuredImagefeaturedImage•ImageDeprecated
- Anchor to imagesimages•ImageConnection!non-nullDeprecated
- Anchor to metafieldDefinitionsmetafieldDefinitions•MetafieldDefinitionConnection!non-nullDeprecated
- Anchor to priceRangepriceRange•ProductPriceRange!non-nullDeprecated
- Anchor to productCategoryproductCategory•ProductCategoryDeprecated
- Anchor to productPublicationsproductPublications•ProductPublicationConnection!non-nullDeprecated
- Anchor to publicationCountpublicationCount•Int!non-nullDeprecated
- Anchor to publicationspublications•ProductPublicationConnection!non-nullDeprecated
- Anchor to publishedOnChannelpublishedOnChannel•Boolean!non-nullDeprecated
- Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel•Boolean!non-nullDeprecated
- Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication•Boolean!non-nullDeprecated
- Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication•ResourcePublicationV2Deprecated
- Anchor to sellingPlanGroupCountsellingPlanGroupCount•Int!non-nullDeprecated
- Anchor to standardizedProductTypestandardizedProductType•StandardizedProductTypeDeprecated
- Anchor to storefrontIdstorefrontId•StorefrontID!non-nullDeprecated
- Anchor to totalVariantstotalVariants•Int!non-nullDeprecated
- Anchor to unpublishedChannelsunpublishedChannels•ChannelConnection!non-nullDeprecated
Anchor to QueriesQueries
- product (Product)
- productByIdentifier (Product)
- products (ProductConnection!)
- productByHandle (Product): deprecated
- •query
Retrieves a product by its ID. A product is an item that a merchant can sell in their store.
Use the
productquery 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
productsquery 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
productsquery supports pagination to handle large product catalogs and saved searches for frequently used product queries.The
productsquery 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.
- •queryDeprecated
Anchor to MutationsMutations
- combinedListingUpdate (CombinedListingUpdatePayload)
- priceListFixedPricesByProductUpdate (PriceListFixedPricesByProductUpdatePayload)
- productCreate (ProductCreatePayload)
- productDuplicate (ProductDuplicatePayload)
- productJoinSellingPlanGroups (ProductJoinSellingPlanGroupsPayload)
- productLeaveSellingPlanGroups (ProductLeaveSellingPlanGroupsPayload)
- productOptionsCreate (ProductOptionsCreatePayload)
- productOptionsDelete (ProductOptionsDeletePayload)
- productOptionsReorder (ProductOptionsReorderPayload)
- productOptionUpdate (ProductOptionUpdatePayload)
- productSet (ProductSetPayload)
- productUpdate (ProductUpdatePayload)
- productVariantAppendMedia (ProductVariantAppendMediaPayload)
- productVariantDetachMedia (ProductVariantDetachMediaPayload)
- productVariantsBulkCreate (ProductVariantsBulkCreatePayload)
- productVariantsBulkDelete (ProductVariantsBulkDeletePayload)
- productVariantsBulkReorder (ProductVariantsBulkReorderPayload)
- productVariantsBulkUpdate (ProductVariantsBulkUpdatePayload)
- •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 aCombinedListing:- Parent products
- Child products
The parent product is created with a
productCreatewith aCombinedListingRoleofPARENT. 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
Sets or removes fixed prices for all variants of a
Producton aPriceList. Simplifies pricing management when all variants of a product should have the same price on a price list, rather than setting individual variant prices.When you add a fixed price for a product, all its
ProductVariantobjects receive the same price on the price list. When you remove a product's fixed prices, all variant prices revert to the price list's adjustment rules.- •mutation
Creates a product with attributes such as title, description, vendor, and media.
The
productCreatemutation 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
productCreatemutation only supports creating a product with its initial product variant. To create multiple product variants for a single product and manage prices, use theproductVariantsBulkCreatemutation.NoteThe
productCreatemutation 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.Note:The
productCreatemutation 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.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Create</span></code> mutation has a <a href="https://shopify.dev/docs/api/usage/rate-limits#resource-based-rate-limits">throttle</a> 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. TheproductCreatemutation 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: falseargument 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
productOptionsCreatemutation 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.
NoteThe
productOptionsCreatemutation 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 theCREATEvariant strategy, consider the maximum allowed number of variants for each product is 2048.Note:The
productOptionsCreatemutation 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 theCREATEvariant strategy, consider the maximum allowed number of variants for each product is 2048.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Options<wbr/>Create</span></code> 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 <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate#arguments-variantStrategy.enums.CREATE"><code>CREATE</code> variant strategy</a>, consider the maximum allowed number of variants for each product is 2048.
After you create product options, you can further manage a product's configuration using related mutations:
productOptionUpdateproductOptionsReorderproductOptionsDeleteproductVariantsBulkCreateproductVariantsBulkUpdateproductSet
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.
CautionCaution: Removing an option can affect a product's <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant">variants</a> and their configuration. Deleting an option might also delete associated option values and, depending on the chosen <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/productoptionsdelete#arguments-strategy">strategy</a>, might affect variants.
Use the
productOptionsDeletemutation 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.
NoteThe
productOptionsDeletemutation 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.Note:The
productOptionsDeletemutation 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.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Options<wbr/>Delete</span></code> 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:
productOptionsCreateproductOptionUpdateproductOptionsReorderproductVariantsBulkCreateproductVariantsBulkUpdateproductSet
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
productOptionsReordermutation accepts a list of product options, each identified byidorname, and an optional list of values (also byidorname) specifying the new order. The order of options in the mutation's input determines their new positions (for example, the first option becomesoption1). 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" }] }]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
productOptionsReordermutation 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.
NoteThe
productOptionsReordermutation 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.Note:The
productOptionsReordermutation 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.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Options<wbr/>Reorder</span></code> 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:
productOptionsCreateproductOptionsDeleteproductVariantsBulkCreateproductVariantsBulkUpdateproductSet
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
productOptionUpdatemutation 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.
NoteThe
productOptionUpdatemutation 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.Note:The
productOptionUpdatemutation 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.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Option<wbr/>Update</span></code> 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:
productOptionsCreateproductOptionsDeleteproductOptionsReorderproductVariantsBulkCreateproductVariantsBulkUpdateproductSet
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
productSetmutation 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
productSetdepends 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, andvariants.For all other field types: Updates only the included fields. Any omitted fields will remain unchanged.
NoteBy default, stores have a limit of 2048 product variants for each product.
Note:By default, stores have a limit of 2048 product variants for each product.
Note: By default, stores have a limit of 2048 product variants for each product.
You can run
productSetin one of the following modes:- Synchronously: Returns the updated product in the response.
- Asynchronously: Returns a
ProductSetOperationobject. Use theproductOperationquery 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
productUpdatemutation 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
productUpdatemutation doesn't support updating product variants. To update multiple product variants for a single product and manage prices, use theproductVariantsBulkUpdatemutation.NoteThe
productUpdatemutation 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.Note:The
productUpdatemutation 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.Note: The <code><span class="PreventFireFoxApplyingGapToWBR">product<wbr/>Update</span></code> mutation has a <a href="https://shopify.dev/docs/api/usage/rate-limits#resource-based-rate-limits">throttle</a> 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 existing media from a product to specific variants of that product, creating associations between media files and particular product options. This allows different variants to showcase relevant images or videos.
For example, a t-shirt product might have color variants where each color variant displays only the images showing that specific color, helping customers see exactly what they're purchasing.
Use
ProductVariantAppendMediato:- Associate specific images with product variants for accurate display
- Build variant-specific media management in product interfaces
- Implement automated media assignment based on variant attributes
The operation links existing product media to variants without duplicating files, maintaining efficient media storage while enabling variant-specific displays.
Learn more about product variants.
- •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
productVariantsBulkCreatemutation 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 option values
- Associating media (for example, images, videos, and 3D models) with the product or its variants
- Handling complex product configurations
NoteBy default, stores have a limit of 2048 product variants for each product.
Note:By default, stores have a limit of 2048 product variants for each product.
Note: By default, stores have a limit of 2048 product variants for each product.
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. Specify the product ID and an array of variant IDs to remove variants in bulk. You can call this mutation directly or through thebulkOperationRunMutationmutation. Returns the updated product and anyUserErrorobjects.- •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
productVariantsBulkUpdatemutation 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 option values
- Associating media (for example, images, videos, and 3D models) with the product or its variants
- Handling complex product configurations
NoteBy default, stores have a limit of 2048 product variants for each product.
Note:By default, stores have a limit of 2048 product variants for each product.
Note: By default, stores have a limit of 2048 product variants for each product.
After creating variants, you can make additional changes using the
productSetmutation, 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
- productChangeStatus (ProductChangeStatusPayload): deprecated
- productCreateMedia (ProductCreateMediaPayload): deprecated
- productDeleteMedia (ProductDeleteMediaPayload): deprecated
- productPublish (ProductPublishPayload): deprecated
- productUnpublish (ProductUnpublishPayload): deprecated
- productUpdateMedia (ProductUpdateMediaPayload): deprecated
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated
Anchor to InterfacesInterfaces
- HasEvents
- HasMetafieldDefinitions
- HasMetafields
- HasPublishedTranslations
- LegacyInteroperability
- Navigable
- Node
- OnlineStorePreviewable
- Publishable
- •interface
- •interface
- •interface
- •interface
- •interface
