Tools

List Items

Retrieve inventory items from BoxHero. Supports filtering by location and pagination for large inventories. Returns item details including name, SKU, barcode, cost, price, and custom attributes.

List Attributes

Retrieve custom attribute definitions from BoxHero. Attributes are additional metadata fields (e.g., Category, Expiration Date, Safety Stock) that can be attached to items. Supported types include text, number, date, and barcode.

Create Transaction

Create an inventory transaction in BoxHero. Supports all four transaction types: - **Stock In**: Record items entering inventory (requires destination location for Location mode) - **Stock Out**: Record items leaving inventory (uses toLocationId for the stock location; legacy fromLocationId is also accepted) - **Adjust Stock**: Correct inventory quantities (use a relative signed quantity change) - **Move Stock**: Transfer items between locations (requires both source and destination locations) Optionally attach a partner (supplier for Stock In, customer for Stock Out) and a memo.

List Locations

Retrieve all inventory locations (warehouses, stores, stockrooms) from BoxHero. Use location IDs when filtering items or creating transactions.

List Transactions

Retrieve inventory transactions from BoxHero. Requires a team in Location mode. Supports filtering by transaction type (in, out, adjust, move) and pagination.

Get Team

Retrieve the BoxHero team linked to the current API token. Returns the team ID, name, and operating mode (0 = Basic, 1 = Unit, 2 = Location). Useful for determining which transaction endpoints and features are available.

List Partners

Retrieve suppliers and customers from BoxHero. Partners are linked to inventory transactions — suppliers for Stock In and customers for Stock Out. Use partner IDs when creating transactions.

Get Transaction

Retrieve one inventory transaction with full line items and its revision for safe updates or deletion. Call list_transactions to discover transaction IDs.

Get Item

Retrieve one inventory item by ID with custom attributes and per-location stock. Call list_items to discover item IDs.

Manage Item

Create, partially update, or delete an inventory item. Use list_items or get_item to discover and inspect items; list_attributes provides custom attribute IDs. Stock changes after creation use create_transaction.

Manage Transaction

Partially update or delete an inventory transaction. Call get_transaction first and pass its latest revision to detect concurrent edits. Updates may replace all line items; transaction type cannot be changed.