BaseLinker API Documentation

This is the complete API documentation for connecting to the BaseLinker 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 BaseLinker: Manage orders, inventory, shipments, and ecommerce operations. Keep reading to get started.

Quickstart

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

Every BaseLinker action uses the same URL pattern:

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

You need a MindCloud API Key and a BaseLinker connection. Then call an action such as Get Courier Accounts:

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

BaseLinker actions

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

• POSTAdd Order Product
• POSTCreate Package
• DELETEDelete Order Product
• GETGet Courier Accounts
• GETGet Couriers List
• GETGet Inventories
• GETGet Inventory Products Data
• GETGet Inventory Products List
• GETGet Inventory Products Prices
• GETGet Inventory Products Stock
• GETGet Inventory Warehouses
• GETGet Order Packages
• GETGet Order Payments History
• GETGet Order Sources
• GETGet Order Statuses
• GETGet Orders
• GETGet Orders by Email
• PUTSet Order Fields
• PUTSet Order Payment
• PUTSet Order Product Fields
• PUTSet Order Status
• PUTSet Order Statuses
• PUTUpdate Inventory Products Prices
• PUTUpdate Inventory Products Stock

Related apps

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

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad