productUpdate mutation

Updates a product. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be updated only on online stores. If you update a product to be sold only on a subscription, then the product is unpublished from all channels except the online store.

Required access

write_products access scope.

On this page

• Interactive example
• Arguments
• ProductInput fields
• Return fields

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

<font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

ProductInput fields

• bodyHtml ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.
• collectionsToJoin ([[ID!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The IDs of the collections that this product will be added to.
• collectionsToLeave ([[ID!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The IDs of collections that will no longer include the product.
• descriptionHtml ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The description of the product, complete with HTML formatting.
• giftCard ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the product is a gift card.
• giftCardTemplateSuffix ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The theme template used when viewing the gift card in a store.
• handle ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A unique human-friendly string for the product. Automatically generated from the product’s title.
• id ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Specifies the product to update in productUpdate or creates a new product if absent in productCreate.
• images ([[ImageInput!]](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/imageinput))
  The images to associate with the product.
• metafields ([[MetafieldInput!]](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldinput))
  The metafields to associate with this product.
• options ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  List of custom product options (maximum of 3 per product).
• privateMetafields ([[PrivateMetafieldInput!]](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldinput))
  The private metafields to associated with this product.
• productPublications ([[ProductPublicationInput!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productpublicationinput))
  A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.
• productType ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The product type specified by the merchant.
• publications ([[ProductPublicationInput!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productpublicationinput))
  A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.
• publishDate ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Only products with an active status can be published. This argument is deprecated: Use PublishablePublish instead.
• publishOn ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Only products with an active status can be published. This argument is deprecated: Use PublishablePublish instead.
• published ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Only products with an active status can be published. This argument is deprecated: Use PublishablePublish instead.
• publishedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Only products with an active status can be published. This argument is deprecated: Use PublishablePublish instead.
• redirectNewHandle ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically.
• requiresSellingPlan ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the product can only be purchased with a selling plan. If set to true on an already existing product, then the product will be marked unavailable on channels that don’t support subscriptions.
• seo ([SEOInput](https://shopify.dev/docs/admin-api/graphql/reference/online-store/seoinput))
  The SEO information associated with the product.
• status ([ProductStatus](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productstatus))
  The status of the product.
• tags ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A comma separated list tags that have been added to the product.
• templateSuffix ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The theme template used when viewing the product in a store.
• title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The title of the product.
• variants ([[ProductVariantInput!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantinput))
  A list of variants associated with the product.
• vendor ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The name of the product’s vendor.

Return fields

• product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
  The updated product.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.