Order Event History

This API section deals with order event history related informations.

Please note, this API allows only 1 request per second, per customer. Making more than 1 request per second, from a particular customer will throw a "429" error code. Any successful API call also contains the below rate-limit headers: { 'X-RateLimit-Limit': 1, 'X-RateLimit-Remaining': 5, 'X-RateLimit-Reset': 1 }

wherein; the "X-RateLimit-Limit" header indicates the maximum number of requests that the user can make in the specified time period, the "X-RateLimit-Remaining" header indicates the number of requests that the user has made so far, and, the "X-RateLimit-Reset" header indicates the time (in Unix timestamp format) when the rate limit will reset.

Status history of an Order

GET /orders/{orderId}/status/history

This API call will provide the list of statuses the shipment went through till the current state in which the shipment is. It requires the AWB number of the order whose status history we need to check.

Path Parameters

Name	Type	Description
orderId*	string	AWB Number / Shipment ID received when order is created

Headers

Name	Type	Description
API_KEY*	string	API key obtained by the Customer/Partner

200 Successful Response

{
    "status": "PASS",
    "message": [
        {
            "status": "Pending",
            "time": "2022-03-18T14:53:30.946679+05:30",
            "location": {},
            "address": ""
        },
        {
            "status": "Out-For-Delivery",
            "time": "2022-03-18T18:53:30.946679+05:30",
            "location": {},
            "address": ""
        },
        {
            "status": "Delivered",
            "time": "2022-03-18T20:53:30.946679+05:30",
            "location": {},
            "address": "007, Sethu Rao Rd, Old Tharagupet, K.R. Market, Chickpet, Bengaluru, Karnataka 560002, India"
        }
    ]
}

401 Unauthorized /Wrong api key

{
  "status": "FAIL",
  "message": "Unauthorized"
}