ShipStation API Documentation

This is the complete API documentation for connecting to the ShipStation 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: connect business data and workflows through MindCloud's Universal API. Keep reading to get started.

Quickstart

Before you run your first ShipStation request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ShipStation connection — create or choose one in Connections. Note its connectionId.

Every ShipStation action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/shipstation/latest/actions/{actionSlug}

You need a MindCloud API Key and a ShipStation connection. Then call an action such as List Shipments:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/shipstation/latest/actions/list-shipments" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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 account. See ShipStation API Authentication for the full flow and how to get your connection credentials.

ShipStation actions

All 22 published actions for this ShipStation version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Label for Order
• POSTCreate Or Update Orders
• POSTCreate Or Update Orders (v2)
• POSTCreate Shipping Label for Order
• GETGet Carrier by ID
• GETGet Fulfillments
• GETGet Order by ID
• GETGet Packages by Carrier
• GETGet Services by Carrier
• GETGet Store by ID
• GETList Carrier Services
• GETList Carriers
• GETList Customers
• GETList Orders
• GETList Orders (v2)
• GETList Products
• GETList Shipments
• GETList Stores
• GETList Tags
• POSTMark an Order as Shipped
• DELETERemove Tag (v2)
• PUTUpdate Product

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp