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 Business mode) - **Stock Out**: Record items leaving inventory (requires source location for Business mode) - **Adjust Stock**: Correct inventory quantities (use positive or negative quantities) - **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. Automatically detects whether the team uses Basic or Business mode and queries the appropriate endpoint. 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 Mode, other values = Business/Location Mode). 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.