Contents
Description
ip1items.get brings up a list of items based on the input parameters; scan words, filter & sort fields. With the paging input parameters(keyFrom, keyTo and direction) you can view a subset of the retrieved list. See parameters that control the returned results.
Restrictions
Access is dependent on user access and restrictions.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| customerNumber | 10A | Customer number (optional) |
| udfenty | 10A | UDF entity |
| udfProp1 | 10A | UDF property 1 |
| udfProp2 | 10A | UDF property 2 |
| udfProp3 | 10A | UDF property 3 |
| noOfRecords | 5N0 | No of records to return |
| scanWord | 60a | Scan word |
| filterBy | Array of 10 max. | Filter by |
| field | 8A | DB field(DSIM00P ) except numeric fields |
| value | 20a | Field value |
| condition | 2A | Condition: EQ,NE,GT,GE,LT,LE |
| sortFields |
Array of 2 max. 8A |
Sort fields. If not given, sort by I. DB field(DSIM00P ). |
| sortOrder | 1A | Sort order:A=Ascending, D=Descending |
| keyFrom | 100a | Key-from returned |
| keyTo | 100a | Key-to returned |
| direction | 1A | P=Previous,N=Next,F=First,L=Last |
| Output | Type | Description |
| lists | List of items | |
| itemCode | 20A | Item |
| itemDescription | 60a | Item description |
| itemExtendedDescription | 60a | Item extended description |
| itemStatus | 1A | Item status |
| releaseNumber | 4A | Release number (Edition) |
| releaseDate | 10A | Release date |
| itemclass | 3A | Item class |
| itemDivision | 3A | Item division |
| itemGroup | 3A | Item group |
| itemCategory | 3A | Item category |
| itemSubCategory | 3A | Item sub-category |
| stockStatus | 3A | Stock status |
| stockStatusShortDesc | 3A | Stock status short description |
| stockStatusDesc | 20a | Stock status 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 |
| noOfRecordsReturned | 5N0 | No of records returned |
| keyFrom | 100a | Key-from returned |
| keyTo | 100a | Key-to returned |
| pageInfo | 1A | A=All,T=Top,B=Bottom,M=More |
JSON example
View JSON requests and response exampleRequest:
{
“IptorAPI”: “1.0”,
“method”: “ip1Items.get”,
“params”: {
“scanWord”: “ENVIRONMENTAL”,
“noOfRecords”: 5,
“filterBy”: [
{
“field”: “ISTS”,
“value”: “A”
}
],
“sortFields”: [
“IDSC”
],
“sortOrder”: “D”
},
“id”: “916801”
}
Response:
{
“IptorAPI”: “1.0”,
“data”: {
“lists”: [
{
“item”: “0409073539”,
“itemDescription”: “National Environmental Management Act 10”,
“itemExtendedDescription”: “”,
“itemStatus”: “A”
},
{
“item”: “0409073555”,
“itemDescription”: “National Environmental Management Act 10”,
“itemExtendedDescription”: “”,
“itemStatus”: “A”
},
{
“item”: “040902936X”,
“itemDescription”: “Environmental Law in South Africa”,
“itemExtendedDescription”: “”,
“itemStatus”: “A”
}
],
“noOfRecordsReturned”: 3,
“keyFrom”: “#National Environmental Management Act 10 0409073539”,
“keyTo”: “#Environmental Law in South Africa 040902936X”,
“pageInfo”: “T”
},
“control”: {
“more”: true
},
“id”: “916801”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
