Component Inquiry API
Component Inquiry API is used to search for component relationships within kitting items. This article introduces the general Component Inquiry API for easily understanding and applying this API.
Introduction
Component Inquiry API allows users to retrieve details about which components are linked to specific kit items in the system, providing important data for inventory management, production and order fulfillment. It helps users understand the structure of kits by identifying the components that are bundled together, ensuring accurate tracking and processing of kit-related operations.
API Request
API: POST /edi/item-master/component/search-by-paging
Body Request:
| Body Parameter | Sub Param | Required | Description | Note |
|---|---|---|---|---|
| CompanyID | - | Y | Company ID | "LT" |
| CustomerID | - | Y | Customer ID | "AUKINT0001" |
| ItemID | - | N | Item ID | "Item-A" |
| Status | - | N | Item Status | "Active" |
| Paging | PageNo | N | Page Number | "1" |
Example
Request
{
"CompanyID": "LT",
"CustomerID": "AUKINT0001",
"ItemID": "",
"Status": "",
"Paging": {
"PageNo": 1
}
}Response
// Success return
{
"Results": {
"Data": [
{
"CompanyId": "LT",
"CustomerID": "AUKINT0001",
"ItemID": "Item-A",
"Components": [
{
"ItemID": "Item-A-1",
"ParentItemID": "Item-A",
"Qty": 2,
"UOM": "EA"
},
{
"ItemID": "Item-A-2",
"ParentItemID": "Item-A",
"Qty": 5,
"UOM": "EA"
}
]
},
...
]
},
"Paging": {
"TotalCount": 3,
"PageNo": 1,
"TotalPage": 1
}
}