Shipment Confirmation by Order
This interface returns when stock was shipped on AdOr5 and shows items per order.
Below you will find the Actions with descriptions and the Specfication for the requests.
Actions
POST
This interface allows you to post to the ShipmentConfirmationByOrderSTD_API Interface
Request details
Method | Endpoint | Header key | Header Value |
---|---|---|---|
POST | BaseURL/api/outbound/confirmation | X-AUTH-TOKEN | Integration Service API key |
Request Body
{
"interfaceName" : "ShipmentConfirmationByOrderSTD_API",
"returnDetailedData" : true,
"data": [{
"count": 1
}]
}
Request Response
{
"success": true,
"message": null,
"errorData": null,
"returnData": {
"Shipment": [
{
"messageType": "Shipment",
"shipdate": "2018-02-21T09:34:13.727",
"shipmentdesc": "S0010433",
"numberofhus": "5",
"totalweight": "",
"reference1": "N1 CITY",
"reference2": "",
"reference3": "DELIVERY",
"orders": [
{
"orderno": "23442.251001",
"destno": "MVI001",
"destname1": "N1 CITY VALUE CENTRE",
"destname2": "FRUIT & VEG CITY (PTY) LTD",
"destaddress1": "T/A FLM N1 CITY VALUE CENTRE",
"destaddress2": "SHOP 77,N1CITY VALUE CNTR, SOL",
"destcity": "",
"desttowncode": "",
"destpostalcode": "",
"destcountrycode": "ZA",
"destcontact": "",
"desttelephone": "",
"destref": "793#000031",
"clientno": "169",
"clientname": "J.E.F",
"clientdesc": "J.E.F",
"items": [
{
"styleno": "55700",
"skuno": "55700",
"itematt1": null,
"itematt2": null,
"itematt3": null,
"itematt4": null,
"itematt5": null,
"lineno": 1,
"qty": 310,
"customerno": "185",
"customerdesc": "FLM"
}
]
}
]
}
]
}
}
Specification
Shipment Header
Field | Type |
---|---|
messageType | String |
shipdate | Timestamp |
shipmentdesc | String |
numberofhus | String |
totalweight | String |
reference1 | String |
reference2 | String |
reference3 | String |
Orders
Field | Type |
---|---|
orderno | String (30) |
destno | String (30) |
destname1 | String (50) |
destname2 | String (30) |
destaddress1 | String (70) |
destaddress2 | String (40) |
destcity | String (30) |
desttowncode | String (10) |
destpostalcode | String (20) |
destcountrycode | String (10) |
destcontact | String (30) |
desttelephone | String (30) |
destref | String (30) |
clientno | String |
clientname | String |
clientdesc | String |
Items
Field | Type |
---|---|
styleno | String (30) |
skuno | String (30) |
itematt1 | String (40) |
itematt2 | String (40) |
itematt3 | String (40) |
itematt4 | String (40) |
itematt5 | String (40) |
lineno | Integer |
qty | Integer |
customerno | String |
customerdesc | String |