Create batch
create_batchCreates an unpaid draft batch of up to 500 packages, rating each recipient by rate group so you can buy labels later. Nothing is charged until you purchase.
Instructions
Unpaid draft batch for many packages with the rates of each rate group; buy it with buy_label.
Pirate Ship's spreadsheet upload: one batch for up to 500 recipients from your ship-from address, rated by Pirate Ship. The package (packaging, weight_oz and size, or package_preset_id) applies to every shipment; a recipient's own weight_oz or size overrides it. Pirate Ship splits the batch into rate groups (domestic small, big or heavy, international): buy_label needs one rate_id per group. errors counts rows Pirate Ship could not rate (an address it cannot find); get_batch shows them. Nothing is charged; delete_batch drops the draft.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Batch name. | |
| width_in | No | ||
| height_in | No | ||
| length_in | No | ||
| packaging | No | Parcel | |
| shipments | Yes | ||
| signature | No | none | |
| weight_oz | No | Weight in ounces. | |
| ship_from_id | No | Ship-from address id; default: the account's default. | |
| insured_value_usd | No | ||
| package_preset_id | No | A saved package: its type, size and weight replace the fields above. |