Starshipit API Documentation
This is the complete API documentation for connecting to the Starshipit 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 Starshipit: Manage shipping orders, labels, tracking, rates, and manifests. Keep reading to get started.
Quickstart
Before you run your first Starshipit 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 Starshipit connection — create or choose one in Connections. Note its
connectionId.
Every Starshipit action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/starshipit/latest/actions/{actionSlug}You need a MindCloud API Key and a Starshipit connection. Then call an action such as Delivery Services:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/starshipit/latest/actions/delivery-services" \
--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.
Authentication
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 Starshipit account that should run the action. MindCloud stores and refreshes the Starshipit 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. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Starshipit actions
All 40 published actions for this Starshipit version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Address
- POSTAdd Product
- PUTArchive Order
- PUTAssign Orders
- PUTBatch Update Orders
- POSTClone Shipment
- POSTCreate Order
- POSTCreate Orders
- POSTCreate Tracking Only Order
- DELETEDelete Address
- DELETEDelete Order
- DELETEDelete Product or All Products
- GETDelivery Services
- GETGet Order(s)
- GETGet Rates
- GETGet Tracking Details
- GETList Filtered Addresses
- GETList Manifest Files
- GETList Manifests
- GETList Orders (Delivered)
- GETList Orders (Printed or Unmanifested)
- GETList Orders (Shipped)
- GETList Orders (Unshipped)
- GETList Orders Summary
- GETList Suggested Merges
- PUTManifest by Carrier
- PUTManifest Orders (Orders)
- PUTManifest Orders (Shipments)
- PUTMerge Orders
- POSTPrint Label
- POSTPrint Labels
- PUTPrint Packing Slips
- PUTReplace Shipment
- PUTRestore Order
- GETSearch Orders
- GETSearch Products
- PUTUpdate Address
- PUTUpdate Order
- PUTUpdate Orders
- PUTUpdate Product
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.