BoxHero API Documentation
This is the complete API documentation for connecting to the BoxHero 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 BoxHero: Track inventory, manage stock, and organize items, partners, and locations. Keep reading to get started.
Quickstart
Before you run your first BoxHero 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 BoxHero connection — create or choose one in Connections. Note its
connectionId.
Every BoxHero action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/boxHero/actions/{actionSlug}/runYou need a MindCloud API Key and a BoxHero connection. Then call an action such as Get Linked Team:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/boxHero/actions/get-linked-team/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 BoxHero account. See BoxHero API Authentication for the full flow and how to get your connection credentials.
BoxHero actions
All 24 published actions for this BoxHero version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Item
- POSTCreate Item Attribute
- POSTCreate Location
- POSTCreate Location Transaction
- POSTCreate Partner
- DELETEDelete Item
- GETGet Item
- GETGet Item Attribute
- GETGet Linked Team
- GETGet Location
- GETGet Location Transaction
- GETGet Member
- GETGet Partner
- GETList Item Attributes
- GETList Items
- GETList Location Transactions
- GETList Locations
- GETList Members
- GETList Partners
- PUTUpdate Item
- PUTUpdate Item Attribute
- PUTUpdate Location
- PUTUpdate Location Transaction
- PUTUpdate Partner
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.