List shipments
list_shipmentsRetrieve purchased Pirate Ship labels with recipient, carrier, tracking, cost and status, newest first. Filter by search, date range, status, carrier or batch and page through results.
Instructions
Labels bought in Pirate Ship with recipient, tracking, cost and status, newest first.
The Reports, Shipments table: every label the account bought, with the recipient's address, carrier and service, tracking number and status, cost in US dollars, package size and weight, batch and ship-from address. search works like the table's search box (name, email, tracking number, order id). from_date and to_date narrow by the day the label was created; status, tracking_status, carrier and batch take the values the table shows. total counts every match, limit and offset page through them.
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 |
|---|---|---|---|
| sort | No | Order by date. | newest |
| batch | No | Batch titles. | |
| limit | No | Rows per page, 1 to 100. | |
| offset | No | Rows to skip: the next page starts at offset + limit while it is below total. | |
| 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. |