ShipStation (v2) API Documentation
This is the complete API documentation for connecting to the ShipStation (v2) API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet ShipStation (v2): Manage shipments, labels, rates, and warehouses in ShipStation. Keep reading to get started.
Quickstart
Before you run your first ShipStation (v2) request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one ShipStation (v2) connection — create or choose one in Connections. Note its
connectionId.
Every ShipStation (v2) action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/shipStationV2/actions/{actionSlug}/runYou need a MindCloud API Key and a ShipStation (v2) connection. Then call an action such as List Carriers:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/shipStationV2/actions/list-carriers/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your ShipStation (v2) account. See ShipStation (v2) API Authentication for the full flow and how to get your connection credentials.
ShipStation (v2) actions
All 26 published actions for this ShipStation (v2) version. Each page documents the endpoint, arguments, and response controls.
- PUTCancel Shipment
- POSTCreate Shipments
- POSTCreate Tag
- POSTCreate Webhook
- DELETEDelete webhook by id
- GETGet Carrier by ID
- GETGet Shipment by External ID
- GETGet Shipment by ID
- GETGet Shipment Rates
- GETGet Tags
- GETGet tracking information
- GETGet Warehouse by ID
- GETGet Webhook by ID
- GETList Carrier Services
- GETList Carriers
- GETList Inventory Locations
- GETList Inventory Warehouses
- GETList Labels
- GETList Shipments
- GETList SKU Inventory Levels
- GETList Warehouses
- GETList Webhooks
- PUTStart tracking a package
- PUTStop tracking a package
- PUTUpdate SKU Stock Levels
- PUTUpdate Webhook
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.