Shipments Count

GET

/order/shipmentsCount

Returns total counts of shipments separated by status.

ShipmentCount — Status mapping

This endpoint returns total counts grouped by internal shipment status.

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)

Request

Authorization

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

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/order/shipmentsCount' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example

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

All Shipments

Shipment Details

Shipments Count

ShipmentCount — Status mapping#

Request

Responses

ShipmentCount — Status mapping