productDeleteImages mutation

Version unstable

Removes 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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Removes 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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Removes 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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-04

Removes 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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-01

Removes product images from the product.

Required access

write_products access scope.