Add a product fixed bundle

A product fixed bundle is a bundle that's configured at the product level. This guide shows you how to add a product fixed bundle using the productBundleCreate mutation.

Anchor to What you'll learnWhat you'll learn

In this tutorial, you'll learn how to do the following tasks:

• Use the GraphQL Admin API to create a bundle
• Poll the status of the bundle creation job
• Use the GraphQL Admin API to update a bundle

Anchor to RequirementsRequirements

• You're a user with app development permissions.
• You've created a development store.
• You've created an app using Shopify CLI. If you previously installed Shopify CLI, then make sure that you're using the latest version. If you plan to create a UI for your extension, then start with the React Router app template.
• You've installed Node.js 16 or higher.
• You've installed your app on the development store.

• Your app can make authenticated requests to the GraphQL Admin API.
• Your app has the write_products access scope. Learn how to configure your access scopes using Shopify CLI.

Anchor to How it worksHow it works

A product fixed bundle is modeled as a product and is associated with other products using the bundleComponents relationship. This relationship is dictated by which options are chosen, for each component, when creating the bundle.

The bundle parent variant's price determines the price, while the inventory of each component's variants determines the bundle inventory. This is the same for variant fixed bundles.

A product has a bundleComponents field that determines the bundles' components.

The next diagram shows an example of a product ("The Hair and Skin Bundle") that models a bundle and contains the following components: "Natural Shampoo 50 ml" and "Coconut Conditioner". The bundle is modeled by selecting which option values should be considered for each component.

The next diagram shows an example of a product ("Hair and Soap Bundle") that models a bundle containing the following components: "Natural Shampoo", "Coconut Conditioner", "Hand Soap", and "Body Wash". The scent option names and values are the same for each component so they can be combined. When customers visit the storefront, combined options show up as one selector.

Anchor to Limitations and considerationsLimitations and considerations

• A bundle can have up to 30 components.
• Bundles can have up to three options. Combined options are considered one option.
• You can't combine quantity options.
• After an app has assigned components to a bundle, only that app can manage the components of the bundle.
• Nested bundles aren't supported. A bundle can't have components and be part of another bundle simultaneously.

Anchor to Step 1: Create a bundleStep 1: Create a bundle

To create a product fixed bundle, you can run the productBundleCreate mutation.

The following example creates a bundle product ("The Hair and Skin Bundle") with two products as components (Shampoo and Soap). The mutation will return a productBundleOperation that you can use later to poll for the operation status. This example uses unique option names for each component ("Shampoo scent" and "Soap scent"). When using consolidatedOptions (shown in Step 4), you can use the same name for multiple components (for example, all "Scent"), and the API will consolidate them into a single bundle option based on the consolidatedOptions mapping.

Anchor to Step 2: Poll the status of the bundle creation jobStep 2: Poll the status of the bundle creation job

After running the productBundleCreate mutation, you need to poll the status of the resulting product operation to know when the bundle is created.

The following example polls the status of the bundle creation job.

Anchor to Step 3: Update the bundleStep 3: Update the bundle

To update a bundle, you can run the productBundleUpdate mutation. The following example updates the bundle created previously by removing the soap component and adding a sponge component.

You can poll the status of the bundle update operation in the same way as you did for the bundle creation operation.

Anchor to Step 4: Combine bundle optionsStep 4: Combine bundle options

You can consolidate multiple component options into a single bundle option by using the consolidatedOptions field when creating or updating a bundle. This allows buyers to select one option value (for example, "Lavender") that applies to multiple options.

Anchor to Next stepsNext steps

• Learn how to create variant fixed bundles.