Product
Requires 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 , , or .
The field provides the ID of the deleted product.
The field provides mutation errors that occurred during the operation.
Anchor to FieldsFields
- Anchor to deletedProductIddeleted•ID
Product Id The ID of the deleted product.
- •ID!non-null
A globally-unique ID.
- Anchor to productproduct•Product
The product on which the operation is being performed.
- Anchor to statusstatus•Product
Operation Status!non-null The status of this operation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null Returns mutation errors occurred during background mutation processing.
Anchor to MutationsMutations
- •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.- Anchor to inputinput•Product
Delete Input!required Specifies the product to delete by its ID.
- Anchor to synchronoussynchronous•BooleanDefault:true
Specifies whether or not to run the mutation synchronously.
Arguments
- Anchor to deletedProductIddeleted•ID
Product Id The ID of the deleted product.
- Anchor to productDeleteOperationproduct•Product
Delete Operation Delete Operation The product delete operation, returned when run in asynchronous mode.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields