Get bundle · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/GetBundle

Returns one bundle by its Bigblue ID. To see how many bundles are available, use ListBundleInventories.

Request body

idstringrequired

Bigblue bundle ID.

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

Responses

200The bundle.

bundleBundle

The bundle and its components.

400The ID doesn't match the bundle ID pattern. A product ID fails here.

{
  "code": "invalid_argument",
  "msg": "id value does not match regex pattern `^[[:alnum:]]{4}BU-[[:alnum:]]{6}-[[:alnum:]]{4}$`",
  "meta": { "argument": "id" }
}

404No bundle with this ID exists.

{ "code": "not_found", "msg": "bundle not found" }

POST/bigblue.storeapi.v1.PublicAPI/GetBundle

Request

{ "id": "BGBLBU-KITSTA-2024" }

200

{
  "bundle": {
    "id": "BGBLBU-KITSTA-2024",
    "display_name": "Starter kit: 2 mugs and 1 shirt",
    "components": [
      { "product": "BGBL-MUGCLA-WHIT", "quantity": 2 },
      { "product": "BGBL-ESPSRT-SMAL", "quantity": 1 }
    ]
  }
}