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

Query Parameters

NOTE:

It is a mandate to send AWB No. inside quotes. Eg.: “3113210963421,5213410156781,…N”.

Response Payload

{
  "Status": "SUCCESS",
  "waybillDetails": [
    {
      "waybill": "80224636450",
      "currentStatus": "PICKUP_PENDING",
      "current_sub_status": "out for pickup",
      "current_status_remark": "pickup is yet to be done",
      "statusDate": "05-Aug-2023 03:52:09",
      "shipping_provider": "LSP Name"
      "current_location": "Mumbai_Turbhe_C (Maharashtra)",
      "current_pincode": "400703",
      "current_city": "Navi Mumbai",
      "current_state": "Maharashtra",
      "current_country": "India",
      "latitude": "",
      "longitude": "",
      "expected_date_of_delivery": "07-Aug-2023 03:52:09",
      "promised_date_of_delivery": "08-Aug-2023 03:52:09",
      "payment_type": "COD",
      "weight": "500",
      "dimensions": {
        "l": "100",
        "b": "120",
        "h": "150"
      },
      "delivery_agent_name": "",
      "delivery_agent_number": "",
      "attempt_count": "1",
      "ndr_code": "",
      "ndr_reason": "REFUSAL CONFIRMATION CODE VERIFIED",
      "next_delivery_date": "09-Aug-2023 03:52:09",
      "cir_pickup_datetime": "",
      "tracking_history": [
        {
          "date_time": "Mumbai_Turbhe_C (Maharashtra)",
          "status": "InfoReceived",
          "sub_status": "OutForPickup",
          "remark": " shipment has been picked",
          "location": "Mumbai_Turbhe_C (Maharashtra)",
          "pincode": "400703",
          "city": "Navi Mumbai",
          "state": "Maharashtra",
          "country": "India"
        },
        {
          "date_time": "Mumbai_Turbhe_C (Maharashtra)",
          "status": "InfoReceived",
          "sub_status": "OutForPickup",
          "remark": " shipment has been picked",
          "location": "Mumbai_Turbhe_C (Maharashtra)",
          "pincode": "400703",
          "city": "Navi Mumbai",
          "state": "Maharashtra",
          "country": "India"
        }
      ],
      "parent_awb": "",
      "rto_awb": "",
      "rto_reason": "",

    }
  ],
  "message": "String"
}

Response Payload (Error)

{
   "status":"FAILED",
   "message":"failure reason",
   "waybillDetails":[]
}

Response Payload Details

NOTE:

The charges and price details can be provided either at order level or order item level (charges which are common), but not in both. However, it is recommended to send price at order item level for better handling.

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What is call frequency for tracking status API? Is it possible to call it every 60 minutes?
Ans. Tracking status API is called 4 times a day. No, it cannot be called every 60 mins.

Q2. How does UC manage tracking statuses, or what method should we (the shipping provider) use to transmit status milestones?
Ans. Initially, we require a comprehensive list of tracking statuses (milestones) from the shipper partner’s side. Within UC, we’ll conduct mapping against all tracking statuses using the provided list.. If a shipping provider has only parent status construct then we need all such status codes only against the field “currentStatus” on the other hand if shipping has Parent-Child construct then we need both statuses in the respective field currentStatus and current_sub_status and we will concatenate both the values received in these two fields  with a hyphen (-).
Note: current_sub_status : Keep it as blank "" until you have discussed this with the UC team. Else, current integration will be broken.

For example:
“currentStatus”:“Delivered”,
“current_sub_status”:“Delivered to CX”

And in mapping sheet we received both the statuses. In UC, we handle this Courier Status as DELIVERED-Delivered to CX and for this proper status mapping must be done with UC.

Q3. If the shipping partner doesn’t have any specific parameter handling on their end, what do they need to pass the value?
Ans. At shipping partner end any specific parameter handling or data is not available then they need to pass blank "" or skip such parameters in the response payload. Avoid to pass Null.
Example:
Sample 1:
“currentcountry”: “India”,
“latitude”: "",
“longitude”: "",
Sample 2:
or just skip last two params:
“currentcountry”: “India”,