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 |
|---|---|
| WaybillNo | a unique value which distinguishes each waybill |
| DocType | |
| Ref2 | |
| Ref3 | |
| Ref4 | |
| FromAccountNo | account number from which collection is originating. |
| FromClientName | name of client to whom collection is being sent to. |
| FromAdd1 | Building name and unit number of sender. |
| FromAdd2 | Street name of sender. |
| FromAdd3 | Name of suburb or industrial area. |
| FromBuildingName1 | |
| FromBuildingName2 | |
| FromSuburb | |
| FromCity | |
| FromProvince | |
| FromCountry | |
| FromPostalCode | |
| FromContact | Name of sender |
| FromTelephone | Phone number of sender |
| FromEmail | |
| ToAccountNo | |
| ToClientName | |
| ToAdd1 | |
| ToAdd2 | |
| ToAdd3 | |
| ToBuildingName1 | |
| ToBuildingName2 | |
| ToSuburb | |
| ToCity | |
| ToProvince | |
| ToCountry | |
| ToPostalCode | |
| ToContact | |
| ToTelephone | |
| ToEmail | |
| Pieces | number of separate items in the waybill. |
| TotalWeight | total sum of all the pieces. |
| ServiceCode | |
| APIuser | |
| SpecialInstructions | |
| WaybillStatus | |
| BillAccnum | |
| Carrier | |
| GroupName | |
| MasterWaybill |
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 |
Authentication Example
API & Development Support
If you require any assistance on integrating your system with Winfreight, please contact our support team at: support@winfreight.co.za