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 |
---|---|---|
WaybillNo | a unique value which distinguishes each waybill | Test004 |
PcsCount | number of parcels (numeric value) | 5 |
ParcelNos | list of parcel numbers separated by comma delimeter | Pnrx1,Pnrx2,Pnrx3,Pnrx4,Pnrx5 |
Items | number of items for each parcel, separated by comma | 1,1,1,1,1 |
ItemCode | TestItemCode | |
Height | height for each parcel separated by comma | 2,4,5,6,7 |
Length | length for each parcel separated by comma | 3,3,2,4,5 |
Width | width for each parcel separated by comma | 4,6,7,7,4 |
Kgs | weight for each parcel separated by comma | 40,55,66,88,44 |
FileName | FileName1.xlsx | |
Status | 1 | |
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 - Parcel No - has been created successfully! |
Failure | this is a data error, it returns a json ResultSet including the appropriate ErrorMessage such as Parcel No, already exists or missing parameters, or wrong format |
Error | this is a server error, an appropriate ErrorMessage is returned from the server |