HTTP REQUEST
Note: The endpoint can be called by either a GET or POST request.
The following parameters are passed as a json string as part of the authentication request:
| Field | Description | Example | Required |
|---|---|---|---|
| DOCUMENTNO | Document\Waybill\Delivery Number | 2197127565 | Mandatory |
| DATE | Delivery Note Date | 2024-01-29 | Mandatory |
| BRANCH | Despatching Branch | JNB | Mandatory |
| ACCNUM | Paying Customer Account Number | SUM001 | Mandatory |
| SHIPNAME | Sender Customer Name | Sumitomo Rubber | Mandatory |
| SHIPADRES1 | Sender Address Line 1 | 10 Jansen Road | Mandatory |
| SHIPADRES2 | Sender Address Line 2 | ||
| SHIPADRES3 | Sender Address Suburb\Town | Jet Park | Mandatory |
| SHIPADRES4 | Sender Address City | Boksburg | Mandatory |
| SHIPPOSTCODE | Sender Postal code | 1459 | |
| SHIPAREA | Sender Hub | JNB | |
| SENDERNAME | Sender Contact Name | Joe Soap | |
| SHIPTELNO | Sender Telephone Number | 0118266597 | |
| SHIPVATNO | Sender VAT Number | 4380198925 | |
| RECACC | Receiver Account Number | 602720 | Mandatory |
| RECEIVERNAME | Receiver Company Name | BEST DRIVE ISIPINGO | Mandatory |
| RECADDR1 | Receiver Address Line 1 | Springfield Mall | Mandatory |
| RECADDR2 | Receiver Address Line 2 | 24 SPRINGFIELD ROAD | |
| RECADDR3 | Receiver Address Suburb\Town | Springfield | Mandatory |
| RECADDR4 | Receiver Address City | Durban | Mandatory |
| RECPOSTALCODE | Receiver Postal code | 4110 | |
| DESTAREA | Receiver Hub | DUR | |
| RECNAME | Receiver Contact Name | Branch Manager | |
| RECTELNO | Receiver Telephone Number | 0319876543 | |
| RECVATNO | Receiver VAT Number | 4330144744 | Mandatory |
| SERVICE | Service\Order Type | ONX | |
| TOTPARCEL | Total Pieces Quantity | 59 | Mandatory |
| TOTWEIGHT | Total Weight | 10 | Mandatory |
| CUSTORD | Customer Order Number | DSP253764.01 | Mandatory |
| SALESORD | Sales Order Number | 2024799,95 | Mandatory |
| DELINSTRUCT1 | Delivery Instruction Line 1 | ||
| DELINSTRUCT2 | Delivery Instruction Line 2 | ||
| DELINSTRUCT3 | Delivery Instruction Line 3 | ||
| DELINSTRUCT4 | Delivery Instruction Line 4 | ||
| DELINSTRUCT5 | Delivery Instruction Line 5 | ||
| DELINSTRUCT6 | Delivery Instruction Line 6 | ||
| SPECIALINSTRUCT | Any Sprecial Instructions | ||
| CONTENT | Contents of delivery | ||
| TRANSPORTER | Carrier Transporting goods | Thuthukani Transport | Mandatory |
| DISCOUNT | Order Discount | ||
| ROUTE | Route for Delivery | ||
| REFERENCE | Shipper Reference | ||
| GROUPNAME | Group name supplies for API | Mandatory | |
| NOTIFYEMAIL | Email address to be notified | ||
| TIME | 13:30 | Mandatory |
HTTP RESPONSE
The possible responses from calling this endpoint are as follows:
| Response | Description |
|---|---|
| Success | returns a json ResultSet including the SuccessMessage: OK - Document has been created successfully! |
| Failure | this is a data error, it returns a json ResultSet including the appropriate ErrorMessage such as Document Number cannot be blank, already exists or missing parameters, or wrong format |
| Error | this is a server error, an appropriate ErrorMessage is returned from the server |