BoxHero MCP by usefulapi is an MCP server published by io.usefulapi, hosted at boxhero.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 23 tools, including boxhero_get_team, boxhero_list_members, boxhero_list_items, boxhero_get_item, boxhero_get_item_by_sku.
Read stock and orders, create or update items, and record stock moves in BoxHero.
4,277 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
The BoxHero team this API token belongs to: id, name, currency (code, symbol, price decimals), memo and mode. The API needs the team in LOCATION mode (mode 2) for items, locations, transactions and orders. GET /teams/linked.
No parameters.
{
"name": "boxhero_get_team",
"title": "Get team",
"description": "The BoxHero team this API token belongs to: id, name, currency (code, symbol, price decimals), memo and mode. The API needs the team in LOCATION mode (mode 2) for items, locations, transactions and orders. GET /teams/linked.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get team",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the active team members (id, name, role admin/member/viewer). Use the ids to filter orders by creator. GET /members.
No parameters.
{
"name": "boxhero_list_members",
"title": "List team members",
"description": "List the active team members (id, name, role admin/member/viewer). Use the ids to filter orders by creator. GET /members.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List team members",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List inventory items with SKU, barcode, cost, price, custom attributes, total quantity and the per-location stock breakdown. Pass location_ids to limit the quantities (and the list) to items with stock at those locations; item_ids to fetch specific items. Cursor-paged by id; pass next_cursor to continue. Low-stock checks: compare quantity with the item's 'Minimum Stock' style attribute. GET /items.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-100 (default 100). |
| cursor | integer | Cursor from the previous reply's next_cursor. Omit on the first call. |
| item_ids | array | Only these item ids. |
| location_ids | array | Scope quantities to these locations and list only items with nonzero stock there. |
{
"name": "boxhero_list_items",
"title": "List items",
"description": "List inventory items with SKU, barcode, cost, price, custom attributes, total quantity and the per-location stock breakdown. Pass location_ids to limit the quantities (and the list) to items with stock at those locations; item_ids to fetch specific items. Cursor-paged by id; pass next_cursor to continue. Low-stock checks: compare quantity with the item's 'Minimum Stock' style attribute. GET /items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100 (default 100)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Cursor from the previous reply's next_cursor. Omit on the first call."
},
"item_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"exclusiveMinimum": 0
},
"maxItems": 100,
"minItems": 1,
"description": "Only these item ids."
},
"location_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Scope quantities to these locations and list only items with nonzero stock there."
}
}
},
"annotations": {
"title": "List items",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One item by id, with its attributes, total quantity and stock per location. GET /items/{item_id}.
| Parameter | Type | Description |
|---|---|---|
| item_id * | integer | BoxHero item id. |
{
"name": "boxhero_get_item",
"title": "Get item",
"description": "One item by id, with its attributes, total quantity and stock per location. GET /items/{item_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"item_id"
],
"properties": {
"item_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero item id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get item",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Look up one item by its SKU (case-insensitive) and return the same payload as boxhero_get_item. GET /items/by-sku/{sku}.
| Parameter | Type | Description |
|---|---|---|
| sku * | string | The item's SKU. |
{
"name": "boxhero_get_item_by_sku",
"title": "Get item by SKU",
"description": "Look up one item by its SKU (case-insensitive) and return the same payload as boxhero_get_item. GET /items/by-sku/{sku}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sku"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The item's SKU."
}
}
},
"annotations": {
"title": "Get item by SKU",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the custom attribute specs defined for items (id, attr_name, attr_type text/date/number/barcode, rank). The ids are used when creating or updating items. File-type attributes are not included. GET /item-attrs.
No parameters.
{
"name": "boxhero_list_item_attributes",
"title": "List item attributes",
"description": "List the custom attribute specs defined for items (id, attr_name, attr_type text/date/number/barcode, rank). The ids are used when creating or updating items. File-type attributes are not included. GET /item-attrs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List item attributes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a new inventory item. Optionally seed initial stock with quantity (and location_id when the team has more than one active location; with one location it is used automatically). Without quantity the item starts at zero everywhere. The SKU must be unique in the team (a random one is generated when omitted). Initial stock is applied in a second step, so on a partial failure the item may exist without stock. POST /items.
| Parameter | Type | Description |
|---|---|---|
| sku | string | SKU, unique in the team. Omit to let BoxHero generate one. |
| cost | string | Decimal string with up to 3 decimal places, e.g. "12.50". |
| name * | string | Item name. |
| attrs | array | Custom attribute values: [{ id, value }]. |
| price | string | Decimal string with up to 3 decimal places, e.g. "12.50". |
| barcode | string | Primary barcode. |
| quantity | number | Initial on-hand quantity to seed (non-zero). |
| photo_url | string | Public URL of a photo. |
| location_id | integer | Location to seed the initial quantity at. |
WRITE: change an item's name, SKU, barcode, photo, cost, price or custom attributes. Only the fields you pass change (an attribute with value null is removed; photo_url '' clears the photo). Stock levels are NOT changed here: use boxhero_record_stock_transaction. PUT /items/{item_id}.
| Parameter | Type | Description |
|---|---|---|
| sku | string | New SKU (unique in the team); an empty value is ignored. |
| cost | string | Decimal string with up to 3 decimal places, e.g. "12.50". |
| name | string | |
| attrs | array | Attribute values to patch: [{ id, value }]. |
| price | string | Decimal string with up to 3 decimal places, e.g. "12.50". |
| barcode | string | |
| item_id * | integer | BoxHero item id. |
| photo_url | string | New photo URL; '' clears it. |
{
"name": "boxhero_update_item",
"title": "Update item",
"description": "WRITE: change an item's name, SKU, barcode, photo, cost, price or custom attributes. Only the fields you pass change (an attribute with value null is removed; photo_url '' clears the photo). Stock levels are NOT changed here: use boxhero_record_stock_transaction. PUT /items/{item_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"item_id"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 255,
"description": "New SKU (unique in the team); an empty value is ignored."
},
"cost": {
"type": "string",
"pattern": "^-?\\d{1,9}(\\.\\d{1,3})?$",
"description": "Decimal string with up to 3 decimal places, e.g. \"12.50\"."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"attrs": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "integer",
"maximum": 2147483647,
"exclusiveMinimum": 0
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
}
]
},
{
"type": "null"
}
],
"description": "New value, or null to remove the attribute value."
}
}
},
"maxItems": 100,
"description": "Attribute values to patch: [{ id, value }]."
},
"price": {
"type": "string",
"pattern": "^-?\\d{1,9}(\\.\\d{1,3})?$",
"description": "Decimal string with up to 3 decimal places, e.g. \"12.50\"."
},
"barcode": {
"type": "string",
"maxLength": 255
},
"item_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero item id.",
"exclusiveMinimum": 0
},
"photo_url": {
"type": "string",
"maxLength": 2048,
"description": "New photo URL; '' clears it."
}
}
},
"annotations": {
"title": "Update item",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List the active storage locations (warehouses, stores...) with id, name, memo and total quantity stored. Location ids are needed for stock transactions. GET /locations.
No parameters.
{
"name": "boxhero_list_locations",
"title": "List locations",
"description": "List the active storage locations (warehouses, stores...) with id, name, memo and total quantity stored. Location ids are needed for stock transactions. GET /locations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List locations",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One location by id. GET /locations/{location_id}.
| Parameter | Type | Description |
|---|---|---|
| location_id * | integer | BoxHero location id. |
{
"name": "boxhero_get_location",
"title": "Get location",
"description": "One location by id. GET /locations/{location_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"location_id"
],
"properties": {
"location_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero location id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get location",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a storage location. The name must be unique in the team; the plan's location limit applies (HTTP 402 when over it). POST /locations.
| Parameter | Type | Description |
|---|---|---|
| memo | string | Free-text memo. |
| name * | string | Location name, unique in the team. |
{
"name": "boxhero_create_location",
"title": "Create location",
"description": "WRITE: create a storage location. The name must be unique in the team; the plan's location limit applies (HTTP 402 when over it). POST /locations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"memo": {
"type": "string",
"maxLength": 2000,
"description": "Free-text memo."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Location name, unique in the team."
}
}
},
"annotations": {
"title": "Create location",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}WRITE: rename a location or change its memo (memo '' clears it). Only the fields you pass change. PUT /locations/{location_id}.
| Parameter | Type | Description |
|---|---|---|
| memo | string | New memo; '' clears it. |
| name | string | New name, unique in the team. |
| location_id * | integer | BoxHero location id. |
{
"name": "boxhero_update_location",
"title": "Update location",
"description": "WRITE: rename a location or change its memo (memo '' clears it). Only the fields you pass change. PUT /locations/{location_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"location_id"
],
"properties": {
"memo": {
"type": "string",
"maxLength": 2000,
"description": "New memo; '' clears it."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New name, unique in the team."
},
"location_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero location id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Update location",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List business partners: suppliers (type 0, used on Stock In) and customers (type 1, used on Stock Out) with contact details. Cursor-paged by id. GET /partners.
| Parameter | Type | Description |
|---|---|---|
| type | any | 0 = suppliers only, 1 = customers only. Omit for both. |
| limit | integer | Page size, 1-100 (default 100). |
| cursor | integer | Cursor from the previous reply's next_cursor. Omit on the first call. |
{
"name": "boxhero_list_partners",
"title": "List partners",
"description": "List business partners: suppliers (type 0, used on Stock In) and customers (type 1, used on Stock Out) with contact details. Cursor-paged by id. GET /partners.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
],
"description": "0 = suppliers only, 1 = customers only. Omit for both."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100 (default 100)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Cursor from the previous reply's next_cursor. Omit on the first call."
}
}
},
"annotations": {
"title": "List partners",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One partner (supplier or customer) by id. GET /partners/{partner_id}.
| Parameter | Type | Description |
|---|---|---|
| partner_id * | integer | BoxHero partner id. |
{
"name": "boxhero_get_partner",
"title": "Get partner",
"description": "One partner (supplier or customer) by id. GET /partners/{partner_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"partner_id"
],
"properties": {
"partner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero partner id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get partner",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: add a supplier (type 0) or customer (type 1) to BoxHero. It only stores contact details; BoxHero does not contact the partner. The plan's partner limit applies (HTTP 402). POST /partners.
| Parameter | Type | Description |
|---|---|---|
| memo | string | |
| name * | string | Partner name. |
| type * | any | 0 = supplier (Stock In), 1 = customer (Stock Out). Cannot be changed later. |
| string | ||
| phone | string | |
| address | string |
{
"name": "boxhero_create_partner",
"title": "Create partner",
"description": "WRITE: add a supplier (type 0) or customer (type 1) to BoxHero. It only stores contact details; BoxHero does not contact the partner. The plan's partner limit applies (HTTP 402). POST /partners.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"name"
],
"properties": {
"memo": {
"type": "string",
"maxLength": 2000
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Partner name."
},
"type": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
],
"description": "0 = supplier (Stock In), 1 = customer (Stock Out). Cannot be changed later."
},
"email": {
"type": "string",
"maxLength": 255
},
"phone": {
"type": "string",
"maxLength": 255
},
"address": {
"type": "string",
"maxLength": 2000
}
}
},
"annotations": {
"title": "Create partner",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}WRITE: change a partner's name or contact details. The name is required by BoxHero (pass the current one to keep it); the other fields change only when passed. A partner's type cannot be changed. PUT /partners/{partner_id}.
| Parameter | Type | Description |
|---|---|---|
| memo | string | |
| name * | string | Partner name (required; pass the current name to keep it). |
| string | ||
| phone | string | |
| address | string | |
| partner_id * | integer | BoxHero partner id. |
{
"name": "boxhero_update_partner",
"title": "Update partner",
"description": "WRITE: change a partner's name or contact details. The name is required by BoxHero (pass the current one to keep it); the other fields change only when passed. A partner's type cannot be changed. PUT /partners/{partner_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"partner_id",
"name"
],
"properties": {
"memo": {
"type": "string",
"maxLength": 2000
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Partner name (required; pass the current name to keep it)."
},
"email": {
"type": "string",
"maxLength": 255
},
"phone": {
"type": "string",
"maxLength": 255
},
"address": {
"type": "string",
"maxLength": 2000
},
"partner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero partner id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Update partner",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List stock transactions (Stock In, Stock Out, Move, Adjust), newest first, as summaries: type, locations, partner, memo, time, creator, item count, total quantity and revision. Use boxhero_get_transaction for the line items and new stock levels. Filter by type. Cursor-paged; pass next_cursor to continue. GET /transactions.
| Parameter | Type | Description |
|---|---|---|
| type | string | in = Stock In, out = Stock Out, move = Move Stock, adjust = Adjust Stock. |
| limit | integer | Page size, 1-100 (default 100). |
| cursor | integer | Cursor from the previous reply's next_cursor. Omit on the first call. |
{
"name": "boxhero_list_transactions",
"title": "List stock transactions",
"description": "List stock transactions (Stock In, Stock Out, Move, Adjust), newest first, as summaries: type, locations, partner, memo, time, creator, item count, total quantity and revision. Use boxhero_get_transaction for the line items and new stock levels. Filter by type. Cursor-paged; pass next_cursor to continue. GET /transactions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"enum": [
"in",
"out",
"move",
"adjust"
],
"type": "string",
"description": "in = Stock In, out = Stock Out, move = Move Stock, adjust = Adjust Stock."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100 (default 100)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Cursor from the previous reply's next_cursor. Omit on the first call."
}
}
},
"annotations": {
"title": "List stock transactions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One stock transaction by id with all its lines; pass revision for an earlier version of it. GET /transactions/{tx_id}.
| Parameter | Type | Description |
|---|---|---|
| revision | integer | A historical revision; omit for the latest. |
| transaction_id * | integer | BoxHero transaction id. |
{
"name": "boxhero_get_transaction",
"title": "Get stock transaction",
"description": "One stock transaction by id with all its lines; pass revision for an earlier version of it. GET /transactions/{tx_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "A historical revision; omit for the latest."
},
"transaction_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero transaction id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get stock transaction",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: record a stock movement that CHANGES stock levels. type 'in' adds stock at to_location_id (optional supplier partner_id), 'out' removes stock at to_location_id (optional customer partner_id; stock may go negative), 'move' transfers from from_location_id to to_location_id, 'adjust' applies a signed RELATIVE correction at to_location_id (quantity 50 adds 50, -3 removes 3; it is not a target level). For in/out/move give each line a positive quantity (the tool applies the sign); for adjust it is signed and non-zero. Each line names an item by item_id or item_sku. to_location_id may be omitted only when the team has exactly one active location. Repeating the call records the movement again. Transactions can be edited or deleted only in the BoxHero app. POST /transactions.
| Parameter | Type | Description |
|---|---|---|
| memo | string | Free-text memo for the transaction. |
| type * | string | in = Stock In, out = Stock Out, move = Move Stock, adjust = Adjust Stock. |
| items * | array | |
| tx_time | string | Effective time, ISO 8601 with timezone, not in the future; defaults to now; not allowed on adjust. |
| partner_id | integer | Supplier (in) or customer (out); not allowed on move or adjust. |
| to_location_id | integer | The location stock arrives at / leaves from / is adjusted at. Optional only with a single location. |
| from_location_id |
List purchase orders (stock you ordered from suppliers), newest first: order number, status, supplier, totals, estimated date. Line items and fulfillment progress come from boxhero_get_purchase_order. Cursor-paged. GET /purchase-orders.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Only orders carrying ALL these tags. |
| limit | integer | Page size, 1-100 (default 100). |
| cursor | integer | Cursor from the previous reply's next_cursor. Omit on the first call. |
| statuses | array | Only orders in these statuses. |
| partner_id | integer | Only orders of this partner. |
| order_number | string | Exact order number. |
| created_by_id | integer | Only orders created by this member id (boxhero_list_members). |
| ordered_after | string | order time >= this (ISO 8601 with timezone). |
| ordered_before | string | order time < this (ISO 8601 with timezone). |
| estimated_after | string |
One purchase order by id with every line (item, price, quantity, tax, discount), additional costs, tags, custom fields and fulfillment progress. GET /purchase-orders/{order_id}.
| Parameter | Type | Description |
|---|---|---|
| order_id * | integer | BoxHero purchase order id. |
{
"name": "boxhero_get_purchase_order",
"title": "Get purchase order",
"description": "One purchase order by id with every line (item, price, quantity, tax, discount), additional costs, tags, custom fields and fulfillment progress. GET /purchase-orders/{order_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero purchase order id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get purchase order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List sales orders (stock you sold to customers), newest first: order number, status, customer, totals, estimated date. Line items, returns and fulfillment progress come from boxhero_get_sales_order. Cursor-paged. GET /sales-orders.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Only orders carrying ALL these tags. |
| limit | integer | Page size, 1-100 (default 100). |
| cursor | integer | Cursor from the previous reply's next_cursor. Omit on the first call. |
| statuses | array | Only orders in these statuses. |
| partner_id | integer | Only orders of this partner. |
| order_number | string | Exact order number. |
| created_by_id | integer | Only orders created by this member id (boxhero_list_members). |
| ordered_after | string | order time >= this (ISO 8601 with timezone). |
| ordered_before | string | order time < this (ISO 8601 with timezone). |
| estimated_after | string | estimated fulfillment >= this. |
One sales order by id with every line (item, price, quantity, returned quantity), additional costs, tags, custom fields and fulfillment progress. GET /sales-orders/{order_id}.
| Parameter | Type | Description |
|---|---|---|
| order_id * | integer | BoxHero sales order id. |
{
"name": "boxhero_get_sales_order",
"title": "Get sales order",
"description": "One sales order by id with every line (item, price, quantity, returned quantity), additional costs, tags, custom fields and fulfillment progress. GET /sales-orders/{order_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "integer",
"maximum": 2147483647,
"description": "BoxHero sales order id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get sales order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Tools for BoxHero, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which items have less than 10 units left in my main warehouse?"; "Show the last 20 stock-out transactions and who the customers were."; "Record a stock-in of 40 units of SKU-1042 at the Berlin location from supplier Acme.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes BoxHero data. Free plan: 50 tool calls per month. Run boxhero_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run boxhero_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run boxhero_upgrade without a plan: it returns both plans, each with a payment link for the user to open. boxhero_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "boxhero_create_item",
"title": "Create item",
"description": "WRITE: create a new inventory item. Optionally seed initial stock with quantity (and location_id when the team has more than one active location; with one location it is used automatically). Without quantity the item starts at zero everywhere. The SKU must be unique in the team (a random one is generated when omitted). Initial stock is applied in a second step, so on a partial failure the item may exist without stock. POST /items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 255,
"description": "SKU, unique in the team. Omit to let BoxHero generate one."
},
"cost": {
"type": "string",
"pattern": "^-?\\d{1,9}(\\.\\d{1,3})?$",
"description": "Decimal string with up to 3 decimal places, e.g. \"12.50\"."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Item name."
},
"attrs": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "integer",
"maximum": 2147483647,
"description": "Attribute spec id (boxhero_list_item_attributes).",
"exclusiveMinimum": 0
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
}
],
"description": "Value: text/barcode as a string, date as YYYY-MM-DD, number as a number."
}
}
},
"maxItems": 100,
"description": "Custom attribute values: [{ id, value }]."
},
"price": {
"type": "string",
"pattern": "^-?\\d{1,9}(\\.\\d{1,3})?$",
"description": "Decimal string with up to 3 decimal places, e.g. \"12.50\"."
},
"barcode": {
"type": "string",
"maxLength": 255,
"description": "Primary barcode."
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"minimum": -1000000000,
"description": "Initial on-hand quantity to seed (non-zero)."
},
"photo_url": {
"type": "string",
"maxLength": 2048,
"description": "Public URL of a photo."
},
"location_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Location to seed the initial quantity at.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Create item",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}| integer |
| Source location (move only). |
{
"name": "boxhero_record_stock_transaction",
"title": "Record stock transaction",
"description": "WRITE: record a stock movement that CHANGES stock levels. type 'in' adds stock at to_location_id (optional supplier partner_id), 'out' removes stock at to_location_id (optional customer partner_id; stock may go negative), 'move' transfers from from_location_id to to_location_id, 'adjust' applies a signed RELATIVE correction at to_location_id (quantity 50 adds 50, -3 removes 3; it is not a target level). For in/out/move give each line a positive quantity (the tool applies the sign); for adjust it is signed and non-zero. Each line names an item by item_id or item_sku. to_location_id may be omitted only when the team has exactly one active location. Repeating the call records the movement again. Transactions can be edited or deleted only in the BoxHero app. POST /transactions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"items"
],
"properties": {
"memo": {
"type": "string",
"maxLength": 2000,
"description": "Free-text memo for the transaction."
},
"type": {
"enum": [
"in",
"out",
"move",
"adjust"
],
"type": "string",
"description": "in = Stock In, out = Stock Out, move = Move Stock, adjust = Adjust Stock."
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity"
],
"properties": {
"item_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Item id (or use item_sku).",
"exclusiveMinimum": 0
},
"item_sku": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Item SKU, case-insensitive (or use item_id)."
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"minimum": -1000000000,
"description": "Positive amount for in/out/move; signed non-zero for adjust."
}
}
},
"maxItems": 100,
"minItems": 1
},
"tx_time": {
"type": "string",
"description": "Effective time, ISO 8601 with timezone, not in the future; defaults to now; not allowed on adjust."
},
"partner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Supplier (in) or customer (out); not allowed on move or adjust.",
"exclusiveMinimum": 0
},
"to_location_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The location stock arrives at / leaves from / is adjusted at. Optional only with a single location.",
"exclusiveMinimum": 0
},
"from_location_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Source location (move only).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Record stock transaction",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}| estimated fulfillment >= this. |
| estimated_before | string | estimated fulfillment < this. |
{
"name": "boxhero_list_purchase_orders",
"title": "List purchase orders",
"description": "List purchase orders (stock you ordered from suppliers), newest first: order number, status, supplier, totals, estimated date. Line items and fulfillment progress come from boxhero_get_purchase_order. Cursor-paged. GET /purchase-orders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Only orders carrying ALL these tags."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100 (default 100)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Cursor from the previous reply's next_cursor. Omit on the first call."
},
"statuses": {
"type": "array",
"items": {
"enum": [
"draft",
"confirmed",
"in-progress",
"done"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Only orders in these statuses."
},
"partner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only orders of this partner.",
"exclusiveMinimum": 0
},
"order_number": {
"type": "string",
"maxLength": 100,
"description": "Exact order number."
},
"created_by_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only orders created by this member id (boxhero_list_members).",
"exclusiveMinimum": 0
},
"ordered_after": {
"type": "string",
"description": "order time >= this (ISO 8601 with timezone)."
},
"ordered_before": {
"type": "string",
"description": "order time < this (ISO 8601 with timezone)."
},
"estimated_after": {
"type": "string",
"description": "estimated fulfillment >= this."
},
"estimated_before": {
"type": "string",
"description": "estimated fulfillment < this."
}
}
},
"annotations": {
"title": "List purchase orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}| estimated_before | string | estimated fulfillment < this. |
{
"name": "boxhero_list_sales_orders",
"title": "List sales orders",
"description": "List sales orders (stock you sold to customers), newest first: order number, status, customer, totals, estimated date. Line items, returns and fulfillment progress come from boxhero_get_sales_order. Cursor-paged. GET /sales-orders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Only orders carrying ALL these tags."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100 (default 100)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Cursor from the previous reply's next_cursor. Omit on the first call."
},
"statuses": {
"type": "array",
"items": {
"enum": [
"draft",
"confirmed",
"in-progress",
"done"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Only orders in these statuses."
},
"partner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only orders of this partner.",
"exclusiveMinimum": 0
},
"order_number": {
"type": "string",
"maxLength": 100,
"description": "Exact order number."
},
"created_by_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only orders created by this member id (boxhero_list_members).",
"exclusiveMinimum": 0
},
"ordered_after": {
"type": "string",
"description": "order time >= this (ISO 8601 with timezone)."
},
"ordered_before": {
"type": "string",
"description": "order time < this (ISO 8601 with timezone)."
},
"estimated_after": {
"type": "string",
"description": "estimated fulfillment >= this."
},
"estimated_before": {
"type": "string",
"description": "estimated fulfillment < this."
}
}
},
"annotations": {
"title": "List sales orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}