Kit List
Retrieves predefined kits for your company, including each product and current stock.
GET
/api/v1/device-hub/kitsDescription
List the predefined kits set up for your company. Each kit includes the products it contains, the quantity required per product, and available stock. Pass a kit name to return that kit only. Pass warehouse_id to show stock for that warehouse.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | No | Exact kit name. When omitted, all kits for the company are returned. |
| warehouse_id | string | No | Warehouse ID from warehouse list (e.g., QebLm2p7). When provided, quantity is stock in that warehouse. When omitted, quantity is company-wide aggregate stock. |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the request succeeded |
| message | string | Status message |
| data | array | Array of kit objects |
| data[].name | string | Kit name |
| data[].products | array | Products defined on the kit |
Product Object Fields
| Field | Type | Description |
|---|---|---|
| name | string | Product name |
| slug | string | URL-friendly product identifier |
| description | string | Product description |
| sku | string | Product SKU |
| quantity | integer | Available stock. Company-wide aggregate when warehouse_id is omitted; stock in the selected warehouse when warehouse_id is provided. |
| required_quantity | integer | Quantity of this product required by the kit |
| brand_name | string | Product brand |
| model_name | string | Product model |
| image | string | URL to product image |
Notes
- When warehouse_id is omitted, quantity is company-wide aggregate stock across warehouses
- When warehouse_id is provided, quantity is stock in that warehouse. Use the ID from warehouse list
- Products with zero stock are still returned so you can see what is short
- An unknown name returns an error rather than an empty success response
- Use data[].name as name when placing a kit order
Related Endpoints
Did this page help you?
Request
curl -X GET 'https://uat.unduit.com/api-exposed/api/v1/device-hub/kits' \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response (200)
{
"success": true,
"message": "Kits retrieved successfully",
"data": [
{
"name": "Onboarding Kit",
"products": [
{
"name": "Apple MacBook Pro 14-inch (M2, 2023)",
"slug": "apple-macbook-pro-14-m2-2023",
"description": "High-performance laptop with M2 Pro chip, Liquid Retina XDR display, and long battery life.",
"sku": "MBP14-M2-2023",
"quantity": 12,
"required_quantity": 1,
"brand_name": "Apple",
"model_name": "MacBook Pro 14 M2",
"image": "https://example.com/images/macbook-pro-14.png"
},
{
"name": "Dell 27-inch Monitor",
"slug": "dell-27-inch-monitor",
"description": "27-inch QHD monitor for office use.",
"sku": "DELL-MON-27",
"quantity": 0,
"required_quantity": 1,
"brand_name": "Dell",
"model_name": "P2723DE",
"image": "https://example.com/images/dell-monitor.png"
}
]
}
]
}