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 |
|---|---|---|
| Waybill | a unique value which distinguishes each waybill | TEST005 |
| Date | date of entry | 2021/01/13 |
| SenderCustomerID | numeric id value | 13 |
| SenderName | sender name | James |
| SenderAccountNo | Account Number | Test002 |
| SenderArea | sender area | JOHANNESBURG |
| SenderAreaCode | area code | JNB |
| SenderStateProvince | province | GAUTENG |
| SenderPostalCode | postal code | 2194 |
| SenderContact | a name of contact | Devon |
| SenderTelephone | sender's telephone number' | 011 795 3225 |
| SenderEmail | sender's email address | sender@gmail.com |
| SenderAddress1 | first part of sender's address | Unit 7 Jan Smuts Business Park |
| SenderAddress2 | second part of sender's address | Jones Road |
| SenderAddress3 | third part of sender's address | Jetpark |
| BillableAccountNo | account number | Acc001 |
| ReceiverID | numeric Id | 23 |
| ReceiverName | name of receiver | John Smith |
| ReceiverAccountNo | receiver's account number | |
| ReceiverArea | area receiver is in | JOHANNESBURG |
| ReceiverAreaCode | area code | JNB |
| ReceiverStateProvince | province | GAUTENG |
| ReceiverPostalCode | postal code | 1448 |
| ReceiverContact | name of receiver contact | Jane |
| ReceiverTelephone | receivers telephone number | 011 987 2554 |
| ReceiverEmail | receiver's email | receiver@email.com |
| ReceiverAddress1 | first part of destination address | RACEWAY INDUSTRIAL PARK |
| ReceiverAddress2 | second part of destination address | 15 MONTE CARLO PLACE |
| ReceiverAddress3 | third part of destination address | CNR NURBURG & MONTE CARLO DRIVE GOSFORT PARK |
| Reference | reference | |
| ServiceCode | service code | ECO |
| Weight | numeric weight in kilograms | 3 |
| Pieces | number of pieces | 2 |
| Comments | comments | |
| InvoiceValue | value of invoice | |
| CostCentre | ||
| GroupName | identifier from winfreight | wintest |
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 |
Create Waybill Example
