List shipments
list_shipmentsRetrieve and filter account shipments by status, carrier, origin or destination geofence, and pickup or delivery dates; search by shipment name to find a specific record.
Instructions
List shipments
Lists the account's shipments, filterable by status, carrier, origin or destination geofence, and
pickup or delivery dates. Use search to find one by name. Each shipment's page in the GPX app is
https://app.gpx.co/shipments/{id}.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_shipments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. Must be at least 1. | |
| sort | No | Sort column, prefixed with - for descending. | |
| search | No | Partial match on the shipment name or carrier. Must not be greater than 255 characters. | |
| status | No | Display status. Comma-separate for several. | |
| carrier | No | Exact carrier name. Comma-separate for several. | |
| per_page | No | Results per page. Defaults to 50, capped at 100. Must be at least 1. Must not be greater than 100. | |
| pickup_after | No | Earliest pickup — actual once departed, otherwise scheduled. Must be a valid date. | |
| pickup_before | No | Latest pickup — actual once departed, otherwise scheduled. Must be a valid date. Must be a date after or equal to <code>pickup_after</code>. | |
| delivery_after | No | Earliest delivery — actual once delivered, otherwise scheduled. Must be a valid date. | |
| delivery_before | No | Latest delivery — actual once delivered, otherwise scheduled. Must be a valid date. Must be a date after or equal to <code>delivery_after</code>. | |
| origin_geofence_id | No | Only shipments departing this geofence. | |
| destination_geofence_id | No | Only shipments arriving at this geofence. |