mutation">productImageUpdate mutation
- Required access
On this page
Interactive example
Arguments
ImageInput fields
Return fields

productImageUpdate mutation

Updates an image of a product.

Required access

write_products access scope.

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.

mutation productImageUpdate($productId: ID!, $image: ImageInput!) { productImageUpdate(productId: $productId, image: $image) {

<font style="color:#1F61A0;">image</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>

} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “image”: {} }

Arguments

Argument	Description
`image` ( `[ImageInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/imageinput)` ) REQUIRED	Image to be updated.
`productId` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the product on which to update the image.

ImageInput fields

altText ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
A word or phrase to share the nature or contents of an image.
id ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
Globally unique identifier.
src ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
The URL of the image. May be a signed upload URL.

Return fields

image ([Image](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
Image updated.

Argument	Description
`crop` ( `[CropRegion](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/cropregion)` )	Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead.
`maxHeight` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead.
`maxWidth` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
`scale` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. Default value: `1`

userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
List of errors that occurred executing the mutation.