ProductDeleteOperation
object

Choose a version:

Requires read_products access scope.

An entity that represents details of an asynchronous ProductDelete mutation.

By querying this entity with the productOperation query using the ID that was returned when the product was deleted, this can be used to check the status of an operation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The deletedProductId field provides the ID of the deleted product.

The userErrors field provides mutation errors that occurred during the operation.

Anchor to section titled 'Fields'

Fields

Anchor to ProductDeleteOperation.deletedProductId deletedProductId ID: The ID of the deleted product.
Anchor to ProductDeleteOperation.id id ID! non-null: A globally-unique ID.
Anchor to ProductDeleteOperation.product product Product: The product on which the operation is being performed.
Anchor to ProductDeleteOperation.status status ProductOperationStatus! non-null: The status of this operation.
Anchor to ProductDeleteOperation.userErrors userErrors [UserError!]! non-null: Returns mutation errors occurred during background mutation processing.

Was this section helpful?

Anchor to section titled 'Mutations'

Mutations

Anchor to productDelete productDelete mutation: Deletes a product, including all associated variants and media.

As of API version 2023-01, if you need to delete a large product, such as one that has many variants that are active at several locations, you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous ProductDeleteAsync mutation.