Skip to main content
Boxhero logo
  • Category: product management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: BOXHERO
  • Version: 20260615_00

Tools

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

Input Parameters

integer
required
The ID of the item to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_DELETE_LOCATIONTool to delete a specific warehouse location by its ID. Use when you need to remove a location from the system.

Input Parameters

integer
required
The ID of the location to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_GET_ITEMTool 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

integer
required
The id of the item to be queried
array
The ids of the locations to be used for quantity calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_GET_ITEM_ATTRIBUTETool to retrieve a specific item attribute by ID. Use when you need to get detailed information about an item attribute specification.

Input Parameters

integer
required
The unique identifier of the item attribute to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_GET_LOCATIONTool 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

integer
required
The id of the location to be queried

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_GET_MEMBERTool to retrieve a specific team member by ID. Use when you need to get details about a particular member.

Input Parameters

integer
required
Unique identifier of the team member to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_GET_TEAM_INFOTool to get information about the linked team and its mode. Use when you need to retrieve the currently linked team details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_BASIC_TRANSACTIONSTool to list basic inventory transactions. Use when you need a high-level overview of in/out/move transactions.

Input Parameters

integer
Maximum number of transactions to return per request (default 100)
string
Cursor token for fetching the next page of results
integer
Filter transactions by location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_ITEM_ATTRIBUTESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_ITEMSTool to list items. Use when fetching products with optional location filters and pagination.

Input Parameters

integer
Maximum number of items to return in one page.
string
Cursor token for fetching the next page of results.
array
Filter items by one or more location IDs. Repeatable parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_LOCATIONSTool to list warehouse locations. Use when you need valid warehouse_id values for filtering transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_LOCATION_TRANSACTIONSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_MEMBERSTool to retrieve the list of team members. Use when you need to get all members in the team with their roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOXHERO_LIST_PARTNERSTool to list partners (suppliers and customers). Use when retrieving partner information with optional type filtering and pagination.

Input Parameters

string ("supplier" | "customer")
Partner type enumeration.
integer
The maximum number of items to be returned in a single request (default 100)
integer
Points to a specific spot in the items, allowing clients to request the next set of items

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not