ReadyCloud Suite API Documentation
This is the complete API documentation for connecting to the ReadyCloud Suite 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 ReadyCloud Suite: ReadyCloud Suite is a multichannel order and shipping operations platform with APIs for organizations, orders, boxes, tracking, items, notes, packaging, products, contacts, insurance, wallet subaccounts, events, and webhooks. Keep reading to get started.
Quickstart
Before you run your first ReadyCloud Suite 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 ReadyCloud Suite connection — create or choose one in Connections. Note its
connectionId.
Every ReadyCloud Suite action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/readyCloudSuite/actions/{actionSlug}/runYou need a MindCloud API Key and a ReadyCloud Suite connection. Then call an action such as List Organizations:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/readyCloudSuite/actions/list-organizations/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 ReadyCloud Suite account. See ReadyCloud Suite API Authentication for the full flow and how to get your connection credentials.
ReadyCloud Suite actions
All 31 published actions for this ReadyCloud Suite version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Box
- POSTCreate Contact
- POSTCreate Item
- POSTCreate Note
- POSTCreate Order
- POSTCreate Packaging
- POSTCreate Product
- GETGet Box
- GETGet Contact
- GETGet Item
- GETGet Note
- GETGet Order
- GETGet Packaging
- GETGet Product
- GETGet Tracking Detail
- GETList Boxes
- GETList Contacts
- GETList Items
- GETList Notes
- GETList Orders
- GETList Organizations
- GETList Packaging
- GETList Products
- GETList Tracking
- PUTUpdate Box
- PUTUpdate Contact
- PUTUpdate Item
- PUTUpdate Note
- PUTUpdate Order
- PUTUpdate Packaging
- PUTUpdate Product
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.