productDeleteImages mutation

Version 2020-01 (Release candidate)

Removes a product images from the 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.


Arguments

id ( ID! ) required

This is the ID of the product.

imageIds ( [ID!]! ) required

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

Return fields

deletedImageIds ([ID!]!)

This is an array of IDs of images to delete.

product (Product)

This is the product object.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

Removes a product images from the 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.


Arguments

id ( ID! ) required

This is the ID of the product.

imageIds ( [ID!]! ) required

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

Return fields

deletedImageIds ([ID!]!)

This is an array of IDs of images to delete.

product (Product)

This is the product object.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

Removes a product images from the 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.


Arguments

id ( ID! ) required

This is the ID of the product.

imageIds ( [ID!]! ) required

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

Return fields

deletedImageIds ([ID!]!)

This is an array of IDs of images to delete.

product (Product)

This is the product object.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04

Removes a product images from the 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.


Arguments

id ( ID! ) required

This is the ID of the product.

imageIds ( [ID!]! ) required

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

Return fields

deletedImageIds ([ID!]!)

This is an array of IDs of images to delete.

product (Product)

This is the product object.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up