Get a list of your kit items with detailed information.
- URL: {API root URL}/items/kits?{query}
- Method: GET
Request
URL Parameters
Parameter Name | Required | Data Type | Description |
---|
CustomerCode | Y | String | Your unique customer code assigned by Best system. |
SKU | | String | The number of the Kit master SKU. |
KitType | | String | BOM or SetMaster. |
Response
Attribute List
Element Name | Data Type | Description |
---|
ResultCount | Integer | The count of returned records. |
Data | Array<Object> | The Kit list. |
Data/MasterItemId | Integer | The internal ID of the Kit Master SKU. |
Data/CustomerCode | String | |
Data/MasterItemSKU | String | The number of the Kit Master SKU. |
Data/MasterItemDescription | String | The description of the Kit Master SKU. |
Data/KitType | String | |
Data/Category | String | |
Data/Status | String | Status of the Kit Master SKU, value will be “Enabled” or “Disabled”. |
Data/Components | Array<Object> | |
Data/Components/ComponentItemId | Integer | The internal ID of the component SKU |
Data/Components/ComponentItemSKU | String | The number of the component SKU |
Data/Components/ComponentItemDescription | String | The description of the component SKU |
Data/Components/ComponentQty | Integer | The quantity of the component SKU |
Data/Components/componentItemUnitPrice | Decimal | Specify the price of each component item in the same kit. This value will be used to create the commercial invoice for all international shipments. |
Response Example
{
"resultCount": 1,
"data": [
{
"masterItemId": 70517,
"masterItemSku": "SETMASTER-TEST-001",
"masterItemDescription": "This is a Set Master SKU",
"customerCode": "USSAND",
"kitType": "SetMaster",
"status": "Enabled",
"components": [
{
"componentItemId": 69733,
"componentItemSku": "C001",
"componentItemDescription": "TEST ITEM",
"componentQty": 1,
"componentItemUnitPrice": 9.99
},
{
"componentItemId": 69734,
"componentItemSku": "C002",
"componentItemDescription": "TEST ITEM",
"componentQty": 1,
"componentItemUnitPrice": 9.99
}
]
}
]
}