Contents
Description
This API will retrieve o/s purchase orders and o/s shipments for an item.
Restrictions
Access to any of the operations in ip1ItemOnOrders.get is dependent on user access.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| itemCode | 20A | Item code |
| Output | Type | Description |
| totalOnOrderQty | 13N4 | Total On-order quantity |
| totalOnBoardQty | 13N4 | Total On-board quantity |
| listPO | List of POs | |
| poType | 1A | PO type |
| poNumber | 8A | PO number |
| poLineNumber | 5N0 | PO line number |
| poSubLineNumber | 3N0 | PO sub line number |
| shippingMethod | 1A | Shipping method |
| osOnOrderQty | 13N4 | O/S On-order quantity |
| etaDate | 10A | ETA date |
| warehouse | 4A | Warehouse |
| warehouseName | 10a | Warehouse name |
| boLinked | 30a | B/O linked |
| listShipment | List of shipments | |
| shipID | 8A | Ship ID |
| supplier | 10A | Supplier |
| invoiceNumber | 8A | Invoice number |
| invoiceLineNumber | 5N0 | Invoice line number |
| invoiceSubLineNumber | 3N0 | Invoice sub line number |
| shippingMethod | 1A | Shipping method |
| osOnBoardQty | 13N4 | O/S on-board quantity |
| etaDepot | 10A | ETA date depot |
| etaWarehouse | 10A | ETA date warehouse |
| warehouse | 4A | Warehouse |
| warehouseName | 10a | Warehouse name |
| poLinked | 30a | P/O linked |
JSON example
View JSON request & response expampleRequest:
{“IptorAPI”:”1.0″,”method”:”ip1ItemOnOrders.get”,”params”:{“itemCode”:”mOI1″},”i
d”:”917458″}
Response:
{
“IptorAPI”: “1.0”,
“data”: {
“totalOnOrderQty”: 93,
“totalOnBoardQty”: 98,
“listPO”: [
{
“poType”: “A”,
“poNumber”: “S0012422”,
“poLineNumber”: 1,
“poSubLineNumber”: 0,
“shippingMethod”: “L”,
“osOnOrderQty”: 10,
“etaDate”: “2008-10-03”,
“warehouse”: “0001”,
“warehouseName”: “SYDNEY”,
“boLinked”: “”
},
{
“poType”: “A”,
“poNumber”: “S0012423”,
“poLineNumber”: 2,
“poSubLineNumber”: 0,
“shippingMethod”: “L”,
“osOnOrderQty”: 5,
“etaDate”: “2006-09-29”,
“warehouse”: “0001”,
“warehouseName”: “SYDNEY”,
“boLinked”: “”
},
{
“poType”: “A”,
“poNumber”: “S0012484”,
“poLineNumber”: 1,
“poSubLineNumber”: 0,
“shippingMethod”: “L”,
“osOnOrderQty”: 10,
“etaDate”: “2006-10-03”,
“warehouse”: “0001”,
“warehouseName”: “SYDNEY”,
“boLinked”: “”
}
],
“listShipment”: [
{
“shipID”: “19072501”,
“supplier”: “SIMON”,
“invoiceNumber”: “19072501”,
“invoiceLineNumber”: 2,
“invoiceSubLineNumber”: 0,
“shippingMethod”: “S”,
“osOnBoardQty”: 98,
“etaDepot”: “0001-01-01”,
“etaWarehouse”: “2019-07-25”,
“warehouse”: “ANGI”,
“warehouseName”: “MC NO LOCS”,
“poLinked”: “A:00090928:00005:000”
},
{
“shipID”: “00520485”,
“supplier”: “SIMON”,
“invoiceNumber”: “A00090930”,
“invoiceLineNumber”: 3,
“invoiceSubLineNumber”: 0,
“shippingMethod”: “S”,
“osOnBoardQty”: 1,
“etaDepot”: “2019-10-04”,
“etaWarehouse”: “2019-10-04”,
“warehouse”: “ANU1”,
“warehouseName”: “”,
“poLinked”: “A:00090930:00002:004”
},
{
“shipID”: “00520485”,
“supplier”: “SIMON”,
“invoiceNumber”: “A00090930”,
“invoiceLineNumber”: 3,
“invoiceSubLineNumber”: 1,
“shippingMethod”: “S”,
“osOnBoardQty”: 3,
“etaDepot”: “2019-10-04”,
“etaWarehouse”: “2019-10-04”,
“warehouse”: “MP01”,
“warehouseName”: “MDPWHS”,
“poLinked”: “A:00090930:00002:008”
}
]
},
“id”: “917458”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
