Order Desk API Documentation

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

Quickstart

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

Every Order Desk action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/orderDesk/actions/{actionSlug}/run

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

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/orderDesk/actions/get-store-settings/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 Order Desk account. See Order Desk API Authentication for the full flow and how to get your connection credentials.

Order Desk actions

All 18 published actions for this Order Desk version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Inventory Item
• POSTCreate Multiple Shipments
• POSTCreate Order
• POSTCreate Shipment
• DELETEDelete Inventory Item
• DELETEDelete Shipment
• GETGet Inventory Item
• GETGet Order
• GETGet Order Item
• GETGet Shipment
• GETGet Store Settings
• GETList Inventory Items
• GETList Order Items
• GETList Orders
• GETList Shipments
• PUTUpdate Inventory Item
• PUTUpdate Multiple Inventory Items
• PUTUpdate Shipment

Related apps

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

StripeShopifySquareXeroThinkificWhopGumroadEcwid