ShipStation

Connect ShipStation by saving your own API V2 key, after checking it actually works. Get it from ShipStation: Account Settings > API Settings > API Keys (V2).

Disconnect ShipStation: deletes the saved API key. Nothing in your ShipStation account is changed.

List the connected ShipStation account(s) and whether the saved key still works.

List carrier accounts connected in ShipStation (e.g. UPS, FedEx, USPS) with balance and account info.

Read one carrier account in full by id.

Read the configurable shipping options a specific carrier supports (e.g. saturday delivery, signature confirmation).

List package types a carrier supports (built-in and custom), e.g. flat rate envelope, box, thick envelope.

Create a custom package type with fixed dimensions for a carrier.

Update an existing custom package type's name or dimensions.

Permanently delete a custom package type.

List warehouses/ship-from locations configured in ShipStation.

Read one warehouse in full by id.

Create a new warehouse/ship-from location.

Update an existing warehouse's name or default flag.

Permanently delete a warehouse.

Validate a shipping address against carrier address-verification data before creating a label with it.

Value-add report: one-glance ShipStation account health snapshot -- carrier count and combined balance, open shipments, pending batches, and recent label activity.

Compare shipping rates across connected carriers for a shipment (rate shopping). Does not create anything or spend money.

Re-fetch rates for an existing shipment (already has addresses/packages saved).

Create a new shipment (addresses + package details). Does not purchase a label yet -- use create_label_from_shipment after.

Update an existing (not-yet-labeled) shipment's carrier/service.

Cancel a shipment that has not been labeled yet.

List shipments in the connected ShipStation account, with status/carrier/ship-to.

Read one shipment in full by id.

Create a new shipment tag (a label you can attach to shipments for organizing/filtering).

List shipment tags defined on this ShipStation account.

Attach a tag to a shipment.

Remove a tag from a shipment.

Look up live tracking status/events for a carrier + tracking number.

Stop tracking a carrier + tracking number pair (unsubscribes from further tracking webhook updates for it).

PURCHASE a shipping label for an existing shipment -- SPENDS REAL CARRIER POSTAGE FUNDS from your ShipStation account balance. ShipStation V2 has no sandbox/test mode: this charges your real account. Void the label immediately after if it was only a test.

PURCHASE a shipping label from a previously fetched rate (calculate_rates) -- SPENDS REAL CARRIER POSTAGE FUNDS. ShipStation V2 has no sandbox/test mode.

PURCHASE a return shipping label linked to a previous outbound label -- SPENDS REAL CARRIER POSTAGE FUNDS. ShipStation V2 has no sandbox/test mode.

List purchased shipping labels, optionally filtered by shipment.

Read one purchased label in full, including its download URL.

Void a purchased label and request a refund of its postage cost from the carrier. Must be done promptly -- most carriers only refund labels voided within a short window (often 24-48h) of purchase.

Create a new batch (a group of shipments to process/label together) in ShipStation, optionally pre-populated with shipment ids.

List batches, optionally filtered by status ('open', 'completed', 'processing').

Read one batch in full -- status, label count, and any errors.

Add shipments to an existing open batch.

Remove shipments from an open batch.

PROCESS a batch -- PURCHASES REAL SHIPPING LABELS for every shipment in it, SPENDING REAL CARRIER POSTAGE FUNDS. ShipStation V2 has no sandbox: this charges your live account for every shipment in the batch.

Permanently delete a batch. Does not void any labels already purchased through it.

Create a customs/carrier manifest -- the end-of-day document some carriers (e.g. USPS SCAN form) require to accept a batch of shipments for pickup. Does not purchase labels; the shipments must already have labels.

List customs/carrier manifests, optionally filtered by warehouse.

Read one manifest in full, including its download URL.

Schedule a carrier pickup at a warehouse -- asks the carrier to send a driver to collect packages. Some carriers may charge a pickup fee; check the carrier's own terms.

List scheduled carrier pickups.

Read one scheduled pickup in full.

Cancel a scheduled carrier pickup.

List products in ShipStation's catalog, optionally filtered by SKU.

Read one catalog product in full.

Create a new product in ShipStation's catalog with a default weight.

Update selected fields of an existing catalog product. Only given fields change.

List the users registered on this ShipStation account.

Subscribe to a ShipStation event (e.g. 'label_created', 'track', 'batch') -- ShipStation will POST to your URL when it fires.

List webhook subscriptions configured on this ShipStation account.

Read one webhook subscription in full.

Permanently remove a webhook subscription. Cannot be undone.