Choose a version:

productBundleCreate

mutation

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

Creates a product bundle that groups multiple Product objects together as components. The bundle appears as a single product in the store, with its price determined by the parent product and inventory calculated from the component products.

The mutation runs asynchronously and returns a ProductBundleOperation object to track the creation status. Poll the operation using the productOperation query to determine when the bundle is ready.

Learn more about creating product fixed bundles.

Anchor to Arguments

Arguments

Anchor to inputinput •ProductBundleCreateInput! required: Input for creating a product bundle or componentized product.

Was this section helpful?

Anchor to ProductBundleCreatePayload returnsProductBundleCreatePayload returns

Anchor to productBundleOperationproductBundleOperation •ProductBundleOperation: The asynchronous ProductBundleOperation creating the product bundle or componentized product.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

productBundleCreate reference

Mutation Reference

mutation productBundleCreate($input: ProductBundleCreateInput!) {

productBundleCreate(input: $input) {

productBundleOperation {

# ProductBundleOperation fields

}

userErrors {

field

message

}

Input

{

"input": {

"title": "<your-title>",

"components": [

{

"quantity": 1,

"productId": "gid://shopify/<objectName>/10079785100",

"optionSelections": [

{}

"quantityOption": {}

}

]

}

Variables

{
  "input": {
    "title": "<your-title>",
    "components": [
      {
        "quantity": 1,
        "productId": "gid://shopify/<objectName>/10079785100",
        "optionSelections": [
          {}
        ],
        "quantityOption": {}
      }
    ]
  }
}

Schema

input ProductBundleCreateInput {
  title: String!
  components: [ProductBundleComponentInput!]!
}

input ProductBundleComponentInput {
  quantity: Int
  productId: ID!
  optionSelections: [ProductBundleComponentOptionSelectionInput!]!
  quantityOption: ProductBundleComponentQuantityOptionInput
}