Contents
Description
ip1basicItem.get retrieves item details for the item number provided. It currently returns up to 3 default item classes that are defined in TMSDS/IM-ALFIC. You can override the default item class types defined in TMSDS/IM-ALFIC by providing specific class types as input to API parameter “ICT1”, “ICT2” or “ICT3”. E.g. if only “ICT2” is provided, it will override only the 2nd default item class type and return other types as before.
| Note |
|
It can retrieve UDF field(upto 3) by providing specific UDF entity and property.
Restrictions
Access to any of the operations in ip1basicItem.get is dependent on user access.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| I | 20A | Item number |
| ICT1 | 8A | Item class type 1 |
| ICT2 | 8A | Item class type 2 |
| ICT3 | 8A | Item class type 3 |
| CN | 10A | Customer number (optional input) |
| udfEnty | 10A | UDF entity |
| udfProp1 | 10A | UDF property 1 |
| udfProp2 | 10A | UDF property 2 |
| udfProp3 | 10A | UDF property 3 |
| Output | Type | Description |
| I | 20A | Item number |
| IDSC | 60A | Item description |
| IEDC | 60A | Extended description (Author) |
| IBCD | 20A | Item barcode |
| AI | 20A | Alternate item |
| SUPI | 20A | Supplier item code |
| CMNT | 40a | Item comment |
| ISTS | 1A | Item status |
| STKF | 1A | Stock item flag |
| RLSD | 10A | Release date (local pub date) |
| LNKI | 20A | Link item |
| RLSN | 4A | Release number (Edition) |
| SUBI | 20A | Substitution item |
| STKSTS | 1A | Stock status (IBOR) |
| STKSTSA | 3A | Stock status short description |
| STKSTSD | 20A | Stock status description |
| IL1 | 3A | Item level 1 |
| IL2 | 3A | Item level 2 |
| IL3 | 3A | Item level 3 |
| IL4 | 3A | Item level 4 |
| IL5 | 3A | Item level 5 |
| ICT1 | 8A | Item class type 1 |
| ICC1 | Array of 50 max. | Item class code 1 |
| ICCC | 8A | Item class code |
| ICCD | 50a | Item class code description |
| ICT2 | 8A | Item class type 2 |
| ICC2 | Array of 50 max. | Item class code 2 |
| ICCC | 8A | Item class code |
| ICCD | 50a | Item class code description |
| ICT3 | 8A | Item class type 3 |
| ICC3 | Array of 50 max. | Item class code 3 |
| ICCC | 8A | Item class code |
| ICCD | 50a | Item class code description |
| packagingType | 5A | Packaging type |
| packagingTypeDesc | 20a | Packaging type description |
| udfPropDesc1 | 40a | UDF property description 1 |
| udfVal1 | 999a | UDF value 1 |
| udfDesc1 | 999a | UDF description 1 |
| udfPropDesc2 | 40a | UDF property description 2 |
| udfVal2 | 999a | UDF value 2 |
| udfDesc2 | 999a | UDF description 2 |
| udfPropDesc3 | 40a | UDF property description 3 |
| udfVal3 | 999a | UDF value 3 |
| udfDesc3 | 999a | UDF description 3 |
JSON example
View JSON request & response exampleRequest:
{
“IptorAPI”: “1.0”,
“method”: “ip1basicItem.get”,
“params”: {
“I”: “9789863411413”
},
“id”: “1234567890”
}
Response:
Note that it returns default item class “IC-SPUBR” AND “IC-DISCP” when no item class type is provided as an input.
{
“IptorAPI”: “1.0”,
“data”: {
“I”: “9789863411413”,
“IDSC”: “WIRELESS NETWORKS 3E (TAIWAN VERSION)”,
“IEDC”: “SMITH”,
“IBCD”: “3411418”,
“AI”: “9863411418”,
“SUPI”: “9780071819831”,
“CMNT”: “REFER TO COMMENT TAB”,
“ISTS”: “A”,
“STKF”: “Y”,
“RLSD”: “2014-09-04”,
“LNKI”: “”,
“RLSN”: “3”,
“SUBI”: “”,
“STKSTS”: “B”,
“STKSTSD”: “BACKLIST”,
“STKSTSA”: “BLT”,
“IL1”: “300”,
“IL2”: “ISE”,
“IL3”: “042”,
“IL4”: “TPR”,
“IL5”: “”,
“ICT1”: “IC-SPUBR”,
“ICC1”: [
{
“ICCC”: “MHU”,
“ICCD”: “MHE US”
}
],
“ICT2”: “IC-DISCP”,
“ICC2”: [
{
“ICCC”: “1228”,
“ICCD”: “TELECOMMUNICATION TJ”
}
]
},
“id”: “1234567890”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
ip1basicItemWarehouseStock.get
ip1basicCustomerOrderDetails.get
