NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Boxhero connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Boxhero actions, such as "Get Item", "Get Item Attribute" and "Get Location". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Boxhero, with input parameters and output schema.
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
The ID of the item to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The ID of the location to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The id of the item to be queried
The ids of the locations to be used for quantity calculation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the item attribute to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The id of the location to be queried
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOXHERO_GET_MEMBERTool to retrieve a specific team member by ID. Use when you need to get details about a particular member.
Input parameters
Unique identifier of the team member to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOXHERO_LIST_BASIC_TRANSACTIONSTool to list basic inventory transactions. Use when you need a high-level overview of in/out/move transactions.
Input parameters
Maximum number of transactions to return per request (default 100)
Cursor token for fetching the next page of results
Filter transactions by location ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOXHERO_LIST_ITEMSTool to list items. Use when fetching products with optional location filters and pagination.
Input parameters
Maximum number of items to return in one page.
Cursor token for fetching the next page of results.
Filter items by one or more location IDs. Repeatable parameter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOXHERO_LIST_LOCATIONSTool to list warehouse locations. Use when you need valid warehouse_id values for filtering transactions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Transaction type enum for filtering location transactions.
Maximum number of items to return in a single request (default 100, max 100)
Cursor pointing to a specific spot in the items, allowing clients to request the next set of items
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOXHERO_LIST_PARTNERSTool to list partners (suppliers and customers). Use when retrieving partner information with optional type filtering and pagination.
Input parameters
Partner type enumeration.
The maximum number of items to be returned in a single request (default 100)
Points to a specific spot in the items, allowing clients to request the next set of items
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 14 Boxhero actions on Nagent, including "Get Item", "Get Item Attribute" and "Get Location". Get Item: Retrieve a specific item (barcode) by ID. Each action is listed on this page with its input parameters and its output.
Boxhero connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Item takes 1 required input: item_id. It also takes 1 optional input: location_ids. It returns data, error and successful.