Order Confrimation
This interface is used to inform the host system when an order has been confirmed.
Below you will find the Actions with descriptions and the Specfication for the requests.
Actions
POST
This method allows you to post to the OrderConfirmationSTD_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" : "OrderConfirmationSTD_API",
"returnDetailedData" : true,
"data": [{
"count": 1
}]
}
Request Response
{
"success": true,
"message": null,
"errorData": null,
"returnData": {
"Orders": [
{
"orderno": "8156.250001",
"priority": 10,
"duedate": "2020-07-04T18:01:04",
"ordersource": "External",
"createdate": "2020-07-04T07:19:54.552",
"shipfromdate": "2020-07-04T07:19:54.536",
"despatchdate": "2020-07-04T09:42:15.087",
"vas": 0,
"vastext": null,
"subpack": 0,
"courierref": null,
"destno": "TYG001",
"destname1": "TYGERVALLEY",
"destname2": null,
"destaddress1": null,
"destaddress2": null,
"destcity": null,
"desttowncode": null,
"destpostalcode": null,
"destcountrycode": "ZA",
"desthub": null,
"destcontact": null,
"desttelephone": "(021) 914 8011",
"destref": "644#000013",
"note1": null,
"printoptions": null,
"closedate": "2020-07-04T09:42:15.087",
"closereason": "Despatched",
"sealstart": null,
"exporttrigger": "DESPATCH",
"salesorg": null,
"inputline": null,
"subpackversion": 0,
"destref2": null,
"printdespatchnote": 1,
"printconsignmentnote": 0,
"xdp": null,
"sequenceno": 0,
"note2": null,
"invoiceprinted": 0,
"despnoteprnstatus": 0,
"processareano": null,
"campaignno": null,
"campaigndesc": null,
"volumeconsolidation": 0,
"startdate": "2020-07-04T07:19:54.536",
"firstpacktime": "2020-07-04T09:27:05.184",
"reference1": null,
"reference2": null,
"reference3": null,
"wipdate": "2020-07-04T08:25:44.264",
"allocationresult": null,
"confirmfromdate": null,
"requireweightanddims": 1,
"firstduchecktime": null,
"autocreatepacking": 0,
"destaddress3": null,
"destaddress4": null,
"ordertypeno": "DEFAULT",
"ordertypedesc": "DEFAULT",
"trandate": "2020-06-30T13:55:25.658",
"clientno": "169",
"clientname": "J.E.F",
"clientdesc": "J.E.F",
"messageType": "Shipment",
"messageid": 51,
"items": [
{
"lineno": "1",
"styleno": "57829",
"skuno": "57829",
"ref1": "390.01",
"ref2": null,
"itematt1": null,
"itematt2": null,
"itematt3": null,
"itematt4": null,
"itematt5": null,
"itemattvalue1": null,
"itemattvalue2": null,
"itemattvalue3": null,
"qty": 1,
"unitqty": "1",
"customerno": "185",
"customerdesc": "JIMbo"
},
{
"lineno": "2",
"styleno": "57830",
"skuno": "57830",
"ref1": "515.00",
"ref2": null,
"itematt1": null,
"itematt2": null,
"itematt3": null,
"itematt4": null,
"itematt5": null,
"itemattvalue1": null,
"itemattvalue2": null,
"itemattvalue3": null,
"qty": 2,
"unitqty": "2",
"customerno": "185",
"customerdesc": "JIMbo"
},
{
"lineno": "3",
"styleno": "60256",
"skuno": "60256",
"ref1": "428.55",
"ref2": null,
"itematt1": null,
"itematt2": null,
"itematt3": null,
"itematt4": null,
"itematt5": null,
"itemattvalue1": null,
"itemattvalue2": null,
"itemattvalue3": null,
"qty": 1,
"unitqty": "1",
"customerno": "185",
"customerdesc": "JIMbo"
}
]
}
]
}
}
Specification
Order Header
| Field | Type |
|---|---|
| orderno | String (30) |
| priority | Integer |
| duedate | Timestamp |
| ordersource | String (30) |
| createdate | Timestamp |
| shipfromdate | Timestamp |
| despatchdate | Timestamp |
| vas | Integer |
| vastext | String (2048) |
| subpack | Integer |
| courierref | Integer |
| 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) |
| desthub | String (10) |
| destcontact | String (30) |
| desttelephone | String (30) |
| destref | String (30) |
| note1 | String (255) |
| printoptions | String (10) |
| closedate | Timestamp |
| closereason | String (255) |
| sealstart | Timestamp |
| exporttrigger | String (10) |
| salesorg | String (20) |
| inputline | String (1000) |
| subpackversion | integer) |
| destref2 | String (30) |
| printdespatchnote | Integer |
| printconsignmentnote | Integer |
| xdp | String (30) |
| sequenceno | Integer |
| note2 | String (255) |
| invoiceprinted | Integer |
| despnoteprnstatus | Integer |
| processareano | String (30) |
| campaignno | String (20) |
| campaigndesc | String (50) |
| volumeconsolidation | Integer |
| startdate | Timestamp |
| firstpacktime | Timestamp |
| reference1 | String (30) |
| reference2 | String (30) |
| reference3 | String (30) |
| wipdate | Timestamp |
| allocationresult | String (500) |
| confirmfromdate | Timestamp |
| requireweightanddims | Integer |
| firstduchecktime | Timestamp |
| autocreatepacking | Integer |
| destaddress3 | String (70) |
| destaddress4 | String (70) |
| ordertypeno | String (10) |
| ordertypedesc | String (30) |
| trandate | Timestamp |
| clientno | String(30) |
| clientname | String(30) |
| clientdesc | String(50) |
| messageType | String (30) |
| messageid | Integer |
Items
| Field | Type |
|---|---|
| lineno | Integer |
| styleno | String (30) |
| skuno | String (30) |
| ref1 | String (50) |
| ref2 | String (50) |
| itematt1 | String (40) |
| itematt2 | String (40) |
| itematt3 | String (40) |
| itematt4 | String (40) |
| itematt5 | String (40) |
| itemattvalue1 | Double |
| itemattvalue2 | Double |
| itemattvalue3 | Double |
| qty | Integer |
| unitqty | Integer |
| customerno | String(30) |
| customerdesc | String(50) |