productDeleteAsync

mutationDeprecated

Requires write_products access scope. Also: The user must have a permission to delete a product.

Deletes a product asynchronously, including all associated variants and media. Use productDelete instead.

Arguments

Anchor to productIdproductId • ID!required: The ID of the product to be deleted.

Was this section helpful?

Anchor to ProductDeleteAsyncPayload returnsProductDeleteAsyncPayload returns

Anchor to deleteProductIddeleteProductId • ID: The ID of the product that was requested to be deleted.
Anchor to jobjob • Job: The background job that will delete the product and its associated variants and media.
Anchor to userErrorsuserErrors • [ProductDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation productDeleteAsync($productId: ID!) {
2  productDeleteAsync(productId: $productId) {
3    deleteProductId
4    job {
5      # Job fields
6    }
7    userErrors {
8      field
9      message
10    }
11  }
12}

Input

1{
2  "productId": "gid://shopify/<objectName>/10079785100"
3}

{
  "productId": "gid://shopify/<objectName>/10079785100"
}