Bundle Get
GET
{{api_url}}/shop/products/bundle/{{bundle_id}}Gets one Bundle with its component SKUs. A Bundle is a SKU built from other SKUs: the bundle SKU carries its own inventory at one warehouse, created by consuming the components from that warehouse. When the bundle's stock falls to its Minimum Inventory, InfiPlex builds the Auto Create Amount more. If component stock cannot cover the full amount, nothing is built.
Path
| Segment | Description |
|---|---|
{{bundle_id}} | The bundle id, shop_bundle_sku_id from Bundle Search. |
Example
{{api_url}}/shop/products/bundle/19
Response
{
"shop_bundle_sku_id": "19",
"shop_bundle_sku_siteareaid": "16",
"shop_bundle_sku_warehouseid": "7",
"bundle_name": "Test Bundle",
"bundle_sku": "BUNDLESKU",
"minimum_inventory_amt": "10",
"auto_add_inventory_amt": "5",
"warehouse_name": "Canada",
"assoc_skus": [
{
"shop_bundle_sku_assoc_sku_id": "45",
"sbsas_bundle_sku_id": "19",
"sku": "SKU1",
"quantity_in_bundle": "1"
},
{
"shop_bundle_sku_assoc_sku_id": "46",
"sbsas_bundle_sku_id": "19",
"sku": "SKU2",
"quantity_in_bundle": "2"
},
{
"shop_bundle_sku_assoc_sku_id": "47",
"sbsas_bundle_sku_id": "19",
"sku": "SKU3",
"quantity_in_bundle": "1"
}
],
"bundle_sku_warehouse_inventory": null
}
| Field | Type | Description |
|---|---|---|
shop_bundle_sku_id | string | The bundle id. |
shop_bundle_sku_siteareaid | string | The InfiPlex site area the bundle belongs to. |
shop_bundle_sku_warehouseid | string | The warehouse the bundle is built in. Components are drawn from this warehouse and the built bundle stock lands here. |
bundle_name | string | Display name as shown in the OMS. |
bundle_sku | string | The SKU your channels sell the bundle under. |
minimum_inventory_amt | string | When the bundle SKU's stock at this warehouse reaches this number, InfiPlex tries to build more. |
auto_add_inventory_amt | string | How many bundles to build when the minimum is reached. No partial builds: if component stock cannot cover this amount, none are made. |
warehouse_name | string | Name of the warehouse in shop_bundle_sku_warehouseid. |
assoc_skus | array | The component SKUs, one object each. |
assoc_skus[].shop_bundle_sku_assoc_sku_id | string | Id of this component row. |
assoc_skus[].sbsas_bundle_sku_id | string | The bundle id, repeated. |
assoc_skus[].sku | string | The component SKU. |
assoc_skus[].quantity_in_bundle | string | How many units of this component go into one bundle. |
bundle_sku_warehouse_inventory | string or null | Current inventory of the bundle SKU at the bundle's warehouse. null when the bundle SKU has no inventory record at that warehouse yet. |
To check whether a build is possible, compare each component's inventory at shop_bundle_sku_warehouseid (Inventory Get with warehouse_id) against quantity_in_bundle times auto_add_inventory_amt.
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Example Request
curl --location --request GET '{{api_url}}/shop/products/bundle/{{bundle_id}}' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Bundle Get
Request
curl --location --request GET '{{api_url}}/shop/products/bundle/19' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
{
"shop_bundle_sku_id": "19",
"shop_bundle_sku_siteareaid": "16",
"shop_bundle_sku_warehouseid": "7",
"bundle_name": "Test Bundle",
"bundle_sku": "BUNDLESKU",
"minimum_inventory_amt": "10",
"auto_add_inventory_amt": "5",
"warehouse_name": "Canada",
"assoc_skus": [
{
"shop_bundle_sku_assoc_sku_id": "45",
"sbsas_bundle_sku_id": "19",
"sku": "SKU1",
"quantity_in_bundle": "1"
},
{
"shop_bundle_sku_assoc_sku_id": "46",
"sbsas_bundle_sku_id": "19",
"sku": "SKU2",
"quantity_in_bundle": "2"
},
{
"shop_bundle_sku_assoc_sku_id": "47",
"sbsas_bundle_sku_id": "19",
"sku": "SKU3",
"quantity_in_bundle": "1"
}
],
"bundle_sku_warehouse_inventory": null
}