Contents
Description
ip1OrderList.get retrieves customer orders based on the order selection and by some portion of customer reference or some portion of item description or item code. Customer number is an optional input.
Restrictions
Access to any of the operations in ip1OrderList.get is dependent on user access.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| customerNumber | 10A | Customer number(optional) |
| orderSel | 1A | Ord sel:’ ‘=All,’O’=O/S only, ‘C’=Completed |
| customerReference | 30A | Customer reference(Partial value allowed) |
| customerName | 60A | Customer name(Multiple partial value allowed) |
| itemDesc | 60A | Item desc.(Multiple partial value allowed) |
| itemCode | 20A | Item code(Optional) |
| noOfRecords | 5N0 | No of records to return |
| sortFields |
Array of 6 max. 8A |
Sort fields(If not given, sort by ODT,PN) DB field name:ODT,PN,DT,DOCN,DOCD,TSTS,CREF |
| 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 orders | |
| osDocType | 1A | O/S doc type |
| processNumber | 8A | Process number |
| documentType | 1A | Document type |
| documentNumber | 8A | Document number |
| documentDate | 10A | Document date |
| transactionStatus | 1A | Order status |
| transStsDesc | 30a |
Order Status description Order Status description if ODT=’ ‘ O/S doc type description if ODT<>’ ‘ |
| customerReference | 30A |
Customer reference |
| totalAmount | 13N2 |
Total amount |
| currencyISO | 3A |
Currency ISO |
| customerNumber | 10A |
Account number |
| regBusinessName | 60a | Registered business name |
| postalCustomerName | 60a | Postal customer name |
| postalAddressLine4 | 20a | Postal address 4 |
| postalAddressLine5 | 20a | Postal address 5 |
| 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 request & response expampleRequest:
{
“IptorAPI”: “1.0”,
“method”: “ip1OrderList.get”,
“params”: {
“customerName”: “TEST customer”,
“orderSel”: “O”,
“customerReference”: “MoT”,
“noOfRecords”: 6,
“sortFields”: [
“DOCD”,
“TSTS”
],
“sortOrder”: “D”,
“direction”: “F”,
“keyFrom”: “#2019-11-08L40004426”,
“keyTo”: “#2013-12-20D 01917901”
},
“id”: “916876”
}
Response:
{
“IptorAPI”: “1.0”,
“data”: {
“lists”: [
{
“osDocType”: “”,
“processNumber”: “40004426”,
“documentType”: “A”,
“documentNumber”: “”,
“documentDate”: “2019-11-08”,
“transactionStatus”: “L”,
“transStsDesc”: “IN MAINTENANCE”,
“customerReference”: “MOT1”,
“totalAmount”: 12.32,
“currencyISO”: “AUD”,
“customerNumber”: “0000000025”,
“regBusinessName”: “Registered business name”,
“postalCustomerName”: “TESTCUSTOMER & SON”,
“postalAddressLine4”: “NSW”,
“postalAddressLine5”: “2067”
},
{
“osDocType”: “B”,
“processNumber”: “01919581”,
“documentType”: “A”,
“documentNumber”: “”,
“documentDate”: “2016-03-09”,
“transactionStatus”: “”,
“transStsDesc”: “BACK ORDER”,
“customerReference”: “MOT8”,
“totalAmount”: 14,
“currencyISO”: “AUD”,
“customerNumber”: “0000000025”,
“regBusinessName”: “Registered business name”,
“postalCustomerName”: “TEST CUSTOMER & SON”,
“postalAddressLine4”: “NSW”,
“postalAddressLine5”: “2067”
}
],
“noOfRecordsReturned”: 2,
“keyFrom”: “#2019-11-08L 40004426”,
“keyTo”: “#2016-03-09 B01919581”,
“pageInfo”: “T”
},
“control”: {
“more”: true
},
“id”: “916876”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
