ProductDeleteOperation - admin-graphql - OBJECT
Version: 2024-10
Description:
An entity that represents details of an asynchronous
[ProductDelete](https://shopify.dev/api/admin-graphql/current/mutations/productDelete) mutation.
By querying this entity with the
[productOperation](https://shopify.dev/api/admin-graphql/current/queries/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.
Access Scopes
`read_products` access scope.
Fields
-
deletedProductId:
ID -
The ID of the deleted product.
-
id:
ID! -
A globally-unique ID.
-
product:
Product -
The product on which the operation is being performed.
-
status:
ProductOperationStatus! -
The status of this operation.
-
userErrors:
UserError! -
Returns mutation errors occurred during background mutation processing.
Connections
Related queries
Related mutations
-
productDelete
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](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)
that are active at several
[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),
you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous
[ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync)
mutation.
Related Unions
Examples