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 Fields and connectionsFields and connections

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 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 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.
Anchor to idid •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 mediaCountmediaCount •Count: The total count of media that's associated with a product.
Anchor to metafieldmetafield •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.
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 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 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.
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 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.
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.
Anchor to seoseo •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 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.
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 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.
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 2000 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 and connections

Anchor to bodyHtmlbodyHtml •String Deprecated
Anchor to customProductTypecustomProductType •String Deprecated
Anchor to descriptionPlainSummarydescriptionPlainSummary •String! non-nullDeprecated
Anchor to featuredImagefeaturedImage •Image Deprecated
Anchor to imagesimages •ImageConnection! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to priceRangepriceRange •ProductPriceRange! non-nullDeprecated
Anchor to productCategoryproductCategory •ProductCategory Deprecated
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 sellingPlanGroupCountsellingPlanGroupCount •Int! non-nullDeprecated
Anchor to standardizedProductTypestandardizedProductType •StandardizedProductType Deprecated
Anchor to storefrontIdstorefrontId •StorefrontID! non-nullDeprecated
Anchor to totalVariantstotalVariants •Int! non-nullDeprecated
Anchor to unpublishedChannelsunpublishedChannels •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

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 optionsAndValuesoptionsAndValues •[OptionAndValueInput!]: The ordered options and values to be used by the combined listing. Options and values will be reordered to match the order specified here.
Anchor to parentProductIdparentProductId •ID! required: The ID of the parent product.
Anchor to productsAddedproductsAdded •[ChildProductRelationInput!]: The child products to add and their assigned options and option values.
Anchor to productsEditedproductsEdited •[ChildProductRelationInput!]: The child products to edit and their assigned options and option values.
Anchor to productsRemovedIdsproductsRemovedIds •[ID!]: The IDs of products to be removed from the combined listing.
Anchor to titletitle •String: The updated title for the combined listing.

