Shipcloud API Documentation
This is the complete API documentation for connecting to the Shipcloud 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 Shipcloud: Create shipments, manifests, pickup requests, trackers, addresses, orders, shipment documents, and webhooks in Shipcloud. Keep reading to get started.
Quickstart
Before you run your first Shipcloud 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 Shipcloud connection — create or choose one in Connections. Note its
connectionId.
Every Shipcloud action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/shipcloud/actions/{actionSlug}/runYou need a MindCloud API Key and a Shipcloud connection. Then call an action such as Get Current User:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/shipcloud/actions/get-current-user/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 Shipcloud account. See Shipcloud API Authentication for the full flow and how to get your connection credentials.
Shipcloud actions
All 33 published actions for this Shipcloud version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Address
- POSTCreate Manifest
- POSTCreate Order
- POSTCreate Pickup Request
- POSTCreate Shipment
- POSTCreate Shipment Document
- POSTCreate Shipment Quote
- POSTCreate Tracker
- POSTCreate Webhook
- DELETEDelete Shipment
- DELETEDelete Webhook
- GETGet Address
- GETGet Current User
- GETGet Default Returns Address
- GETGet Default Shipping Address
- GETGet Invoice Address
- GETGet Manifest
- GETGet Order
- GETGet Pickup Request
- GETGet Shipment
- GETGet Shipment Document
- GETGet Tracker
- GETGet Webhook
- GETList Addresses
- GETList Carriers
- GETList Orders
- GETList Pickup Requests
- GETList Shipment Documents
- GETList Shipments
- GETList Trackers
- GETList Webhooks
- GETSearch Pickup Dropoff Locations
- PUTUpdate Shipment
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.