Bundles

A bundle is a set of products sold together, such as a starter kit or a gift set. You can use a bundle ID on an order line wherever you can use a product ID.

Bundles have no stock of their own. Their availability comes from their components, and the warehouse picks each component.

Operations

Create bundle

Group products into a bundle.

Update bundle

Change a bundle's components.

Get bundle

Get a bundle and its components.

List bundles

List all bundles.

Delete bundle

Delete a bundle.

The Bundle object

The same object is used in requests and responses.

idstringrequired

Bigblue bundle ID: your tenant code, BU, then two SKU parts. Example: BGBLBU-KITSTA-2024. Can't be changed.

Pattern^[A-Za-z0-9]{4}BU-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

display_namestringrequired

Bundle name, shown in the app and on packing documents.

1–128 characters

componentsBundleComponent[]required

The products in the bundle. 1 to 20 items.

1 to 20 items

optionsProductOption[]

Variant attributes of the bundle.

BundleComponent

productstringrequired

A product ID. Bundles can't contain other bundles.

Pattern^[A-Za-z0-9]{4}-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

quantityintegerrequired

Units of the product in one bundle. Must be greater than 0.

Greater than 0

Availability

For each component, Bigblue divides its stock by the quantity the bundle needs. The lowest result is the bundle's availability:

available    = min(floor(component.available / component.quantity))
in_warehouse = min(floor(component.in_warehouse / component.quantity))

For example, a kit with 2 mugs and 1 shirt, with 10 mugs and 3 shirts in stock, has 3 available: min(floor(10 / 2), floor(3 / 1)).

Read these values with ListBundleInventories. It returns only available and in_warehouse. Damaged, expired and backordered counts are on the components.

Bundles on orders

Put the bundle ID in the line item's product field. The quantity is the number of bundles.

{
  "product": "BGBLBU-KITSTA-2024",
  "quantity": 1,
  "unit_price": "59.00",
  "unit_tax": "9.83"
}

When you read the order, the line item is still the bundle. The components appear in shipped_packages[].items once the parcel is packed.

Lot fields don't apply to bundle lines

lot_code and lot_expiration_days_range_rule only work on product lines. To choose a lot, order the components separately.