productVariantsBulkDelete

mutation

Requires write_products 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.

Arguments

Anchor to productIdproductId • ID!required: The ID of the product with the variants to update.
Anchor to variantsIdsvariantsIds • [ID!]!required: An array of product variants IDs to delete.

Was this section helpful?

Anchor to ProductVariantsBulkDeletePayload returnsProductVariantsBulkDeletePayload returns

Anchor to productproduct • Product: The updated product object.
Anchor to userErrorsuserErrors • [ProductVariantsBulkDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {
6    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
7      product {
8        id
9        title
10      }
11      userErrors {
12        field
13        message
14      }
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);
27
28const 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

JSON

1{
2  "productId": "gid://shopify/Product/20995642",
3  "variantsIds": [
4    "gid://shopify/ProductVariant/30322695",
5    "gid://shopify/ProductVariant/113711323"
6  ]
7}

Response

JSON

1{
2  "productVariantsBulkDelete": {
3    "product": {
4      "id": "gid://shopify/Product/20995642",
5      "title": "Element"
6    },
7    "userErrors": []
8  }
9}