productDeleteImages mutation

Removes a product images from the 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 productDeleteImages($id: ID!, $imageIds: [ID!]!) { productDeleteImages(id: $id, imageIds: $imageIds) { 
  1. <font style="color:#1F61A0;">deletedImageIds</font>
  3. <font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  5.   <font style="color:#1F61A0;">id</font>
  7. <font style="color:#555555;">}</font>
  9. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “imageIds”: [ 
  1. <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
] }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 This is the ID of the product.
imageIds
(
[[ID!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 This is the array of image IDs to delete from the product.

Return fields

  • deletedImageIds ([[ID!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    This is an array of IDs of images to delete.
  • product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    This is the product object.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.