Contents
Description
ip1CustomerBackOrderETA.get will retrieve customer o/s order lines with purchasing information (PO quantities, ETA to warehouse and PO link info.). It can select o/s orders by some portion of customer reference or some portion of item description or item code. It will return one of the following PO link information depending on whether there is purchase order linked to the o/s order or not:
- PO linked to o/s order line
- PO linked by Customer number/Customer reference
- Open PO found
- No PO found
Restrictions
Access to any of the operations in ip1CustomerBackOrderETA.get is dependent on user access.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| customerNumber | 10A | Customer number(Mandatory input) |
| osDocType | 1A | O/S doc type(Optional) |
| customerReference | 30A | Customer reference(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,LNO,SLNO) DB field name:ODT, PN, DOCD, CREF, I |
| 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 |
| lineNumber | 5N0 | Line number |
| documentDate | 10A | Document date |
| customerReference | 30A | Customer reference |
| itemCode | 20A | Item code |
| orderQty | 13N4 | Order quantity |
| osQty | 13N4 | O/S quantity |
| poQty | 13N4 | P/O quantity |
| etaDate | 10A | ETA date |
| warehouse | 4A | Warehouse |
| poLinkInfo | 30a | P/O link info |
| 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”: “ip1CustomerBackOrderETA.get”,
“params”: {
“customerNumber”: “25”,
“osDocType”: “B”,
“noOfRecords”: 3,
“itemDesc”: “Test”,
“sortFields”: [
“DOCD”,
“CREF”
],
“sortOrder”: “D”
},
“id”: “917458”
}
Response:
{
“IptorAPI”: “1.0”,
“data”: {
“lists”: [
{
“osDocType”: “B”,
“processNumber”: “40003927”,
“lineNumber”: 30,
“documentDate”: “2018-06-05”,
“customerReference”: “SUB Q1”,
“itemCode”: “SUBS92”,
“orderQty”: 3,
“osQty”: 1,
“poQty”: 0,
“etaDate”: “0001-01-01”,
“warehouse”: “0001”,
“poLinkInfo”: “No PO found”
},
{
“osDocType”: “B”,
“processNumber”: “40002922”,
“lineNumber”: 40,
“documentDate”: “2017-11-23”,
“customerReference”: “BOT4”,
“itemCode”: “BIN001”,
“orderQty”: 2,
“osQty”: 2,
“poQty”: 0,
“etaDate”: “0001-01-01”,
“warehouse”: “0001”,
“poLinkInfo”: “No PO found”
},
{
“osDocType”: “B”,
“processNumber”: “40002735”,
“lineNumber”: 240,
“documentDate”: “2017-10-10”,
“customerReference”: “JOK”,
“itemCode”: “MBTEST3”,
“orderQty”: 1,
“osQty”: 1,
“poQty”: 1,
“etaDate”: “2018-07-27”,
“warehouse”: “0001”,
“poLinkInfo”: “POlinked to o/s order line”
}
],
“noOfRecordsReturned”: 3,
“keyFrom”: “#2018-06-05SUB Q1 B4000392730 0”,
“keyTo”: “#2017-10-10JOK B40002735240 0”,
“pageInfo”: “T”
},
“control”: {
“more”: true
},
“id”: “917458”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
