Shipments Count

Shipments Count - Get shipment totals by status

Use this endpoint to retrieve the total number of iCarry shipments grouped by shipment status.

The response provides summary counts such as total shipments, shipments waiting for pickup, shipments in delivery, delivered shipments, cancelled shipments, and return-related shipments.

When to use this endpoint

To display shipment status totals on a dashboard.
To monitor how many shipments are pending pickup, in progress, delivered, cancelled, or returned.
To get a quick operational summary without retrieving the full shipment list.

Important notes

This endpoint returns counts only, not detailed shipment records.
No request body or input parameters are required.
Some response fields may group multiple internal shipment statuses under one summary count.

Note

totalToBeDelivered includes active delivery statuses (to_delivery, delivery_reattempt), temporary return statuses (to_return, returned) that can be reattempted, and also delivery_attempt_failed and delayed.

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 ********************

application/json

Successful response

Body

Example

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

Shipments Count - Get shipment totals by status

When to use this endpoint

Important notes

Request

Request Code Samples

Responses

Shipments Count

Shipments Count - Get shipment totals by status#

When to use this endpoint#

Important notes#

Request

Request Code Samples

Responses

Shipments Count - Get shipment totals by status

When to use this endpoint

Important notes