Get Shipment Status
This REST API is used by Uniware to get the recent shipment status (after dispatch) from the shipping provider/aggregator. The list of AWB (waybill) Nos. whose tracking status needs to be determined is sent in request. The shipping provider in response shares the current status (with date) against each AWB No.
Tip
- It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
- The shipping provider is required to share details of their supported shipment statuses with Unicommerce. These details shall mention the status definitions and forward/reverse flags.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| Endpoint: | /waybillDetails |
| Request Type: | GET |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | token (got from SP Authentication) |
Query Parameters
NOTE:
It is a mandate to send AWB No. inside quotes. Eg.: “3113210963421,5213410156781,…N”.
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| waybills | string | List of way bill numbers (with each waybill no. inside quotes) | Yes | Max. 50 AWBs per request, Eg.: 3113210963421 |
Response Payload
{
"status":"SUCCESS",
"waybillDetails":[
{
"currentStatus":"PICKUP_PENDING",
"waybill":"String",
"statusDate":"21-Feb-2023 19:23:00"
}
]
}Response Payload (Error)
{
"status":"FAILED",
"message":"failure reason"
}Response Payload Details
| PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|
| status | string | Status of the API request | Allowable: SUCCESS, FAILED |
| waybillDetails | string | Details of waybill(AWB) | - |
| currentStatus | string | Most recent shipment status | Most recent courier status of shipping package from shipping provider |
| waybill | string | Shipment tracking number | Max. 50 AWBs per response, Eg.: “3113210963421” |
| statusDate | date | Last status date | Eg: 21-Feb-2023 19:23:00 |
| message | string | error message | Failure reason if Status (Failed) Eg: Connect to Shipping Provider |
Error Codes
Refer Response Codes section to know about specific errors codes.