Anchor to productVariantsBulkDeleteproduct
product Variants Bulk Delete
mutation
Requires access scope. Also: The user must have a permission to delete product variants.
Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
Anchor to Arguments
Arguments
- Anchor to productIdproduct•
Id ID!required The ID of the product with the variants to update.
- Anchor to variantsIdsvariants•
Ids [ID!]!required An array of product variants IDs to delete.
Was this section helpful?
- Anchor to productproduct•
The updated product object.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Was this section helpful?
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {6 productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {7 product {8 id9 title10 }11 userErrors {12 field13 message14 }15 }16 }`,17 {18 variables: {19 "productId": "gid://shopify/Product/20995642",20 "variantsIds": [21 "gid://shopify/ProductVariant/30322695",22 "gid://shopify/ProductVariant/113711323"23 ]24 },25 },26);2728const data = await response.json();29
mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {
productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
product {
id
title
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) { productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) { product { id title } userErrors { field message } } }",
"variables": {
"productId": "gid://shopify/Product/20995642",
"variantsIds": [
"gid://shopify/ProductVariant/30322695",
"gid://shopify/ProductVariant/113711323"
]
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {
productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
product {
id
title
}
userErrors {
field
message
}
}
}`,
{
variables: {
"productId": "gid://shopify/Product/20995642",
"variantsIds": [
"gid://shopify/ProductVariant/30322695",
"gid://shopify/ProductVariant/113711323"
]
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {
productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
product {
id
title
}
userErrors {
field
message
}
}
}`,
"variables": {
"productId": "gid://shopify/Product/20995642",
"variantsIds": [
"gid://shopify/ProductVariant/30322695",
"gid://shopify/ProductVariant/113711323"
]
},
},
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {
productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
product {
id
title
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"productId": "gid://shopify/Product/20995642",
"variantsIds": ["gid://shopify/ProductVariant/30322695", "gid://shopify/ProductVariant/113711323"]
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "productId": "gid://shopify/Product/20995642",3 "variantsIds": [4 "gid://shopify/ProductVariant/30322695",5 "gid://shopify/ProductVariant/113711323"6 ]7}
Response
JSON1{2 "productVariantsBulkDelete": {3 "product": {4 "id": "gid://shopify/Product/20995642",5 "title": "Element"6 },7 "userErrors": []8 }9}