# Boxhero

BoxHero is a cloud-based inventory management solution designed for small to medium-sized businesses, offering real-time updates, barcode scanning, team collaboration, and analytics.

- **Category:** product management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `BOXHERO`
- **Version:** 20260217_00

## Tools

### Delete Item

**Slug:** `BOXHERO_DELETE_ITEM`

Tool to delete a specific item (barcode) by its ID. Use when you need to remove an item from the inventory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | The ID of the item to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BoxHero - Delete Location

**Slug:** `BOXHERO_DELETE_LOCATION`

Tool to delete a specific warehouse location by its ID. Use when you need to remove a location from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | integer | Yes | The ID of the location to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item

**Slug:** `BOXHERO_GET_ITEM`

Tool to retrieve a specific item (barcode) by ID. Use when you need detailed information about a single item including its attributes, pricing, and inventory quantities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | The id of the item to be queried |
| `location_ids` | array | No | The ids of the locations to be used for quantity calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item Attribute

**Slug:** `BOXHERO_GET_ITEM_ATTRIBUTE`

Tool to retrieve a specific item attribute by ID. Use when you need to get detailed information about an item attribute specification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attr_id` | integer | Yes | The unique identifier of the item attribute to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location

**Slug:** `BOXHERO_GET_LOCATION`

Tool to retrieve a specific location by ID. Use when you need detailed information about a particular warehouse location including its name, quantity, and notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | integer | Yes | The id of the location to be queried |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Member

**Slug:** `BOXHERO_GET_MEMBER`

Tool to retrieve a specific team member by ID. Use when you need to get details about a particular member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member_id` | integer | Yes | Unique identifier of the team member to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Team Info

**Slug:** `BOXHERO_GET_TEAM_INFO`

Tool to get information about the linked team and its mode. Use when you need to retrieve the currently linked team details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BoxHero - List Basic Transactions

**Slug:** `BOXHERO_LIST_BASIC_TRANSACTIONS`

Tool to list basic inventory transactions. Use when you need a high-level overview of in/out/move transactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of transactions to return per request (default 100) |
| `cursor` | string | No | Cursor token for fetching the next page of results |
| `location_id` | integer | No | Filter transactions by location ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Attributes

**Slug:** `BOXHERO_LIST_ITEM_ATTRIBUTES`

Tool to retrieve the list of item attribute specifications used within the team. Use when you need to understand what custom attributes are defined for items.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `BOXHERO_LIST_ITEMS`

Tool to list items. Use when fetching products with optional location filters and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items to return in one page. |
| `cursor` | string | No | Cursor token for fetching the next page of results. |
| `location_ids` | array | No | Filter items by one or more location IDs. Repeatable parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BoxHero - List Locations

**Slug:** `BOXHERO_LIST_LOCATIONS`

Tool to list warehouse locations. Use when you need valid warehouse_id values for filtering transactions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BoxHero - List Location Transactions

**Slug:** `BOXHERO_LIST_LOCATION_TRANSACTIONS`

Tool to retrieve the list of transactions in location mode. Use when you need to fetch transaction history with location-based details including in/out/move/adjust operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("in" | "out" | "move" | "adjust") | No | Transaction type enum for filtering location transactions. |
| `limit` | integer | No | Maximum number of items to return in a single request (default 100, max 100) |
| `cursor` | integer | No | Cursor pointing to a specific spot in the items, allowing clients to request the next set of items |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Members

**Slug:** `BOXHERO_LIST_MEMBERS`

Tool to retrieve the list of team members. Use when you need to get all members in the team with their roles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BoxHero - List Partners

**Slug:** `BOXHERO_LIST_PARTNERS`

Tool to list partners (suppliers and customers). Use when retrieving partner information with optional type filtering and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("supplier" | "customer") | No | Partner type enumeration. |
| `limit` | integer | No | The maximum number of items to be returned in a single request (default 100) |
| `cursor` | integer | No | Points to a specific spot in the items, allowing clients to request the next set of items |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |