BigblueDevelopers

Update bundle

Replace a bundle's name, components and options.

POST/bigblue.storeapi.v1.PublicAPI/UpdateBundle

Updates display_name, components and options on a bundle. Send the whole bundle. The components you send replace the existing list, so leaving one out removes it.

Request body

bundleBundlerequired

The full bundle. id identifies the bundle and can't change.

Availability changes immediately

Bundle availability is calculated from its components. Adding a component with little stock can drop the bundle's available to 0, and sales channels that use Bigblue stock will see that change.

Responses

200The bundle was updated.
bundleBundle
The updated bundle.
400A field is invalid, for example more than 20 components or a quantity of 0.
{
  "code": "invalid_argument",
  "msg": "bundle.components[1].quantity value must be greater than 0",
  "meta": { "argument": "bundle.components[1].quantity" }
}
404The bundle or a component product doesn't exist.
{ "code": "not_found", "msg": "bundle not found" }
POST/bigblue.storeapi.v1.PublicAPI/UpdateBundle
Request
{
  "bundle": {
    "id": "BGBLBU-KITSTA-2024",
    "display_name": "Starter kit: 2 mugs and 2 shirts",
    "components": [
      { "product": "BGBL-MUGCLA-WHIT", "quantity": 2 },
      { "product": "BGBL-ESPSRT-SMAL", "quantity": 2 }
    ]
  }
}
200
{
  "bundle": {
    "id": "BGBLBU-KITSTA-2024",
    "display_name": "Starter kit: 2 mugs and 2 shirts",
    "components": [
      { "product": "BGBL-MUGCLA-WHIT", "quantity": 2 },
      { "product": "BGBL-ESPSRT-SMAL", "quantity": 2 }
    ]
  }
}