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 |
|---|---|
| CollectionNo | a unique value to distinguish collection. |
| Date | Date in the format: YYYY/MM/DD |
| FromClientName | name of client from whom collection is originating. |
| FromAccountNo | account number from which collection is originating. |
| FromTown | town or area from which collection is originating. |
| ToAccountNo | account number to which collection is being sent to. |
| ToClientName | name of client to whom collection is being sent to. |
| ToTown | town or area to which collection is being sent to. |
| ServiceCode | e.g ONX (overnight courier), NDX (normal air)... |
| TotalWeight | a numeric value indicating the sum total weight of all items in collection. |
| Pieces | a numeric value indicating the number of individual items in the collection. |
| Comments | |
| CollectionStatus | indicates whether the collection is complete or pending |
| Branch | the branch from which collection is being made |
| API_User | User who entered data. |
| Driver | |
| FromAddress1 | Building name and unit number of sender. |
| FromAddress2 | Street name of sender. |
| FromAddress3 | Name of suburb or industrial area. |
| FromTownCode | Town code of sender. |
| FromContact | Name of sender |
| FromTel | Phone number of sender |
| ToAddress1 | Building name and unit number of receiver. |
| ToAddress2 | Street name of receiver. |
| ToAddress3 | Name of suburb or industrial area of receiver. |
| ToTownCode | Town code of receiver |
| ToContact | Name of receiver. |
| ToTel | Phone number of receiver. |
| Reference | |
| SpecialInstructions | Instructions specific to collection. |
| GroupName | Group name specifies databse to which post must be saved. Use group name assigned to you by winfreight. |
HTTP RESPONSE
The possible responses from calling this endpoint are as follows:
| Response | Description |
|---|---|
| Success | returns a json ResultSet including the SuccessMessage: OK - Collection 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 Collection 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