API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

productDeleteImages mutation

Version unstable

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

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

    List of errors that occurred executing the mutation.

Version 2021-04 (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

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

    List of errors that occurred executing the mutation.

Version 2021-01 (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

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

    List of errors that occurred executing the mutation.

Version 2020-10

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

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

    List of errors that occurred executing the mutation.

Version 2020-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

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

    List of errors that occurred executing the mutation.

Version 2020-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

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

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

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

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

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

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

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

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

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

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

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

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

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

    List of errors that occurred executing the mutation.