ShipStation

ShipStation API v2

This connector talks to ShipStation API v2 at https://api.shipstation.com/v2. ShipStation offers two APIs: the legacy V1 API (ssapi.shipstation.com, Basic auth with an API key and secret) and API v2. The V1 API is marked deprecated in ShipStation's documentation and will be removed; new accounts generate a V2 key on the API Settings page, and ShipStation API (formerly ShipEngine) keys work on v2 too. This connector therefore uses v2 only.

Setup

1. In ShipStation open Settings → Account → API Settings (https://ship.shipstation.com/#/settings/api). Your plan must include API access.
2. Click Generate API Key under the V2 section and copy the key; it is shown only once. One V2 key can be active at a time; generating a new one revokes the old one.
3. Paste it into SHIPSTATION_API_KEY. It is sent in the API-Key header. ShipStation API (formerly ShipEngine) customers use the key from https://api-portal.shipstation.com/; keys starting with TEST_ reach the sandbox.

Orders are shipments in v2

What the ShipStation web app calls an order is a shipment in API v2, and what the web app calls a shipment is a label. v1 orderId 12345678 is v2 shipment_id se-12345678; v1 orderKey is v2 external_shipment_id; the order number is shipment_number. Status: pending covers awaiting payment, awaiting shipment and on hold; label_purchased means shipped. All v2 ids start with se-.

Stores

API v2 has no endpoint that lists stores. Every shipment carries the store_id of the store (order source) it came from; filter shipstation_list_shipments by store_id and shipstation_list_fulfillments by order_source_id.

Start here

• shipstation_list_carriers first: carrier ids (se-...) are needed for rates, labels and services.
• shipstation_list_shipments with shipment_status=pending lists the orders still to ship; add created_at_start or modified_at_start (ISO 8601, e.g. 2026-10-01T00:00:00Z) to keep the list small.
• shipstation_calculate_rates compares carrier prices for one shipment; shipstation_estimate_rates quotes from postal codes and weight alone.
• shipstation_list_warehouses gives the ship-from locations (warehouse_id).

Pagination

List tools take page (from 1) and page_size; answers carry total, page and pages. Keep fetching while page is lower than pages.

Rate limits

200 requests per minute per account by default. A 429 carries a Retry-After header with the seconds to wait. Carrier errors carry error_source carrier rather than shipstation.

Writes cost money

The label tools (shipstation_create_label_from_shipment, shipstation_create_label_from_rate, shipstation_void_label) are installed switched off. ShipStation platform accounts have no sandbox, so a purchased label is charged to the carrier account; void unused labels promptly. Rate quotes and address validation change nothing.