productAppendImages mutation

Appends images to a product.

Required access

write_products access scope.

On this page

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 productAppendImages($input: ProductAppendImagesInput!) { productAppendImages(input: $input) { 
  1. <font style="color:#1F61A0;">newImages</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"images"</font><font style="color:#555555;">:</font> <font style="color:#555555;">[</font>
  5.   <font style="color:#555555;">{}</font>
  7. <font style="color:#555555;">]</font>
} }

Arguments

Argument Description
input
(
[ProductAppendImagesInput!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productappendimagesinput)

) REQUIRED		 Specifies the new images and the product that they’re being added to.

ProductAppendImagesInput fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the product.
  • images ([[ImageInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/imageinput)) REQUIRED
    The images to be appended to the product.

Return fields

  • newImages ([[Image!]](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
    List of new images appended to the product.
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
  • product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    The product object.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.