CLclickpost

Tracking Shipment using Polling

Enterprise can get the latest tracking updates from Clickpost in two ways: Polling or Webhooks. This API uses polling to track an order, given it's waybill number and courier partner ID. Polling API retrieves the historic statuses and the current status of the package.

get/api/v2/track-order/

Request

  • Base URL
    https://api.clickpost.in
  • URL
    https://api.clickpost.in/api/v2/track-order/
  • Auth
    API key in query parameter key

Query parameters

usernamestring required

Username of the customer using the Clickpost API for tracking

keystring required

Unique license key of the customer to be used for authentication

waybillstring required

Waybill of the order

cp_idstring required

Partner ID of the courier responsible for delivering the shipment

Response

200

OR

Example response

{
  "meta": {
    "status": 200,
    "success": true,
    "message": "SUCCESS"
  },
  "result": {
    "4210610508756": {
      "latest_status": {
        "timestamp": "2022-10-31 19:56:16",
        "location": "Faridabad_Mthurard_CP (Haryana)",
        "remark": "Shipment not received from client",
        "status": "Not Picked",
        "clickpost_status_code": 2,
        "clickpost_status_description": "PickupPending",
        "clickpost_status_bucket": 1,
        "clickpost_status_bucket_description": "Order Placed",
        "created_at": "2022-10-27 11:10:28"
      },
      "scans": [
        {
          "timestamp": "2022-10-31 19:56:16",
          "location": "Faridabad_Mthurard_CP (Haryana)",
          "remark": "Shipment not received from client",
          "status": "Not Picked",
          "clickpost_status_code": 2,
          "checkpoint_id": 9629321255,
          "tracking_id": 493656670,
          "created_at": "2022-10-31 15:30:31",
          "clickpost_status_description": "PickupPending",
          "clickpost_status_bucket": 1,
          "clickpost_status_bucket_description": "Order Placed"
        }
      ],
      "valid": true,
      "additional": {
        "order_id": "1234556689",
        "sku": [
          "Footwear"
        ],
        "edd": {
          "max_sla": 3,
          "min_sla": 2
        },
        "invoice_number": "ABCD11111",
        "pickup_city": "Delhi",
        "drop_city": "Bangalore",
        "cod_value": 1000,
        "currency_code": "INR",
        "channel_name": "ABCDEF",
        "ndr": {
          "ndr_bucket_code": 14,
          "ndr_description": "Customer Unavailable"
        },
        "courier_partner_id": 4,
        "courier_partner_name": "Delhivery"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.