TrackMage API Documentation

This is the complete API documentation for connecting to the TrackMage 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 TrackMage: TrackMage helps teams manage workspaces, orders, shipments, shipment items, products, product variants, and workflows through a REST API delivered as JSON and LD+JSON over HTTPS. Keep reading to get started.

Quickstart

Before you run your first TrackMage 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 TrackMage connection — create or choose one in Connections. Note its connectionId.

Every TrackMage action uses the same URL pattern:

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

You need a MindCloud API Key and a TrackMage connection. Then call an action such as Get Order:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/trackMage/latest/actions/get-order" \
  --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 TrackMage account that should run the action. MindCloud stores and refreshes the TrackMage 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.

TrackMage actions

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

• POSTCreate Order
• POSTCreate Product
• POSTCreate Product Variant
• POSTCreate Shipment
• POSTCreate Shipment Item
• POSTCreate Workflow
• POSTCreate Workspace
• DELETEDelete Order
• DELETEDelete Product
• DELETEDelete Product Variant
• DELETEDelete Shipment
• DELETEDelete Shipment Item
• DELETEDelete Workspace
• PUTExecute Workflow
• GETGet Order
• GETGet Product
• GETGet Product Variant
• GETGet Shipment
• GETGet Shipment Item
• GETGet Workflow
• GETGet Workspace
• GETList Order Items For Order
• GETList Orders
• GETList Product Variants
• GETList Products
• GETList Shipment Checkpoints
• GETList Shipment Items
• GETList Shipment Items For Shipment
• GETList Shipments
• GETList Workflows
• GETList Workspaces
• GETLookup Order
• GETLookup Shipment
• PUTMerge Shipments
• PUTUpdate Order
• PUTUpdate Product
• PUTUpdate Product Variant
• PUTUpdate Shipment
• PUTUpdate Shipment Item
• PUTUpdate Workspace

Related apps

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

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad