Tracking
ListByStatus Endpoint
The ListByStatus endpoint allows you to retrieve a list of shipments filtered by their current status.
๐ Endpoint
Sample Request
๐งพ Query Parameters
Parameter | Type | Description |
---|---|---|
Status | string | The shipment status to filter by. See valid values below. |
AsOfStatusDate | date | Filter shipments based on their status as of this date (format: YYYY-MM-DD). |
Limit | integer | Maximum number of records to return per page (max = 5000). |
Page | integer | Page number for pagination. |
โ
Valid Status
Values
OnHold
Exception
Shipped
InTransit
Delivered
DeliveryException
Use these values to filter shipments by their latest status.