Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to BoxHero

Scalekit connector
Open markdown

The BoxHero connector lets your AI agent act in each user's BoxHero account. Each user connects their own BoxHero access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
23 · 28 · 923 read28 write9 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the BoxHero connection

    In AgentKit > Connections, create a BoxHero connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'boxhero'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize BoxHero:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'boxhero_bundles_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their BoxHero credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • boxhero_bundle_getGet one bundle.Read-only

    Get Bundle

    Get one bundle. Returns its name, SKU, barcode, photo, cost, price and components. Use bundles_list to find bundle IDs.

    Inputs

    bundle_idintegerrequired
    Bundle ID. Maximum 2147483647. Example: 501.
  • boxhero_bundles_listList bundles (fixed groups of items sold or bought together), with cursor paging.Read-only

    List Bundles

    List bundles (fixed groups of items sold or bought together), with cursor paging. Returns each bundle's id, name, SKU, cost, price and components. Use bundle_get for one bundle.

    Inputs

    bundle_idsarray
    Filter the list to specific bundle ids. Pass repeatedly (?bundle_ids=1&bundle_ids=2) or as a single value. Example: [501]
    cursorinteger
    Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call. Maximum 2147483647. Example: 0.
    limitinteger
    Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
  • boxhero_item_attr_getGet one custom item attribute spec.Read-only

    Get Item Attribute

    Get one custom item attribute spec. Returns its id, name, type and rank. Use item_attrs_list to find spec IDs.

    Inputs

    attr_idintegerrequired
    Attr ID. Maximum 2147483647. Example: 12.
  • boxhero_item_attrs_listList the team's custom item attribute specs, ordered by rank.Read-only

    List Item Attributes

    List the team's custom item attribute specs, ordered by rank. Returns each spec's id, name, type (text, date, number or barcode) and rank. Use spec IDs in an item's attrs.

    Inputs

    This tool takes no inputs.

  • boxhero_item_getGet one item by ID.Read-only

    Get Item

    Get one item by ID. Returns its name, SKU, barcode, photo, cost, price, custom attributes and quantities per location. Use item_get_by_sku when you only know the SKU.

    Inputs

    item_idintegerrequired
    Item ID. Maximum 2147483647. Example: 1001.
    location_idsarray
    Scope the quantities breakdown (and the quantity total) to specific locations. Only requested locations with nonzero stock appear in quantities. When omitted, quantities covers every active location where the item has nonzero stock. Example: [3]
  • boxhero_item_get_by_skuLook up one item by SKU (case-insensitive).Read-only

    Get Item by SKU

    Look up one item by SKU (case-insensitive). Returns the same item details as item_get. Use items_list to browse items.

    Inputs

    skustringrequired
    Item SKU (case-insensitive). URL-encode special characters such as #, %, /, or spaces (e.g. SKU%2FABC for SKU/ABC). Example: TEA-GREEN-100G.
    location_idsarray
    Scope the quantities breakdown (and the quantity total) to specific locations. Only requested locations with nonzero stock appear in quantities. When omitted, quantities covers every active location where the item has nonzero stock. Example: [3]
  • boxhero_items_listList items with their stock, with cursor paging and optional item or location filters.Read-only

    List Items

    List items with their stock, with cursor paging and optional item or location filters. Returns each item's id, name, SKU, barcode, cost, price, custom attributes, total quantity and per-location quantities, plus cursor and has_more. Use item_get_by_sku to look up one item by SKU.

    Inputs

    cursorinteger
    Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call. Maximum 2147483647. Example: 0.
    item_idsarray
    Filter the list to specific item ids. Pass repeatedly (?item_ids=1&item_ids=2) or as a single value. Example: [1001, 1002]
    limitinteger
    Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
    location_idsarray
    Scope the quantities breakdown (and the quantity total) to specific locations, and filter the list to items with nonzero stock at those locations. When omitted, all items are listed and quantities covers every active location where the item has nonzero stock. Example: [3]
  • boxhero_location_getGet one location.Read-only

    Get Location

    Get one location. Returns its id, name, memo and total quantity. Use locations_list to find location IDs.

    Inputs

    location_idintegerrequired
    Location ID. Maximum 2147483647. Example: 3.