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 |
|---|---|---|
| MasterWaybill | To be referenced after the inital Create Waybill call i.e. Inital Create Waybill call becomes the Master Waybill /Waybills | TEST005 |
| Waybill | a unique value which distinguishes each waybill | TEST005 |
| DateWay | date of entry | 2021/01/13 |
| Branch | the branch from which waybill is originating | JNB |
| AccNum | Account Number | Test002 |
| CustName | customer name | Huli Corp |
| SHIPADRES1 | first part of shipment address | Unit 7 Jan Smuts Business Park |
| SHIPADRES2 | second part of shipment address | Jones Road |
| SHIPADRES3 | third part of shipment address | Jetpark |
| SHIPADRES4 | fourth part of shipment address | JOHANNESBURG |
| SENDAREA | destination city code | JNB |
| CONSIGNAME | company name of waybill recepient | ULTRA CITY |
| CONADDR1 | first part of destination address | RACEWAY INDUSTRIAL PARK |
| CONADDR2 | second part of destination address | 15 MONTE CARLO PLACE |
| CONADDR3 | destination town | GERMISTON |
| CONADDR4 | third part of destination address | CNR NURBURG & MONTE CARLO DRIVE GOSFORT PARK |
| DESTAREA | destination area | JNB |
| CONNAME | name of individual | PIETER |
| CONTELNO | telephone number | 011 795 3227 |
| SERV_C | service code | ECO |
| NUMPARCEL | number of parcels | 1 |
| MASSKG | mass of parcels in kg | 10 |
| GroupName | identifier from winfreight | wintest |
| FromPostalCode | optional field | |
| ToPostalCode | optional field | |
| Refnum | optional field | |
| Content | optional field |
HTTP RESPONSE
The possible responses from calling this endpoint are as follows:
| Response | Description |
|---|---|
| Success | returns a json ResultSet including the SuccessMessage: OK - Waybill No - has been created successfully! |
| Failure | this is a data error, it returns a json ResultSet including the appropriate ErrorMessage such as Collection No, already exists or missing parameters, or wrong format |
| Error | this is a server error, an appropriate ErrorMessage is returned from the server |