BizKitHub
DocsAPI ReferenceProduct/bff/product/product-detail-bundle
getProductAdmin BFF

/bff/product/product-detail-bundle

Returns the components of a bundle product, the sum of their list prices (to compare with the bundle price), assemblable quantity from component stock, and the bundles this product is a component of. An empty items list means the product is not a bundle.

ProductgetBffProductProduct-detail-bundle

Parameters

2 query

Query parameters

· 2
productCodestringRequired

Bundle product code.

Examplestarter-set
localestringOptional

Locale for component names.

Examplecs

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
productCodestringRequired
productNamestringRequired
variantCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
variantNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
quantitynumberRequired

Units of the component in one bundle.

unitPricenumberRequired

Component list price (variant price when pinned).

totalPricenumberRequired

unitPrice × quantity.

vatnumberRequired
soldOutbooleanRequired
activebooleanRequired
isDeletedbooleanRequired
availableQuantitynumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
itemCountnumberRequired
componentsPriceSumnumberRequired
bundlePricenumberRequired
savingAmountnumberRequired

componentsPriceSum − bundlePrice (negative = bundle is pricier).

savingPercentagenumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
bundleVatnumberRequired
availableQuantitynumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
usedInBundlesobject[]Required
Each array item:
codestringRequired
namestringRequired

Response example

application/json
{
  "items": [
    {
      "productCode": "example_productCode",
      "productName": "example_productName",
      "quantity": 0,
      "unitPrice": 0,
      "totalPrice": 0,
      "vat": 0,
      "soldOut": false,
      "active": false,
      "isDeleted": false
    }
  ],
  "itemCount": 0,
  "componentsPriceSum": 0,
  "bundlePrice": 0,
  "savingAmount": 0,
  "bundleVat": 0,
  "usedInBundles": [
    {
      "code": "example_code",
      "name": "example_name"
    }
  ]
}

Request example

GET /bff/product/product-detail-bundle

get
curl -X GET "https://api.bizkithub.com/bff/product/product-detail-bundle?productCode=starter-set&locale=cs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key