Info
  • Web service URL: BASE_URL/api/Track/by-awb/with-return


TABLE OF CONTENTS


1 Get Track statuses - complete (POST Method)

Request body

NameTypeRequiredDescription
courierintYesCourier Id - See Couriers table
awbListstring []YesComma separated Awbs - limit 200

Track Response

NameTypeDescription
orderIdintInnoship Order Id
courierintSee Couriers table
shipmentAwbstringCourier AWB number
carrierMeasuredWeightdoublereweight info (if exists)
historyHistory []Event history for main AWB
ReturnAwbstringReturn AWB number if exists
ReturnAwbHistoryHistory []Event history for return AWB
cashOnDeliveryHistoryHistory []Event history for cod AWB

History [] :

NameTypeDescription
clientStatusIdintSee Statuses Table
clientStatusDescriptionstringText description of status
eventDateDateDate of event from courier
isFinalStatusbooleanTrue if this is a final status


1.1 Track service response example

200 - Response 

[
    {
        "returnAwb": null,
        "returnAwbHistory": null,
        "orderId": 3960893,
        "courier": 1,
        "shipmentAwb": "942116818",
        "carrierMeasuredWeight": null,
        "history": [
            {
                "clientStatusId": 1,
                "clientStatusDescription": "New",
                "eventDate": "2021-07-02T11:50:38.196413",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 2,
                "clientStatusDescription": "Picked-Up",
                "eventDate": "2021-07-02T13:04:06",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 10,
                "clientStatusDescription": "In Courier WH",
                "eventDate": "2021-07-02T15:43:07",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 20,
                "clientStatusDescription": "In Transit",
                "eventDate": "2021-07-02T19:41:50",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 10,
                "clientStatusDescription": "In Courier WH",
                "eventDate": "2021-07-03T00:25:41",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 20,
                "clientStatusDescription": "In Transit",
                "eventDate": "2021-07-03T00:26:01",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 10,
                "clientStatusDescription": "In Courier WH",
                "eventDate": "2021-07-03T06:43:15",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 30,
                "clientStatusDescription": "Out for Delivery",
                "eventDate": "2021-07-05T05:21:11",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 36,
                "clientStatusDescription": "Not Home",
                "eventDate": "2021-07-05T10:38:57",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 100,
                "clientStatusDescription": "Delivered",
                "eventDate": "2021-07-05T10:44:25",
                "isFinalStatus": true
            }
        ],
        "cashOnDeliveryHistory": [
            {
                "clientStatusId": 1,
                "clientStatusDescription": "New",
                "eventDate": "2021-07-02T11:50:38.196414",
                "isFinalStatus": false
            },
            {
                "clientStatusId": 2,
                "clientStatusDescription": "Collected",
                "eventDate": "2021-07-05T00:00:00",
                "isFinalStatus": false
            }
        ]
    }
]

400 - Bad request 

"errors": [
        {
            "message": "Invalid request. Incorrect AWB list provided",
            "details": null
        }
    ],
    "correlationId": null
}