Anchor to productproduct •Product: The parent product.
Anchor to userErrorsuserErrors •[CombinedListingUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

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 priceListIdpriceListId •ID! required: The price list to update the prices for.
Anchor to pricesToAddpricesToAdd •[PriceListProductPriceInput!]: A list of PriceListProductPriceInput that identifies which products to update the fixed prices for.
Anchor to pricesToDeleteByProductIdspricesToDeleteByProductIds •[ID!]: A list of product IDs that identifies which products to remove the fixed prices for.

Anchor to priceListpriceList •PriceList: The price list for which the fixed prices were modified.
Anchor to pricesToAddProductspricesToAddProducts •[Product!]: The product for which the fixed prices were added.
Anchor to pricesToDeleteProductspricesToDeleteProducts •[Product!]: The product for which the fixed prices were deleted.
Anchor to userErrorsuserErrors •[PriceListFixedPricesByProductBulkUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

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 inputinput •ProductInput Deprecated
Anchor to mediamedia •[CreateMediaInput!]: The media to add to the product.
Anchor to productproduct •ProductCreateInput: The attributes of the new product.

Anchor to productproduct •Product: The product object.
Anchor to shopshop •Shop! non-null: The shop associated with the product.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 includeImagesincludeImages •Boolean Default:false: Specifies whether or not to duplicate images.
Anchor to includeTranslationsincludeTranslations •Boolean Default:false: Specifies whether or not to duplicate translations.
Anchor to newStatusnewStatus •ProductStatus: The new status of the product. If no value is provided the status will be inherited from the original product.
Anchor to newTitlenewTitle •String! required: The new title of the product.
Anchor to productIdproductId •ID! required: The ID of the product to be duplicated.
Anchor to synchronoussynchronous •Boolean Default:true: Specifies whether or not to run the mutation synchronously.

Anchor to imageJobimageJob •Job: The asynchronous job that duplicates the product images.
Anchor to newProductnewProduct •Product: The duplicated product.
Anchor to productDuplicateOperationproductDuplicateOperation •ProductDuplicateOperation: The product duplicate operation, returned when run in asynchronous mode.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

productJoinSellingPlanGroups

•mutation

Adds multiple selling plan groups to a product.

Anchor to idid •ID! required: The ID of the product.
Anchor to sellingPlanGroupIdssellingPlanGroupIds •[ID!]! required: The IDs of the selling plan groups to add.

Anchor to productproduct •Product: The product object.
Anchor to userErrorsuserErrors •[SellingPlanGroupUserError!]! non-null: The list of errors that occurred from executing the mutation.

productLeaveSellingPlanGroups

•mutation

Removes multiple groups from a product.

Anchor to idid •ID! required: The ID of the product.
Anchor to sellingPlanGroupIdssellingPlanGroupIds •[ID!]! required: The IDs of the selling plan groups to add.

Anchor to productproduct •Product: The product object.
Anchor to userErrorsuserErrors •[SellingPlanGroupUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and adding product data.

Anchor to optionsoptions •[OptionCreateInput!]! required: Options to add to the product.
Anchor to productIdproductId •ID! required: The ID of the product to update.
Anchor to variantStrategyvariantStrategy •ProductOptionCreateVariantStrategy Default:LEAVE_AS_IS: The strategy defines which behavior the mutation should observe regarding variants. If not provided or set to null, the strategy LEAVE_AS_IS will be used.

Anchor to productproduct •Product: The updated product object.
Anchor to userErrorsuserErrors •[ProductOptionsCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and adding product data.

Anchor to optionsoptions •[ID!]! required: IDs of the options to delete from the product.
Anchor to productIdproductId •ID! required: ID of the product from which to delete the options.
Anchor to strategystrategy •ProductOptionDeleteStrategy Default:DEFAULT: The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.

Anchor to deletedOptionsIdsdeletedOptionsIds •[ID!]: IDs of the options deleted.
Anchor to productproduct •Product: The updated product object.
Anchor to userErrorsuserErrors •[ProductOptionsDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and managing product data.

Anchor to optionsoptions •[OptionReorderInput!]! required: Options to reorder on the product.
Anchor to productIdproductId •ID! required: The ID of the product to update.

Anchor to productproduct •Product: The updated product object.
Anchor to userErrorsuserErrors •[ProductOptionsReorderUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and adding product data.

Anchor to optionoption •OptionUpdateInput! required: Option to update.
Anchor to optionValuesToAddoptionValuesToAdd •[OptionValueCreateInput!]: New option values to create.
Anchor to optionValuesToDeleteoptionValuesToDelete •[ID!]: IDs of the existing option values to delete.
Anchor to optionValuesToUpdateoptionValuesToUpdate •[OptionValueUpdateInput!]: Existing option values to update.
Anchor to productIdproductId •ID! required: The ID of the Product the Option belongs to.
Anchor to variantStrategyvariantStrategy •ProductOptionUpdateVariantStrategy: The strategy defines which behavior the mutation should observe regarding variants, such as creating variants or deleting them in response to option values to add or to delete. If not provided or set to null, the strategy LEAVE_AS_IS will be used.

Anchor to productproduct •Product: The product with which the option being updated is associated.
Anchor to userErrorsuserErrors •[ProductOptionUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

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.

Anchor to identifieridentifier •ProductSetIdentifiers: Specifies the identifier that will be used to lookup the resource.
Anchor to inputinput •ProductSetInput! required: The properties of the newly created or updated product.
Anchor to synchronoussynchronous •Boolean Default:true: Whether the mutation should be run synchronously or asynchronously.

If true, the mutation will return the updated product.

If false, the mutation will return a productSetOperation.

Defaults to true.

Setting synchronous: false may be desirable depending on the input complexity/size, and should be used if you are experiencing timeouts.

Note: When run in the context of a bulk operation, the mutation will always run synchronously and this argument will be ignored.

Anchor to productproduct •Product: The product object.
Anchor to productSetOperationproductSetOperation •ProductSetOperation: The product set operation, returned when run in asynchronous mode.
Anchor to userErrorsuserErrors •[ProductSetUserError!]! non-null: The list of errors that occurred from executing the mutation.

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 inputinput •ProductInput Deprecated
Anchor to mediamedia •[CreateMediaInput!]: List of new media to be added to the product.
Anchor to productproduct •ProductUpdateInput: The updated properties for a product.

Anchor to productproduct •Product: The updated product object.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

productVariantAppendMedia

•mutation

Appends media from a product to variants of the product.

Anchor to productIdproductId •ID! required: Specifies the product associated to the media.
Anchor to variantMediavariantMedia •[ProductVariantAppendMediaInput!]! required: A list of pairs of variants and media to be attached to the variants.

Anchor to productproduct •Product: The product associated with the variants and media.
Anchor to productVariantsproductVariants •[ProductVariant!]: The product variants that were updated.
Anchor to userErrorsuserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.

productVariantDetachMedia

•mutation

Detaches media from product variants.

Anchor to productIdproductId •ID! required: Specifies the product to which the variants and media are associated.
Anchor to variantMediavariantMedia •[ProductVariantDetachMediaInput!]! required: A list of pairs of variants and media to be deleted from the variants.

Anchor to productproduct •Product: The product associated with the variants and media.
Anchor to productVariantsproductVariants •[ProductVariant!]: The product variants that were updated.
Anchor to userErrorsuserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and adding product data.

Anchor to mediamedia •[CreateMediaInput!]: List of new media to be added to the product.
Anchor to productIdproductId •ID! required: The ID of the product on which to create the variants.
Anchor to strategystrategy •ProductVariantsBulkCreateStrategy Default:DEFAULT: The strategy defines which behavior the mutation should observe, such as whether to keep or delete the standalone variant (when product has only a single or default variant) when creating new variants in bulk.
Anchor to variantsvariants •[ProductVariantsBulkInput!]! required: An array of product variants to be created.

Anchor to productproduct •Product: The updated product object.
Anchor to productVariantsproductVariants •[ProductVariant!]: The newly created variants.
Anchor to userErrorsuserErrors •[ProductVariantsBulkCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

productVariantsBulkDelete

•mutation

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

Anchor to productIdproductId •ID! required: The ID of the product with the variants to update.
Anchor to variantsIdsvariantsIds •[ID!]! required: An array of product variants IDs to delete.

Anchor to productproduct •Product: The updated product object.
Anchor to userErrorsuserErrors •[ProductVariantsBulkDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

productVariantsBulkReorder

•mutation

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

Anchor to positionspositions •[ProductVariantPositionInput!]! required: An array of variant positions.
Anchor to productIdproductId •ID! required: The product ID of the variants to be reordered.

Anchor to productproduct •Product: The updated product.
Anchor to userErrorsuserErrors •[ProductVariantsBulkReorderUserError!]! non-null: The list of errors that occurred from executing the mutation.

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:

Learn more about the product model and adding product data.

Anchor to allowPartialUpdatesallowPartialUpdates •Boolean Default:false: When partial updates are allowed, valid variant changes may be persisted even if some of the variants updated have invalid data and cannot be persisted. When partial updates are not allowed, any error will prevent all variants from updating.
Anchor to mediamedia •[CreateMediaInput!]: List of new media to be added to the product.
Anchor to productIdproductId •ID! required: The ID of the product associated with the variants to update.
Anchor to variantsvariants •[ProductVariantsBulkInput!]! required: An array of product variants to update.

Anchor to productproduct •Product: The updated product object.
Anchor to productVariantsproductVariants •[ProductVariant!]: The updated variants.
Anchor to userErrorsuserErrors •[ProductVariantsBulkUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Deprecated mutations

productChangeStatus

•mutation

Deprecated

Anchor to productIdproductId •ID! required: The ID of the product.
Anchor to statusstatus •ProductStatus! required: The status to be assigned to the product.

Anchor to productproduct •Product: The product object.
Anchor to userErrorsuserErrors •[ProductChangeStatusUserError!]! non-null: The list of errors that occurred from executing the mutation.

productCreateMedia

•mutation

Deprecated

Anchor to mediamedia •[CreateMediaInput!]! required: List of new media to be added to a product.
Anchor to productIdproductId •ID! required: Specifies the product associated with the media.

Anchor to mediamedia •[Media!]: The newly created media.
Anchor to mediaUserErrorsmediaUserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to productproduct •Product: The product associated with the media.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated

productDeleteMedia

•mutation

Deprecated

Anchor to mediaIdsmediaIds •[ID!]! required: The media IDs to be deleted.
Anchor to productIdproductId •ID! required: Specifies the product ID from which the media will be deleted.

Anchor to deletedMediaIdsdeletedMediaIds •[ID!]: List of media IDs which were deleted.
Anchor to deletedProductImageIdsdeletedProductImageIds •[ID!]: List of product image IDs which were deleted.
Anchor to mediaUserErrorsmediaUserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to productproduct •Product: The product associated with the deleted media.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated

productPublish

•mutation

Deprecated

Anchor to inputinput •ProductPublishInput! required: Specifies the product to publish and the channels to publish it to.

Anchor to productproduct •Product: The product that has been published.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to productPublicationsproductPublications •[ProductPublication!] Deprecated

productUnpublish

•mutation

Deprecated

Anchor to inputinput •ProductUnpublishInput! required: Specifies the product to unpublish and the channel to unpublish it from.

Anchor to productproduct •Product: The product that has been unpublished.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

productUpdateMedia

•mutation

Deprecated

Anchor to mediamedia •[UpdateMediaInput!]! required: A list of media updates.
Anchor to productIdproductId •ID! required: Specifies the product on which media will be updated.

Anchor to mediamedia •[Media!]: The updated media object.
Anchor to mediaUserErrorsmediaUserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to productproduct •Product: The product on which media was updated.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasEvents HasEvents •interface
Anchor to HasMetafieldDefinitions HasMetafieldDefinitions •interface
Anchor to HasMetafields HasMetafields •interface
Anchor to HasPublishedTranslations HasPublishedTranslations •interface
Anchor to LegacyInteroperability LegacyInteroperability •interface
Anchor to Navigable Navigable •interface
Anchor to Node Node •interface
Anchor to OnlineStorePreviewable OnlineStorePreviewable •interface
Anchor to Publishable Publishable •interface

Was this section helpful?

Anchor to Fields and connectionsFields and connections

Deprecated fields and connections

Anchor to QueriesQueries

Anchor to MutationsMutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Deprecated mutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Anchor to InterfacesInterfaces