Shipments Count

Shipments Count - Retrieve shipment totals by status group

Use this endpoint to retrieve total shipment counts grouped by operational status.

This endpoint is useful for dashboards, reporting, and high-level operational monitoring.

Status groups

totalShipment - total number of shipments.
totalToBePickedUp - shipments created and ready for pickup.
totalToBeDelivered - shipments currently moving through pickup, sorting, delivery, reattempt, or temporary return flows.
totalDelivered - shipments successfully delivered.
totalCanceled - shipments cancelled or marked as undeliverable.
totalToBeReturned - shipments in the process of being returned to the origin pickup location.
totalReturned - shipments already returned to the origin pickup location.

Important notes

This endpoint returns counts only, not shipment details.
Use All Shipments to retrieve shipment records for a specific status.

Status → Count field mapping

booked → totalToBePickedUp (ready for pickup)

to_dc_truck_transit, at_dc, to_delivery, delivery_reattempt, to_return, returned, delivery_attempt_failed, delayed → totalToBeDelivered

delivered → totalDelivered

cancelled, undeliverable → totalCancelled

to_return_origin, in_transit_to_return_origin → totalToBeReturned (permanent return after 3 failed attempts, invalid address or other serious issue with the delivery)

returned_origin → totalReturned (already returned to origin)

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Counts by status.

Bodyapplication/json

Example

{
    "status": "success",
    "data": {
        "totalShipment": 1336,
        "totalToBePickedUp": 76,
        "totalToBeDelivered": 18,
        "totalDelivered": 1232,
        "totalToBeReturned": 0,
        "totalReturned": 0,
        "totalCanceled": 8
    }
}

🟠401

🔴500

Shipments Count - Retrieve shipment totals by status group

Status groups

Important notes

Request

Request Code Samples

Responses

Shipments Count

Shipments Count - Retrieve shipment totals by status group#

Status groups#

Important notes#

Request

Request Code Samples

Responses

Shipments Count - Retrieve shipment totals by status group

Status groups

Important notes