productVariantRelationshipBulkUpdate

mutation

Requires write_products access scope. Also: The shop must have access to bundles feature.

Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles.

Arguments

Anchor to inputinput • [ProductVariantRelationshipUpdateInput!]!required: The input options for the product variant being updated.

Was this section helpful?

Anchor to ProductVariantRelationshipBulkUpdatePayload returnsProductVariantRelationshipBulkUpdatePayload returns

Anchor to parentProductVariantsparentProductVariants • [ProductVariant!]: The product variants with successfully updated product variant relationships.
Anchor to userErrorsuserErrors • [ProductVariantRelationshipBulkUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a bundle by adding components to a product variant
Delete a product variant component
Remove all product variant components of a bundle
Update a product variant relationship
productVariantRelationshipBulkUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) {
6    productVariantRelationshipBulkUpdate(input: $input) {
7      parentProductVariants {
8        id
9        productVariantComponents(first: 10) {
10          nodes {
11            id
12            productVariant {
13              id
14              displayName
15            }
16          }
17        }
18      }
19      userErrors {
20        code
21        field
22        message
23      }
24    }
25  }`,
26  {
27    variables: {
28      "input": [
29        {
30          "parentProductVariantId": "gid://shopify/ProductVariant/799757249",
31          "productVariantRelationshipsToCreate": [
32            {
33              "id": "gid://shopify/ProductVariant/149896808",
34              "quantity": 1
35            },
36            {
37              "id": "gid://shopify/ProductVariant/709406719",
38              "quantity": 1
39            }
40          ]
41        }
42      ]
43    },
44  },
45);
46
47const data = await response.json();
48

mutation CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) {
  productVariantRelationshipBulkUpdate(input: $input) {
    parentProductVariants {
      id
      productVariantComponents(first: 10) {
        nodes {
          id
          productVariant {
            id
            displayName
          }
        }
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) { productVariantRelationshipBulkUpdate(input: $input) { parentProductVariants { id productVariantComponents(first: 10) { nodes { id productVariant { id displayName } } } } userErrors { code field message } } }",
 "variables": {
    "input": [
      {
        "parentProductVariantId": "gid://shopify/ProductVariant/799757249",
        "productVariantRelationshipsToCreate": [
          {
            "id": "gid://shopify/ProductVariant/149896808",
            "quantity": 1
          },
          {
            "id": "gid://shopify/ProductVariant/709406719",
            "quantity": 1
          }
        ]
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) {
    productVariantRelationshipBulkUpdate(input: $input) {
      parentProductVariants {
        id
        productVariantComponents(first: 10) {
          nodes {
            id
            productVariant {
              id
              displayName
            }
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": [
        {
          "parentProductVariantId": "gid://shopify/ProductVariant/799757249",
          "productVariantRelationshipsToCreate": [
            {
              "id": "gid://shopify/ProductVariant/149896808",
              "quantity": 1
            },
            {
              "id": "gid://shopify/ProductVariant/709406719",
              "quantity": 1
            }
          ]
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) {
      productVariantRelationshipBulkUpdate(input: $input) {
        parentProductVariants {
          id
          productVariantComponents(first: 10) {
            nodes {
              id
              productVariant {
                id
                displayName
              }
            }
          }
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "input": [
        {
          "parentProductVariantId": "gid://shopify/ProductVariant/799757249",
          "productVariantRelationshipsToCreate": [
            {
              "id": "gid://shopify/ProductVariant/149896808",
              "quantity": 1
            },
            {
              "id": "gid://shopify/ProductVariant/709406719",
              "quantity": 1
            }
          ]
        }
      ]
    },
  },
});

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 CreateBundle($input: [ProductVariantRelationshipUpdateInput!]!) {
    productVariantRelationshipBulkUpdate(input: $input) {
      parentProductVariants {
        id
        productVariantComponents(first: 10) {
          nodes {
            id
            productVariant {
              id
              displayName
            }
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": [{"parentProductVariantId"=>"gid://shopify/ProductVariant/799757249", "productVariantRelationshipsToCreate"=>[{"id"=>"gid://shopify/ProductVariant/149896808", "quantity"=>1}, {"id"=>"gid://shopify/ProductVariant/709406719", "quantity"=>1}]}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": [
3    {
4      "parentProductVariantId": "gid://shopify/ProductVariant/799757249",
5      "productVariantRelationshipsToCreate": [
6        {
7          "id": "gid://shopify/ProductVariant/149896808",
8          "quantity": 1
9        },
10        {
11          "id": "gid://shopify/ProductVariant/709406719",
12          "quantity": 1
13        }
14      ]
15    }
16  ]
17}

Response

JSON

1{
2  "productVariantRelationshipBulkUpdate": {
3    "parentProductVariants": [
4      {
5        "id": "gid://shopify/ProductVariant/799757249",
6        "productVariantComponents": {
7          "nodes": [
8            {
9              "id": "gid://shopify/ProductVariantComponent/993184086",
10              "productVariant": {
11                "id": "gid://shopify/ProductVariant/149896808",
12                "displayName": "Composite_Sauce_Pack - component_product_variant_classic_hot_sauce"
13              }
14            },
15            {
16              "id": "gid://shopify/ProductVariantComponent/993184087",
17              "productVariant": {
18                "id": "gid://shopify/ProductVariant/709406719",
19                "displayName": "Composite_Sauce_Pack - component_product_variant_classic_garlic_sauce"
20              }
21            }
22          ]
23        }
24      }
25    ],
26    "userErrors": []
27  }
28}