ShipStation (v2) API Authentication

How to authenticate ShipStation (v2) API requests: one Bearer API key plus a connectionId. MindCloud handles ShipStation (v2)'s custom auth scheme for you.

Every ShipStation (v2) API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your ShipStation (v2) account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a ShipStation (v2) connection in Connections. ShipStation (v2) uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected ShipStation (v2) account that should run the action. MindCloud stores and refreshes the ShipStation (v2) credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Carriers with an ShipStation (v2) connection looks like this:

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": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which ShipStation (v2) account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your ShipStation API key

Use a ShipStation account with Shipping API access. ShipStation API keys give full account access and are only shown when generated, so copy the key into a secure credential manager right away.

Open your ShipStation settings
Log in to your ShipStation account and open Settings.
Confirm API access is enabled
Open Settings > Account > API Settings. If API Settings is not available, open Settings > Add-Ons first and enable the Shipping API add-on for your account.
Settings → Account → API Settings
Generate and copy the API key
On Settings > Account > API Settings, generate the API key and copy it immediately. ShipStation only shows the key when it is generated.
Settings → Account → API Settings
Paste the key into MindCloud
Paste the copied API key into the MindCloud ShipStation connection field.
Run the connection test
Test the connection to confirm the key can authenticate against the ShipStation V2 API.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.