Export shipments
export_shipmentsGenerates a CSV download link for filtered shipment labels, enabling reporting with one row per label across recipient, tracking, carrier, cost, package, batch, and order data.
Instructions
A CSV of the shipments report with every column, as a download link.
Builds the same spreadsheet as the Export button of Reports, Shipments: one row per label with every column (recipient and address, tracking, carrier and service, cost, package, batch, ship-from, order id, rubber stamps). Takes the filters of list_shipments. Returns a link to the CSV; a filter with no matching labels returns empty true and no link. Large exports can take up to a minute.
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": "export_shipments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Order by date. | newest |
| batch | No | Batch titles. | |
| search | No | Free text, as in the report's search box. | |
| status | No | Label status as the report shows it, e.g. Printed, Refunded. | |
| carrier | No | USPS or UPS. | |
| to_date | No | Last day, YYYY-MM-DD, included. | |
| from_date | No | First day, YYYY-MM-DD, in your timezone. | |
| tracking_status | No | Tracking status as the report shows it, e.g. Delivered, In Transit. |