productVariantUpdate mutation

Updates a product variant.

Required access

write_products access scope.

On this page

• Interactive example
• Arguments
• ProductVariantInput 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;">productVariant</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

ProductVariantInput fields

• barcode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The value of the barcode associated with the product.
• compareAtPrice ([Money](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  The compare-at price of the variant.
• fulfillmentServiceId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The ID of the fulfillment service associated with the variant.
• harmonizedSystemCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The Harmonized System Code (or HS Tariff Code) for the variant.
• id ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Specifies the product variant to update or create a new variant if absent.
• imageId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The ID of the image that’s associated with the variant.
• imageSrc ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The URL of an image to associate with the variant. This field can only be used through mutations that create product images and must match one of the URLs being created on the product.
• inventoryItem ([InventoryItemInput](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryiteminput))
  Inventory Item associated with the variant, used for unit cost.
• inventoryManagement ([ProductVariantInventoryManagement](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantinventorymanagement))
  The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to shopify. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. This argument is deprecated: Use tracked attribute on inventoryItem instead.
• inventoryPolicy ([ProductVariantInventoryPolicy](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantinventorypolicy))
  Whether customers are allowed to place an order for the product variant when it’s out of stock.
• inventoryQuantities ([[InventoryLevelInput!]](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevelinput))
  Create only field. The inventory quantities at each location where the variant is stocked.
• mediaSrc ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value.
• metafields ([[MetafieldInput!]](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldinput))
  Additional customizable information about the product variant.
• options ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The custom properties that a shop owner uses to define product variants.
• position ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The order of the product variant in the list of product variants. The first position in the list is 1.
• price ([Money](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  The price of the variant.
• privateMetafields ([[PrivateMetafieldInput!]](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldinput))
  The private metafields to associated with this product.
• productId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Create only required field. Specifies the product on which to create the variant.
• requiresShipping ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the variant requires shipping.
• sku ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The SKU for the variant.
• taxCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The tax code associated with the variant.
• taxable ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the variant is taxable.
• title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  This argument is deprecated: Variant title is not a writable field; it is generated from the selected variant options.
• weight ([Float](https://shopify.dev/docs/admin-api/graphql/reference/scalar#float-2021-01))
  The weight of the variant.
• weightUnit ([WeightUnit](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/weightunit))
  The unit of weight that’s used to measure the variant.

Return fields

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