productVariantsBulkDelete - admin-graphql - MUTATION

Version: 2024-04

Description:

Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Access Scopes

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

Arguments

• productId: ID! - The ID of the product with the variants to update.
• variantsIds: ID! - An array of product variants IDs to delete.

Returns

• product: Product The updated product object.
• userErrors: ProductVariantsBulkDeleteUserError! The list of errors that occurred from executing the mutation.

Examples

• Bulk delete multiple product variants.

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) { productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) { product { id title } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/20995642\",\n    \"variantsIds\": [\n      \"gid://shopify/ProductVariant/30322695\",\n      \"gid://shopify/ProductVariant/113711323\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n      productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n        product {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/20995642\",\n  \"variantsIds\": [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/113711323\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/20995642\",\n  \"variantsIds\" => [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/113711323\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n  productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n    product {\n      id\n      title\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/20995642",
    "variantsIds": [
      "gid://shopify/ProductVariant/30322695",
      "gid://shopify/ProductVariant/113711323"
    ]
  }

  response: {
    "data": {
      "productVariantsBulkDelete": {
        "product": {
          "id": "gid://shopify/Product/20995642",
          "title": "Element"
        },
        "userErrors": []
      }
    }
  }

  Remove an existing Product Variant

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) { productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) { product { id title } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/20995642\",\n    \"variantsIds\": [\n      \"gid://shopify/ProductVariant/30322695\",\n      \"gid://shopify/ProductVariant/113711323\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) {\n      productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n        product {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/20995642\",\n  \"variantsIds\": [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/113711323\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/20995642\",\n  \"variantsIds\" => [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/113711323\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation ProductVariantsDelete($productId: ID!, $variantsIds: [ID!]!) {\n  productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n    product {\n      id\n      title\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/20995642",
    "variantsIds": [
      "gid://shopify/ProductVariant/30322695",
      "gid://shopify/ProductVariant/113711323"
    ]
  }

  response: {
    "data": {
      "productVariantsBulkDelete": {
        "product": {
          "id": "gid://shopify/Product/20995642",
          "title": "Element"
        },
        "userErrors": []
      }
    }
  }

  Returns an error if any of the product variants does not belong to the product.

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) { productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) { product { id title } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/20995642\",\n    \"variantsIds\": [\n      \"gid://shopify/ProductVariant/30322695\",\n      \"gid://shopify/ProductVariant/-1\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n      productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n        product {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/-1\"\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/20995642\",\n  \"variantsIds\": [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/-1\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/20995642\",\n  \"variantsIds\" => [\"gid://shopify/ProductVariant/30322695\", \"gid://shopify/ProductVariant/-1\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n    productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/20995642\",\n      \"variantsIds\": [\n        \"gid://shopify/ProductVariant/30322695\",\n        \"gid://shopify/ProductVariant/-1\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation bulkDeleteProductVariants($productId: ID!, $variantsIds: [ID!]!) {\n  productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {\n    product {\n      id\n      title\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/20995642",
    "variantsIds": [
      "gid://shopify/ProductVariant/30322695",
      "gid://shopify/ProductVariant/-1"
    ]
  }

  response: {
    "data": {
      "productVariantsBulkDelete": {
        "product": null,
        "userErrors": [
          {
            "field": [
              "variantsIds",
              "1"
            ],
            "message": "At least one variant does not belong to the product"
          }
        ]
      }
    }
  }