productDelete mutation

Version 2020-01 (Release candidate)

Deletes a 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

input ( ProductDeleteInput! ) required

Specifies the product to delete by its ID.

ProductDeleteInput fields

id (ID!) Required

The ID of the product.

Return fields

deletedProductId (ID)

The ID of the deleted product.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

Deletes a 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

input ( ProductDeleteInput! ) required

Specifies the product to delete by its ID.

ProductDeleteInput fields

id (ID!) Required

The ID of the product.

Return fields

deletedProductId (ID)

The ID of the deleted product.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

Deletes a 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

input ( ProductDeleteInput! ) required

Specifies the product to delete by its ID.

ProductDeleteInput fields

id (ID!) Required

The ID of the product.

Return fields

deletedProductId (ID)

The ID of the deleted product.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04

Deletes a 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

input ( ProductDeleteInput! ) required

Specifies the product to delete by its ID.

ProductDeleteInput fields

id (ID!) Required

The ID of the product.

Return fields

deletedProductId (ID)

The ID of the deleted product.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up