Track-parcel

Track Parcel

This API endpoint is used to track a parcel using its tracking number.

Request Body

• tracking_number (string, required): The tracking number of the parcel to be tracked.

Response

The response will be a JSON object with the following properties:

• status (boolean): Indicates the status of the tracking request.

• message (string): A message related to the tracking request, if any.

• data (object): Contains information about the parcel’s pickup origin, destinations, total amount, payment details, status, and timestamps.

The pickup_origin object within the data object contains details about the parcel’s pickup location, including city, region, address, contacts, state code, country code, and pickup center.

The destinations array within the data object contains information about the parcel’s destinations, including city, items, price, weight, address, contacts, state code, center code, country code, and dropoff center.

Other properties within the data object include total_amount, total_discount_amount, total_amount_payable, discount_type, discount_description, tracking_number, complete_date, payment_method, status, payment_ref, cube_ref, ref, created_at, and updated_at.

{
  "status": true,
  "message": "",
  "data": {
    "pickup_origin": {
      "city": "",
      "region": {
        "latitude": 0,
        "longitude": 0
      },
      "address": "",
      "vehicle": null,
      "contacts": {
        "name": "",
        "email": "",
        "phone_number": "",
        "phone_number_2": null
      },
      "state_code": "",
      "pickup_date": null,
      "pickup_note": null,
      "pickup_time": null,
      "country_code": "",
      "pickup_centre": {
        "centre_code": "",
        "centre_name": ""
      }
    },
    "pickup_date": null,
    "destinations": [
      {
        "city": "",
        "items": [
          {
            "name": "",
            "width": null,
            "height": null,
            "length": null
          }
        ],
        "price": {
          "amount": 0,
          "distance": "",
          "duration": "",
          "discount_type": "",
          "amount_payable": 0,
          "discount_amount": 0,
          "discount_description": ""
        },
        "weight": "",
        "address": "",
        "contacts": {
          "name": "",
          "email": "",
          "phone_number": "",
          "phone_number_2": null
        },
        "state_code": "",
        "centre_code": "",
        "item_weight": 0,
        "country_code": "",
        "delivery_note": null,
        "dropoff_centre": {
          "centre_code": "",
          "centre_name": ""
        }
      }
    ],
    "total_amount": 0,
    "total_discount_amount": 0,
    "total_amount_payable": 0,
    "discount_type": "",
    "discount_description": "",
    "tracking_number": "",
    "complete_date": null,
    "payment_method": "",
    "status": "",
    "payment_ref": null,
    "cube_ref": null,
    "ref": null,
    "created_at": "",
    "updated_at": ""
  }
}