Delete batch
delete_batchDeletes unpaid draft batches or single shipments from Pirate Ship; purchased labels cannot be deleted and must be refunded instead.
Instructions
Deletes an unpaid draft batch or single shipment.
Removes a draft from create_shipment (or any batch not yet bought) from Pirate Ship. Bought labels cannot be deleted: refund_label or refund_batch returns their cost.
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": "delete_batch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes |