Pirate Ship by Cotlet

Moves a draft batch to another ship date and returns its new rates. The ship date on Pirate Ship's buy page: rates are fetched again for that day, so prices and estimated delivery can change. Pick a date from a rate's ship_dates. Works on drafts only.

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.

Turns store orders into a batch of shipments with one saved package; nothing is bought. Creates a Pirate Ship batch from imported orders: recipients come from the orders, size and weight from the saved package. The batch is rated, not paid: no label is bought. Large batches are built in the background (progress in the answer).

Adds a tracking email template for the emails recipients get with their tracking link. Saves a new tracking email template. Nothing is sent now: Pirate Ship uses the template when a label is bought with tracking emails on. html takes the placeholders [Recipient First Name], [Ship Date], [Shipping Service], [Recipient Address] and [Tracking #].

Saves a package (type, size, weight, extra services) for reuse on labels. Adds a Saved Package in Settings. Parcel, SoftEnvelope and Irregular need length_in and width_in, a box also height_in; flat rate packaging needs none. weight_oz 0 leaves the weight to each label. default true preselects it on new shipments.

USPS End of Day SCAN Form for the labels of one Ship Date, as a PDF link. Puts the USPS labels of one Ship Date and Ship From Address (or of one batch) that have no SCAN Form yet on a new SCAN Form and returns its PDF link. The carrier scans that one sheet instead of every package. No labels without a form: Pirate Ship answers with an error.

Adds a US Ship From Address, optionally with a separate return address. Saves a new Ship From Address in Pirate Ship. Without return_address, returns go to the origin. Pirate Ship completes the ZIP+4. It does not become the default: call set_default_ship_from_address for that.

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.

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.

Removes a tracking email template.

Removes a Saved Package. Labels made with it are not affected.

Removes a saved Ship From Address. The default address cannot be removed. Deletes one Ship From Address from Settings. Labels already bought are not affected. Pirate Ship keeps at least one address and never deletes the default: make another one the default first.

A download link for the printable labels of a batch or of chosen shipments. Pirate Ship's Print Labels: builds one file with the bought, printable labels of batch_id or of shipment_ids, in the account's label size and format (Settings, Label Settings), and returns its link. Building takes a few seconds. Refunded labels and return labels that print later are left out.

A CSV of the transactions, refunds, receipts, return labels or carrier adjustments report. Builds the same spreadsheet as the Export button of the chosen Reports table, with every column of the matching list_ tool, for an optional date range and search. Returns a link to the CSV; no matching rows return empty true and no link. Shipments have their own tool, export_shipments.

A CSV of the shipments report with every column, as a download link. Builds the same spreadsheet as the Export button of Reports, Shipments: one row per label with every column (recipient and address, tracking, carrier and service, cost, package, batch, ship-from, order id, rubber stamps). Takes the filters of list_shipments. Returns a link to the CSV; a filter with no matching labels returns empty true and no link. Large exports can take up to a minute.

Account Balance, Pending Refunds and Pending Returns from the Reports page. The Pirate Ship account balance in US dollars (balance_settled_usd leaves out payments still settling), how many payment methods are saved, refunds and return labels still pending, and the last 30 days of labels as the Reports page shows them: label count, total, average and payments.

Takes no parameters.

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.

Label size and file format, packing list, logo, QR codes, address correction, export format. The account's Settings, General: the size and file format new labels are made in, whether a packing list prints with them, the logo on the label, USPS label-free QR codes, what happens when Pirate Ship finds a better address, and the spreadsheet format of report exports.

Takes no parameters.

What a USPS or UPS pickup would cost; USPS pickups are free. Nothing is booked. Prices one pickup without booking it. USPS collects for free on the next delivery day. UPS charges per pickup and needs a date and a ready and close time; surcharges are listed apart.

USPS and UPS services with price for one package, cheapest first. Pirate Ship's Quick Rate Quote: every USPS and UPS service that can carry one package from your default ship-from address to to_zip, with your price and the retail price, the zone and the estimated delivery. Weight in ounces (2 lb = 32). Parcel, SoftEnvelope and Irregular need length_in and width_in, a box also height_in: size changes the price (cubic and dimensional pricing). Flat rate envelopes and boxes need only the weight. Services that cannot carry the package are left out. Nothing is bought.

One payment to Pirate Ship with its billing address and the labels it paid for. The receipt page of one payment from list_receipts: title, status, total and refunded amount in US dollars, the billing address, the balance before and after, every transaction it covered (labels, refunds, adjustments, with batch_id and shipment_id) and reversals such as chargebacks.

One shipment with tracking, service, cost, recipient and carrier adjustments. The shipment page of a Pirate Ship label: status, carrier and service, zone, tracking number and link, recipient, package, base and total cost with surcharges and insurance in US dollars, estimated delivery, the store order it came from, whether it can be printed or refunded, and carrier adjustments (weight or size the carrier corrected, with the price change and dispute state).

Labels, spend, savings, tracking and where packages went for a date range, as on Reports. Everything the Reports page charts for a date range (default the last 30 days, at most a year): label count, total and average cost (domestic and international), payments, carrier adjustments, savings against retail, pending refunds and returns, tracking states, labels and average cost per day, the carrier split, labels per zone and per US state and country. Money is in US dollars.

Whether recipients get tracking emails by default, how long after purchase, and the template. enabled: new labels send a tracking email to the recipient by default. delay: when it goes out after the label is bought (delay_label as Pirate Ship shows it). branding: Pirate Ship's branding in the email. default_template_id: the template from list_email_templates used.

Takes no parameters.

Hides store orders from the Import list without shipping them. They move to the ignored list (list_import_orders with ignored true); unignore_orders brings them back.

Latest batches and single labels, newest first, with status and tracking counts. The batches on Pirate Ship's Ship page, newest first: drafts (RATED), bought (BILLED) and refunded, each with its shipment count, status text, the first shipment's tracking number and how many shipments are delivered, in transit, ready to print, refunded or failed. page 0 is the newest; an empty list means no more pages. get_batch gives one in full.

Extra charges or credits the carrier made after a label was used, with old and actual package. The Reports, Carrier Adjustments table: when USPS or UPS measured a package differently from the label (weight, size, package type, zone, ZIP), the old and actual values, the old and new cost and the adjustment in US dollars, and whether it was disputed. dispute_adjustment disputes one by shipment_id.

Tracking email templates: subject, sender, HTML body; one is the default. The templates Pirate Ship uses for the tracking emails it sends to recipients of your labels: name, subject, sender name and reply-to email, BCC address and the HTML body with placeholders such as [Tracking #]. default marks the one used for new labels.

Takes no parameters.

Unshipped orders from your connected store integrations, as in the Import grid. Orders imported from connected stores that still need a label: one row per order with the grid's columns (order number, recipient, items, store). ignored true lists the orders you hid with ignore_orders. Run sync_store_orders first for the newest. Use order ids in create_batch_from_orders.

Packaging types per carrier (box, envelope, flat rate) and the size and weight limits. The packaging keys get_rates and saved packages take, per carrier, with which measurements each needs, plus Pirate Ship's limits: maximum weight in ounces and side lengths in inches.

Takes no parameters.

Your scheduled and past USPS and UPS pickups with confirmation numbers. Every carrier pickup on the account: carrier, day and time window, status, confirmation number, package count and weight in ounces, where the driver finds them, the price (USPS is free) and whether it can still be cancelled with cancel_pickup.

Takes no parameters.

Payments made to Pirate Ship, newest first; get_receipt shows one. The Reports, Receipts table: each payment the account made (card, PayPal, bank) with its status, description and total in US dollars. Pass receipt_id to get_receipt for the labels it paid for.

Label refunds with their status and amount, newest request first. The Reports, Refunds table: every label refund the account asked for (or Pirate Ship made automatically for an unused label), when it was requested, approved, declined or reversed, the tracking number, recipient and amount in US dollars. from_date and to_date narrow by the request day.

Pay-on-use return labels and whether a customer used them. The Reports, Return Labels table: every return label made with a shipment, its status (unused labels cost nothing), the address it goes back to and what was charged in US dollars when it was used.

Your Saved Packages from Settings: size, weight and the extra services stored with each. Every Saved Package: packaging type, size in inches, weight in ounces (0 when each label sets its own), signature, insured value, return label setting and flags. default marks the one preselected on new shipments. Use an id in update_saved_package or delete_saved_package.

Takes no parameters.

USPS SCAN Forms per Ship From Address, with their PDF links and labels still without one. For every Ship From Address with USPS labels: how many labels can still go on a SCAN Form (labels_available) and the SCAN Forms already made, each with ship date, label count and PDF link. A SCAN Form lets the carrier scan all packages at once. Make one with create_scan_form.

Takes no parameters.

Your Ship From Addresses with their return addresses; one is the default. Every saved Ship From Address in Pirate Ship: where labels ship from and the return address printed on them (origin_is_return when they are the same). default marks the one new shipments and rate quotes start from. Use an id in update_ship_from_address, delete_ship_from_address or set_default_ship_from_address.

Takes no parameters.

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.

Stores and marketplaces connected to Pirate Ship for order import, with their status. Every connected store (Shopify, Etsy, eBay, WooCommerce, Squarespace and others): its name, platform, whether it is active and still authorised (valid false means reconnect it in Pirate Ship) and whether orders sync on their own. Connecting a store happens in Pirate Ship, not here.

Takes no parameters.

Every charge, payment and refund on the Pirate Ship balance, newest first. The Reports, Transaction History table: each label purchase, payment, refund and carrier adjustment with its amount in US dollars (negative takes from the balance) and the balance after it. from_date and to_date narrow by day, type by the table's transaction types, search works like its search box.

Splits a pasted address into name, street, city, state, ZIP and country. Pirate Ship's Paste Address: free text such as a line copied from an email or an order becomes the fields create_shipment takes. It only parses; the address is checked when the shipment is created.

Changes a batch's title. Sets the title Pirate Ship shows for a batch or single label on the Ship page and in reports.

Past recipients' addresses matching a name, email or phone. The suggestions Pirate Ship's Ship To form shows while typing: addresses of people this account shipped to before, matched by the start of their name (or email or phone). Use one as create_shipment's to.

Makes one Ship From Address the default for new shipments and rate quotes. New shipments, get_rates and pickups start from the default Ship From Address.

Pulls new orders from every connected store into Pirate Ship's Import list. Starts Refresh Data for all connected stores and waits up to wait_seconds for it to finish; running true means it continues in the background. Then list_import_orders shows the orders. With no store connected nothing is imported.

Puts ignored store orders back on the Import list.

Changes a tracking email template; fields you leave out keep their values. Edits the name, subject, sender, BCC address, HTML body or default flag of one template.

Changes label size, file format, packing list, logo, QR codes, address correction or export format. Saves Settings, General for the whole account. Fields you leave out keep their values. Applies to labels made from now on; get_label_settings shows the current values.

Changes a Saved Package; fields you leave out keep their values. Edits one Saved Package: name, packaging, size, weight, signature, insurance, return label and flags. Pirate Ship saves an edit as a new version: the answer carries the new id, use it from then on. default true makes it the preselected package.

Changes a Ship From Address: its name, origin or return address. Edits one saved Ship From Address; fields you leave out keep their values. origin_is_return true sends returns to the origin, return_address sets a separate one. Pirate Ship saves an edit as a new version: the answer carries the new id, use it from then on. Labels already bought keep their address.

Turns default tracking emails on or off and sets their delay after purchase. Changes only what you pass and returns the settings as get_tracking_email_settings does.