Item Master Inquiry API
Item Master Inquiry API is used to search and retrieve information on all active items within a system. This article introduces the general Item Master Inquiry API use case for easily understanding and applying this API.
Introduction
Item Master Import API allows users to query the system’s item database to access details such as item descriptions, IDs, status and availability. It’s typically used to help manage inventory, ensure item accuracy and support various operations. This API plays a key role in keeping the item master data synchronized with other integrated applications and workflows.
API Request
API: POST /edi/item-master/search-by-paging
Body Request:
| Body Parameter | Required | Description | Note |
|---|---|---|---|
| CompanyID | Y | Company ID | "LT" |
| CustomerID | Y | Customer ID | "AUKINT0001" |
| Status | N | Include Inactive item | "Active" |
| PageNo | N | Paging Size | "1" |
Example
Request
{
"FacilityID":"889",
"CustomerID":"AUKINT0001",
"CompanyID":"LT",
"Paging": {
"PageNo": 2
}
}Response
// Success return
{
"results": {
"data": [
{
"ActionCode_AU": "U",
"allowOverWriteItem": "Y",
"companyId": "",
"supplierId": "",
"customerId": "AUKINT0001",
"itemID": "131861",
"itemDescription": "CHATEAU BUISSON-REDON BORDEAUX (750 ML/CQ:12) Chateau Buisson-Redon FRANCE",
"shortDescription": "",
"abbreviation": "",
"ItemGroupID": "",
"ItemSubGroupID": "",
"titleIds": "",
"tags": "Product",
"labels": "WET,CasePick",
"brandID": "",
"groupID": "COLD_CasePick",
"grade": "",
"billingGrade": "",
"freightClass": "100",
"nmfc": "111510-00",
"commodityDescription": "",
"countryOrigin": "France",
"fileIDs": "",
"UPCCode": "",
"UPCCodeCase": "",
"EANCode": "3566501000033",
"isBundle": "N",
"hasSerialNumber": "N",
"serialNoLength": null,
"isHazardousMaterial": "N",
"NeedAllowOverwriteByImport": "N",
"status": "Active",
"validationInboundSerialNo": "N",
"serialNoScanLotNoCheck": "N",
"requireCollectLotNoOnReceive": "N",
"defaultPutAwayLocationSubType": "",
"validationOutboundSerialNo": "N",
"needScanOutboundSerialNo": "",
"validatedOutboundSerialNoAgainstInbound": "N",
"isAllowOverWriteSuggestedPickLP": "",
"Shipping Rule": "FIFO",
"requireCollectExpirationDateOnReceive": "N",
"Ship Allowed Days": "",
"requireCollectMfgDateOnReceive": "N",
"requireCollectShelfLifeDaysOnReceive": "N",
"requireCollectSnOnShipping": "N",
"Stack Height": "",
"Base_Price": null,
"Base_Currency": null,
"Base_InsuranceAmount": null,
"Base_SetDefaultUOM": "Y",
"Base_UOM": "EA",
"Base_Length": 2,
"Base_Width": 2,
"Base_Height": 12,
"Base_UnitLength": "Inch",
"Base_Weight": 1,
"Base_UnitWeight": "Pound",
"Base_Volume": 48,
"Base_UnitVolume": "cu in",
"Base_Billing_UOM": "each",
"Case_UOM": "CS",
"Case_Price": null,
"Case_Currency": null,
"Case_InsuranceAmount": null,
"Case_SetDefaultUOM": "",
"Case_Inside_UOM": "EA",
"Case_Qty": 12,
"Case_Length": 12.99,
"Case_Width": 12.59,
"Case_Height": 9.84,
"Case_UnitLength": "Inch",
"Case_Weight": 12,
"Case_UnitWeight": "Pound",
"Case_Volume": 1609.27,
"Case_UnitVolume": "cu in",
"Case_Billing_UOM": "case",
"Inner_Pack_Qty": 12,
"Inner_Pack_UOM": "IN",
"Inner_Price": null,
"Inner_Currency": null,
"Inner_InsuranceAmount": null,
"Inner_SetDefaultUOM": "",
"Inner_Billing_UOM": "",
"AKAValue01": "890964001003",
"AKAName01": "Other Barcode",
"AKA01 Tag": "Customer",
"AKA01 Org": "AUKINT0001",
"DynTxtPropertyName01": "DESCRIPTION 2",
"DynTxtPropertyValue01": "750 ML",
"DynTxtPropertyName02": "Item Velocity",
"DynTxtPropertyValue02": "B",
"DynTxtPropertyName03": "Department",
"DynTxtPropertyValue03": "15",
"Pallet_Ti": 14,
"Pallet_Hi": 5,
"Cases_Per_Pallet": 70
}
],
"head": [
"ActionCode_AU",
"allowOverWriteItem",
"companyId",
"supplierId",
"customerId",
"itemID",
"itemDescription",
"shortDescription",
"abbreviation",
"ItemGroupID",
"ItemSubGroupID",
"titleIds",
"tags",
"labels",
"brandID",
"groupID",
"grade",
"billingGrade",
"freightClass",
"nmfc",
"commodityDescription",
"countryOrigin",
"fileIDs",
"UPCCode",
"UPCCodeCase",
"EANCode",
"isBundle",
"hasSerialNumber",
"serialNoLength",
"isHazardousMaterial",
"NeedAllowOverwriteByImport",
"status",
"validationInboundSerialNo",
"serialNoScanLotNoCheck",
"requireCollectLotNoOnReceive",
"defaultPutAwayLocationSubType",
"validationOutboundSerialNo",
"needScanOutboundSerialNo",
"validatedOutboundSerialNoAgainstInbound",
"isAllowOverWriteSuggestedPickLP",
"Shipping Rule",
"requireCollectExpirationDateOnReceive",
"Ship Allowed Days",
"requireCollectMfgDateOnReceive",
"requireCollectShelfLifeDaysOnReceive",
"requireCollectSnOnShipping",
"Stack Height",
"Base_UOM",
"Base_Price",
"Base_Currency",
"Base_InsuranceAmount",
"Base_SetDefaultUOM",
"Base_Length",
"Base_Width",
"Base_Height",
"Base_UnitLength",
"Base_Weight",
"Base_UnitWeight",
"Base_Volume",
"Base_UnitVolume",
"Base_Billing_UOM",
"Inner_Pack_Qty",
"Inner_Pack_UOM",
"Inner_Price",
"Inner_Currency",
"Inner_InsuranceAmount",
"Inner_SetDefaultUOM",
"Inner_Billing_UOM",
"Case_UOM",
"Case_Price",
"Case_Currency",
"Case_InsuranceAmount",
"Case_SetDefaultUOM",
"Case_Inside_UOM",
"Case_Qty",
"Case_Length",
"Case_Width",
"Case_Height",
"Case_UnitLength",
"Case_Weight",
"Case_UnitWeight",
"Case_Volume",
"Case_UnitVolume",
"Case_Billing_UOM",
"Pallet_Ti",
"Pallet_Hi",
"Cases_Per_Pallet",
"DynTxtPropertyName01",
"DynTxtPropertyValue01",
"DynTxtPropertyName02",
"DynTxtPropertyValue02",
"DynTxtPropertyName03",
"DynTxtPropertyValue03",
"DynTxtPropertyName04",
"DynTxtPropertyValue04",
"DynTxtPropertyName05",
"DynTxtPropertyValue05",
"DynTxtPropertyName06",
"DynTxtPropertyValue06",
"DynTxtPropertyName07",
"DynTxtPropertyValue07",
"DynTxtPropertyName08",
"DynTxtPropertyValue08",
"DynTxtPropertyName09",
"DynTxtPropertyValue09",
"DynTxtPropertyName10",
"DynTxtPropertyValue10",
"DynTxtPropertyName11",
"DynTxtPropertyValue11",
"DynTxtPropertyName12",
"DynTxtPropertyValue12",
"DynTxtPropertyName13",
"DynTxtPropertyValue13",
"DynTxtPropertyName14",
"DynTxtPropertyValue14",
"DynTxtPropertyName15",
"DynTxtPropertyValue15",
"DynTxtPropertyName16",
"DynTxtPropertyValue16",
"DynTxtPropertyName17",
"DynTxtPropertyValue17",
"DynTxtPropertyName18",
"DynTxtPropertyValue18",
"DynTxtPropertyName19",
"DynTxtPropertyValue19",
"DynTxtPropertyName20",
"DynTxtPropertyValue20",
"DynDateTimePropertyName01",
"DynDateTimePropertyValue01",
"DynDateTimePropertyName02",
"DynDateTimePropertyValue02",
"DynDateTimePropertyName03",
"DynDateTimePropertyValue03",
"DynNumberPropertyName01",
"DynNumberPropertyValue01",
"DynNumberPropertyName02",
"DynNumberPropertyValue02",
"DynNumberPropertyName03",
"DynNumberPropertyValue03",
"DynNumberPropertyName04",
"DynNumberPropertyValue04",
"DynNumberPropertyName05",
"DynNumberPropertyValue05",
"DynNumberPropertyName06",
"DynNumberPropertyValue06",
"DynNumberPropertyName07",
"DynNumberPropertyValue07",
"DynNumberPropertyName08",
"DynNumberPropertyValue08",
"DynNumberPropertyName09",
"DynNumberPropertyValue09",
"DynNumberPropertyName10",
"DynNumberPropertyValue10",
"AKAValue01",
"AKAName01",
"AKA01 Tag",
"AKA01 Org",
"AKAValue02",
"AKAName02",
"AKA02 Tag",
"AKA02 Org",
"AKAValue03",
"AKAName03",
"AKA03 Tag",
"AKA03 Org",
"AKAValue04",
"AKAName04",
"AKA04 Tag",
"AKA04 Org",
"AKAValue05",
"AKAName05",
"AKA05 Tag",
"AKA05 Org",
"AKAValue06",
"AKAName06",
"AKA06 Tag",
"AKA06 Org",
"AKAValue07",
"AKAName07",
"AKA07 Tag",
"AKA07 Org",
"AKAValue08",
"AKAName08",
"AKA08 Tag",
"AKA08 Org",
"AKAValue09",
"AKAName09",
"AKA09 Tag",
"AKA09 Org",
"AKAValue10",
"AKAName10",
"AKA10 Tag",
"AKA10 Org",
"DiverseProperty01",
"DiverseProperty02",
"DiverseProperty03",
"DiverseProperty04",
"DiverseProperty05",
"DiverseProperty06",
"DiverseProperty07",
"DiverseProperty08",
"DiverseProperty09",
"DiverseProperty10"
]
},
"paging": {
"totalCount": 3362,
"pageNo": 1,
"totalPage": 3362,
"startIndex": 1,
"endIndex": 1,
"limit": 1
}
}