Get batch
get_batchRetrieve a Pirate Ship batch to inspect shipments, tracking numbers, rates available to buy, label status, and refund eligibility for drafting, purchasing, or managing labels.
Instructions
A draft or bought batch: shipments, tracking, rates to buy, what can be refunded.
One Pirate Ship batch: a single label from create_shipment is a batch of one. A draft (step Rated) lists every rate the packages qualify for, with rate_id for buy_label. A bought batch (Billed) shows each shipment's status, tracking number and link, whether its label can be printed or refunded, and what was paid per service.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"batch_id": "<batch_id>"
},
"name": "get_batch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | From create_shipment or list_batches. |