Create shipment
create_shipmentCreates an unpaid draft label for one package and returns USPS and UPS rates; no charge until you buy a rate.
Instructions
Unpaid draft label for one package with every rate; buy it with buy_label.
Pirate Ship's Single Shipment form up to Get Rates: makes a draft batch for one package from your ship-from address to the recipient and returns its rates (USPS and UPS services with your price, retail price, estimated delivery, possible ship dates). Nothing is charged; buy_label buys one of the rates, delete_batch drops the draft. Give the package as packaging, weight_oz and size, or package_preset_id of a saved package. When Pirate Ship suggests a corrected address and address_correction is ask, the answer is status address_correction with the suggestion and no draft: call again with accept or skip.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| width_in | No | ||
| height_in | No | ||
| length_in | No | ||
| packaging | No | Parcel | |
| signature | No | none | |
| weight_oz | No | Weight in ounces. | |
| ship_from_id | No | Ship-from address id; default: the account's default. | |
| rubber_stamp_1 | No | Extra text printed on the label. | |
| rubber_stamp_2 | No | ||
| insured_value_usd | No | ||
| package_preset_id | No | A saved package: its type, size and weight replace the fields above. | |
| address_correction | No | When Pirate Ship suggests a corrected address: ask returns the suggestion without a draft, accept ships to the suggestion, skip keeps the address as given. | ask |