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
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the BoxHero connection
In AgentKit > Connections, create a BoxHero connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'boxhero'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'boxhero_bundles_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "boxhero"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize BoxHero:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="boxhero_bundles_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolboxhero_bundle_getGet one bundle.Read-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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-onlyGet 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-onlyGet 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-onlyList 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-onlyGet 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.
boxhero_locations_listList the team's active locations with their total stock.Read-onlyList Locations
List the team's active locations with their total stock. Returns each location's id, name, memo and quantity. Only for teams in location mode.
Inputs
This tool takes no inputs.
boxhero_members_listList the members of the BoxHero team.Read-onlyList Team Members
List the members of the BoxHero team. Returns each member's id, name, email and role. Use member IDs as created_by_id filters on order lists.
Inputs
This tool takes no inputs.
boxhero_partner_getGet one supplier or customer.Read-onlyGet Partner
Get one supplier or customer. Returns its type, name, phone, email, address and memo. Use partners_list to find partner IDs.
Inputs
partner_idintegerrequired- Partner ID. Maximum 2147483647. Example: 77.
boxhero_partners_listList suppliers and customers, optionally filtered by type, with cursor paging.Read-onlyList Partners
List suppliers and customers, optionally filtered by type, with cursor paging. Returns each partner's id, type, name, phone, email, address and memo. Use partner IDs on transactions and orders.
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.
limitinteger- Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
typeinteger- Filter by partner type. Pass 0 for suppliers only or 1 for customers only. Omit to list both. Maximum 1. Example: 0.one of
01
boxhero_price_list_getGet one price list.Read-onlyGet Price List
Get one price list. Returns its name, order type, currency and lines. Use price_lists_list to find price list IDs.
Inputs
price_list_idintegerrequired- Price list id. Maximum 2147483647. Example: 601.
boxhero_price_lists_listList saved price lists for purchase or sales orders, with cursor paging.Read-onlyList Price Lists
List saved price lists for purchase or sales orders, with cursor paging. Returns each list's id, name, order type, currency and lines. Use price_list_get for one list.
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.
limitinteger- Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
order_typestring- "purchase" for purchase price lists; "sales" for sales price lists. A price list is tied to one order type. Example: purchase.one of
purchasesales
boxhero_purchase_order_getGet one purchase order.Read-onlyGet Purchase Order
Get one purchase order. Returns its number, status, partner, dates, lines with fulfilled quantities, costs, tags, custom fields, totals and revision. Use purchase_orders_list to find order IDs.
Inputs
order_idintegerrequired- Order id. Use GET /orders/by-number/{order_number} to look up by order number. Maximum 2147483647. Example: 2201.
boxhero_purchase_orders_listList purchase orders, newest first, with filters by status, partner, number, tags, dates and creator, and cursor paging.Read-onlyList Purchase Orders
List purchase orders, newest first, with filters by status, partner, number, tags, dates and creator, and cursor paging. Returns each order's id, number, status, partner, order and estimated times, totals and revision. Use purchase_order_get for its lines and fulfillment progress.
Inputs
created_by_idinteger- Filter by creator member id. Maximum 2147483647. Example: 42.
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.
estimated_afterstring- Filter by estimated_time >= this timestamp. Example: 2026-01-01T00:00:00Z.
estimated_beforestring- Filter by estimated_time < this timestamp. Example: 2026-02-01T00:00:00Z.
limitinteger- Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
order_numberstring- Filter by exact order number. Whitespace is ignored and letters are uppercased. Example: PO-2026-0042.
ordered_afterstring- Filter by order_time >= this timestamp. Example: 2026-01-01T00:00:00Z.
ordered_beforestring- Filter by order_time < this timestamp. Example: 2026-02-01T00:00:00Z.
partner_idinteger- Filter by partner id. Maximum 2147483647. Example: 77.
statusesarray- Filter by one or more order statuses. Example: ["confirmed", "in-progress"]
tagsarray- Filter by tags with all-match semantics. Example: ["urgent"]
boxhero_return_getGet one sales return.Read-onlyGet Sales Return
Get one sales return. Returns its number, status, source order, lines with received quantities, dates and revision. Use returns_list to find return IDs.
Inputs
return_idintegerrequired- Return id. Maximum 2147483647. Example: 3301.
boxhero_returns_listList sales returns, newest first, with filters by status, partner, return or order number, tags, dates and creator, and cursor paging.Read-onlyList Sales Returns
List sales returns, newest first, with filters by status, partner, return or order number, tags, dates and creator, and cursor paging. Returns each return's id, number, status, source order, dates and revision. Use return_get for its lines.
Inputs
created_by_idinteger- Filter by creator member id. Maximum 2147483647. Example: 42.
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.
order_idinteger- Filter by source order id. Maximum 2147483647. Example: 2201.
order_numberstring- Filter by exact source order number. Whitespace is ignored and letters are uppercased. Example: PO-2026-0042.
partner_idinteger- Filter by partner id. Maximum 2147483647. Example: 77.
return_numberstring- Filter by exact return number. Whitespace is ignored and letters are uppercased. Example: RT-2026-0007.
returned_afterstring- Filter by return_time >= this timestamp. Example: 2026-01-01T00:00:00Z.
returned_beforestring- Filter by return_time < this timestamp. Example: 2026-02-01T00:00:00Z.
statusesarray- Filter by one or more return statuses. Example: ["confirmed", "in-progress"]
tagsarray- Filter by tags with all-match semantics. Example: ["urgent"]
boxhero_sales_order_getGet one sales order.Read-onlyGet Sales Order
Get one sales order. Returns its number, status, partner, dates, lines with fulfilled quantities, costs, tags, custom fields, totals and revision. Use sales_orders_list to find order IDs.
Inputs
order_idintegerrequired- Order id. Use GET /orders/by-number/{order_number} to look up by order number. Maximum 2147483647. Example: 2201.
boxhero_sales_orders_listList sales orders, newest first, with filters by status, partner, number, tags, dates and creator, and cursor paging.Read-onlyList Sales Orders
List sales orders, newest first, with filters by status, partner, number, tags, dates and creator, and cursor paging. Returns each order's id, number, status, partner, order and estimated times, totals and revision. Use sales_order_get for its lines and fulfillment progress.
Inputs
created_by_idinteger- Filter by creator member id. Maximum 2147483647. Example: 42.
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.
estimated_afterstring- Filter by estimated_time >= this timestamp. Example: 2026-01-01T00:00:00Z.
estimated_beforestring- Filter by estimated_time < this timestamp. Example: 2026-02-01T00:00:00Z.
limitinteger- Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
order_numberstring- Filter by exact order number. Whitespace is ignored and letters are uppercased. Example: PO-2026-0042.
ordered_afterstring- Filter by order_time >= this timestamp. Example: 2026-01-01T00:00:00Z.
ordered_beforestring- Filter by order_time < this timestamp. Example: 2026-02-01T00:00:00Z.
partner_idinteger- Filter by partner id. Maximum 2147483647. Example: 77.
statusesarray- Filter by one or more order statuses. Example: ["confirmed", "in-progress"]
tagsarray- Filter by tags with all-match semantics. Example: ["urgent"]
boxhero_team_getGet the BoxHero team the API token belongs to.Read-onlyGet Linked Team
Get the BoxHero team the API token belongs to. Returns the team's id, name, inventory mode (basic or location) and currency. Check the mode first: location tools and location_id only apply to teams in location mode.
Inputs
This tool takes no inputs.
boxhero_transaction_getGet one inventory transaction, or an earlier revision of it.Read-onlyGet Transaction
Get one inventory transaction, or an earlier revision of it. Returns its type, time, locations, partner, memo, line items and revision. Use transactions_list to find transaction IDs.
Inputs
tx_idintegerrequired- Tx ID. Maximum 2147483647. Example: 4401.
revisioninteger- Fetch a specific historical revision of this transaction. Omit to fetch the latest revision. Maximum 9007199254740991. Example: 3.
boxhero_transactions_listList inventory transactions, newest first, optionally by type, with cursor paging.Read-onlyList Transactions
List inventory transactions, newest first, optionally by type, with cursor paging. Returns each transaction's id, type, time, locations, partner, memo and line items. Use transaction_get for one transaction.
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.
limitinteger- Page size. Accepts 1–100; defaults to 100. Maximum 100. Example: 50.
typestring- Filter by transaction type. Pass "in", "out", "move", or "adjust". Omit to list every type. Example: in.one of
inoutmoveadjust
boxhero_bundle_createCreate a bundle from existing items and quantities.WriteCreate Bundle
Create a bundle from existing items and quantities. Returns the bundle with its id. Bundles hold no stock themselves; they can be used as order lines.
Inputs
componentsarrayrequired- Items in the bundle, each by item_id or item_sku with the quantity per bundle. Bundles cannot contain other bundles. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 2}].
namestringrequired- Bundle display name. Example: Tea gift set.
skustringrequired- Stock Keeping Unit. Must be unique across active bundles in the team. Example: GIFT-TEA-SET.
barcodestring- Primary bundle barcode. Example: 8801234567893.
coststring- Cost per bundle, as a decimal string. Example: 2.75.
memostring- Free-text memo. Example: Weekly restock.
photo_urlstring- Public URL of the bundle photo. Example: https://cdn.example.com/photo.jpg.
pricestring- Selling price per bundle, as a decimal string. Example: 4.50.
boxhero_bundle_updateUpdate a bundle's details or replace its component list.WriteUpdate Bundle
Update a bundle's details or replace its component list. Returns the updated bundle. Passing components replaces the whole list.
- Idempotent
Inputs
bundle_idintegerrequired- Bundle ID. Maximum 2147483647. Example: 501.
barcodestring- Primary bundle barcode. Example: 8801234567893.
componentsarray- Component list. When provided on update, this replaces the full component list. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 2}, {"item_sku": "MUG-WHITE", "quantity": 1}]
coststring- Cost per bundle, as a decimal string. Example: 2.75.
memostring- Free-text memo. Example: Weekly restock.
namestring- Bundle display name. Example: Tea gift set.
photo_urlstring- Public URL of the bundle photo. Example: https://cdn.example.com/photo.jpg.
pricestring- Selling price per bundle, as a decimal string. Example: 4.50.
skustring- Stock Keeping Unit. Must be unique across active bundles in the team. Example: GIFT-TEA-SET.
boxhero_item_attr_createCreate a custom item attribute spec.WriteCreate Item Attribute
Create a custom item attribute spec. Returns the spec with its id. Set values on items with item_update attrs.
Inputs
namestringrequired- Display name of the new attribute. 1+ characters. Example: Origin.
typestringrequired- Value type accepted by this attribute. text accepts any string; date accepts an ISO-8601 date (YYYY-MM-DD); number accepts a JSON number; barcode accepts a barcode string. File-type attributes exist in the BoxHero app but cannot be queried or set via the Open API. Example: text.one of
textdatenumberbarcode rankinteger- Sort order. Lower values appear first; ties are broken by id. Ranks need not be contiguous. Optional on create — defaults to the next available rank (current MAX(rank) + 1). Example: 1.
boxhero_item_attr_renameRename a custom item attribute spec.WriteRename Item Attribute
Rename a custom item attribute spec. Returns the updated spec. Its type cannot be changed.
- Idempotent
Inputs
attr_idintegerrequired- Attr ID. Maximum 2147483647. Example: 12.
namestringrequired- New display name. 1+ characters. Example: Country of origin.
boxhero_item_createCreate an item, optionally seeding stock at one location with quantity and location_id.WriteCreate Item
Create an item, optionally seeding stock at one location with quantity and location_id. Returns the created item with its id and SKU. To add stock later, use transaction_create.
Inputs
namestringrequired- Item display name. 1–255 characters. Example: Green Tea 100g.
attrsarray- Custom attribute values. Official request format is [{ "id": , "value": }, ...]. The legacy object form { "": } is still accepted for compatibility. Example: [{"id": 12, "value": "Organic"}]
barcodestring- Primary barcode for the item. Optional. Example: 8801234567893.
coststring- Cost per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team's currency is reported on GET /v1/teams/linked.
location_idinteger- Location at which to seed initial stock. Required together with the body's quantity when the team has more than one active location. Maximum 2147483647. Example: 3.
photo_urlstring- Public URL of the item's photo. Optional. Example: https://cdn.example.com/photo.jpg.
pricestring- Selling price per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team's currency is reported on GET /v1/teams/linked.
quantitynumber- Initial on-hand quantity. Pass together with the location_id query to seed stock at a single location. Omit (or set null) to start with zero stock everywhere. Must be non-zero when provided. Example: 10.5.
skustring- Stock Keeping Unit. Optional; a random SKU-XXXXXXXX is generated when omitted. Must be unique across the team. Example: TEA-GREEN-100G.
boxhero_item_updateUpdate an item's name, SKU, barcode, photo, cost, price or custom attributes.WriteUpdate Item
Update an item's name, SKU, barcode, photo, cost, price or custom attributes. Only the fields you pass change. Returns the updated item. Stock quantities change through transaction_create, not here.
- Idempotent
Inputs
item_idintegerrequired- Item ID. Maximum 2147483647. Example: 1001.
attrsarray- Patch attribute values. Official request format is [{ "id": , "value": }, ...]. Set value to null to remove that attribute. The legacy object form { "": } is still accepted for compatibility. Example: [{"id": 12, "value": "Organic"}]
barcodestring- New primary barcode. Example: 8801234567893.
coststring- Cost per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team's currency is reported on GET /v1/teams/linked.
namestring- New display name. 1–255 characters. Example: Green Tea 100g.
photo_urlstring- New photo URL. Pass an empty string to clear. Example: https://cdn.example.com/photo.jpg.
pricestring- Selling price per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team's currency is reported on GET /v1/teams/linked.
skustring- New SKU. An empty string is ignored (the SKU is left unchanged); an SKU cannot be cleared. Must remain unique within the team. Example: TEA-GREEN-100G.
boxhero_location_createCreate a stock location, such as a warehouse or store.WriteCreate Location
Create a stock location, such as a warehouse or store. Returns the location with its id. Only for teams in location mode; your plan limits the number of locations.
Inputs
namestringrequired- Location display name. Must be unique within the team. Example: Austin warehouse.
memostring- Free-text memo for the location. Example: Weekly restock.
boxhero_location_updateUpdate a location's name or memo.WriteUpdate Location
Update a location's name or memo. Returns the updated location. Use location_get to read the current values.
- Idempotent
Inputs
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
memostring- New memo. Pass an empty string to clear. Example: Weekly restock.
namestring- New display name. Must remain unique within the team. Example: Austin warehouse.
boxhero_partner_createCreate a supplier or customer.WriteCreate Partner
Create a supplier or customer. Returns the partner with its id. Use it as partner_id on Stock In/Out transactions and orders.
Inputs
namestringrequired- Partner display name. 1–255 characters. Example: Leaf & Co.
typeintegerrequired- Partner classification. 0 = supplier (used in Stock In transactions), 1 = customer (used in Stock Out transactions). Maximum 1. Example: 0.one of
01 addressstring- Postal address. Optional. Example: 500 Market St, San Francisco, CA.
emailstring- Email address. Optional. Example: orders@leafco.example.com.
memostring- Free-text memo. Optional. Example: Weekly restock.
phonestring- Phone number. Optional. Example: +1 415 555 0100.
boxhero_partner_updateUpdate a partner's name, phone, email, address or memo.WriteUpdate Partner
Update a partner's name, phone, email, address or memo. Returns the updated partner. The partner type cannot be changed.
- Idempotent
Inputs
namestringrequired- Partner display name. 1–255 characters. Example: Leaf & Co.
partner_idintegerrequired- Partner ID. Maximum 2147483647. Example: 77.
addressstring- Postal address. Optional. Example: 500 Market St, San Francisco, CA.
emailstring- Email address. Optional. Example: orders@leafco.example.com.
memostring- Free-text memo. Optional. Example: Weekly restock.
phonestring- Phone number. Optional. Example: +1 415 555 0100.
boxhero_price_list_createCreate a price list of unit prices for items and bundles, tied to purchase or sales orders.WriteCreate Price List
Create a price list of unit prices for items and bundles, tied to purchase or sales orders. Returns the price list with its id. Prices are decimal strings.
Inputs
itemsarrayrequired- Price list lines, at least one. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a unit price as a decimal string. Example: [{"item_sku": "TEA-GREEN-100G", "price": "4.20"}].
namestringrequired- Price list display name. Example: Wholesale 2026.
order_typestringrequired- "purchase" for purchase price lists; "sales" for sales price lists. A price list is tied to one order type. Example: purchase.one of
purchasesales currency_codestring- ISO 4217 currency code. Example: USD.
boxhero_price_list_updateUpdate a price list's name, order type, currency or lines.WriteUpdate Price List
Update a price list's name, order type, currency or lines. Returns the updated price list. Passing items replaces every line.
- Idempotent
Inputs
price_list_idintegerrequired- Price list id. Maximum 2147483647. Example: 601.
currency_codestring- ISO 4217 currency code. Pass null to clear it. Example: USD.
itemsarray- Price list lines, at least one. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a unit price as a decimal string. Example: [{"item_sku": "TEA-GREEN-100G", "price": "4.20"}].
namestring- New price list name. Example: Wholesale 2026.
order_typestring- "purchase" for purchase price lists; "sales" for sales price lists. A price list is tied to one order type. Example: purchase.one of
purchasesales
boxhero_purchase_order_createCreate a purchase order with lines that each need a quantity and price.WriteCreate Purchase Order
Create a purchase order with lines that each need a quantity and price. Set is_draft for a draft, or finalize_immediately with location_id to receive everything at once. Returns the order with its id, number and revision. Use purchase_order_fulfill to record partial receipts later.
Inputs
itemsarrayrequired- Order lines. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a quantity and a unit price (decimal string); tax and discount objects are optional. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10, "price": "4.50"}].
costsarray- Additional costs to attach, in display order. Included in total_price but not in any items\[\] figure. Example: [{"name": "Shipping", "amount": "15.00"}]
currency_codestring- ISO 4217 currency code. On create, defaults to the team's currency when omitted. On update, omitting it keeps the stored value; it cannot be cleared. Example: USD.
custom_fieldsarray- Ordered custom field name-value pairs. Example: [{"name": "Project", "value": "Spring launch"}]
estimated_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
finalize_immediatelyboolean- Fulfill all lines immediately and mark the order done. Example: true.
is_draftboolean- Create the order in draft status. Example: true.
location_idinteger- Required when finalize_immediately is true. Maximum 2147483647. Example: 3.
memostring- Memo. Example: Weekly restock.
order_numberstring- Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: PO-2026-0042.
order_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
partner_idinteger- Supplier for purchase orders or customer for sales orders. Pass null to clear. Maximum 2147483647. Example: 77.
boxhero_purchase_order_fulfillReceive part of a purchase order: record a Stock In transaction for the given lines at a location.WriteReceive Purchase Order Quantities
Receive part of a purchase order: record a Stock In transaction for the given lines at a location. Returns the created transaction and the order's new revision. Use purchase_order_fulfill_all to receive everything that remains.
Inputs
itemsarrayrequired- Lines to fulfill. Each names an item by item_id or item_sku with a positive quantity. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 5}].
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_purchase_order_fulfill_allReceive every remaining quantity of a purchase order at a location and mark it done.WriteReceive All Remaining Purchase Order Quantities
Receive every remaining quantity of a purchase order at a location and mark it done. Returns the created transaction and the updated order. Use purchase_order_fulfill for a partial receipt.
Inputs
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_purchase_order_status_updateSet a purchase order's status (draft, confirmed, in-progress or done).WriteUpdate Purchase Order Status
Set a purchase order's status (draft, confirmed, in-progress or done). Any status can move to any other. Returns the updated order. Recording stock with purchase_order_fulfill advances the status automatically.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
statusstringrequired- Order status. Purchase and sales orders may also be draft. Recording stock through the order's transaction endpoints advances the status automatically: confirmed becomes in-progress once any quantity is recorded, and done once nothing remains. A done order is never reverted by such transaction changes; only an explicit status update can change it. Example: draft.one of
draftconfirmedin-progressdone revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_purchase_order_updateUpdate a purchase order's number, partner, dates, memo, custom fields, currency or lines.WriteUpdate Purchase Order
Update a purchase order's number, partner, dates, memo, custom fields, currency or lines. Passing items replaces every line. Returns the updated order with its new revision. Pass revision to avoid overwriting someone else's edit.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
costsarray- Replacement additional costs, in display order. Omit to preserve the current costs; pass an empty array to remove all of them. Example: [{"name": "Shipping", "amount": "15.00"}]
currency_codestring- ISO 4217 currency code. On create, defaults to the team's currency when omitted. On update, omitting it keeps the stored value; it cannot be cleared. Example: USD.
custom_fieldsarray- Ordered custom field name-value pairs. Example: [{"name": "Project", "value": "Spring launch"}]
estimated_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
itemsarray- Order lines. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a quantity and a unit price (decimal string); tax and discount objects are optional. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10, "price": "4.50"}].
memostring- Memo. Example: Weekly restock.
order_numberstring- Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: PO-2026-0042.
order_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
partner_idinteger- Supplier for purchase orders or customer for sales orders. Pass null to clear. Maximum 2147483647. Example: 77.
revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_return_createCreate a sales return against a sales order (by order_id or order_number), listing the order lines and quantities returned.WriteCreate Sales Return
Create a sales return against a sales order (by order_id or order_number), listing the order lines and quantities returned. Returns the return with its id, number and revision. Set finalize_immediately with location_id to put the stock back at once.
Inputs
itemsarrayrequired- Return lines. Each gives the source sales order line ID (order_item_id, from sales_order_get) and the quantity returned. Example: [{"order_item_id": 9001, "quantity": 1}].
finalize_immediatelyboolean- Receive all returned quantities immediately and mark the return done. Example: true.
location_idinteger- Required when finalize_immediately is true. Maximum 2147483647. Example: 3.
memostring- Memo. Example: Weekly restock.
order_idinteger- Source sales order id. Mutually exclusive with order_number. Maximum 2147483647. Example: 2201.
order_numberstring- Source sales order number. Mutually exclusive with order_id. Example: SO-2026-0042.
order_revisioninteger- Latest observed source order revision. Maximum 9007199254740991. Example: 3.
return_numberstring- Return number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: RT-2026-0007.
return_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
boxhero_return_receiveReceive part of a sales return back into stock at a location.WriteReceive Returned Quantities
Receive part of a sales return back into stock at a location. Returns the created Stock In transaction and the return's new revision. Use return_receive_all to receive everything that remains.
Inputs
itemsarrayrequired- Lines to fulfill. Each names an item by item_id or item_sku with a positive quantity. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 5}].
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
return_idintegerrequired- Return ID. Maximum 2147483647. Example: 3301.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_return_receive_allReceive every remaining quantity of a sales return at a location and mark it done.WriteReceive All Returned Quantities
Receive every remaining quantity of a sales return at a location and mark it done. Returns the created transaction and the updated return. Use return_receive for a partial receipt.
Inputs
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
return_idintegerrequired- Return ID. Maximum 2147483647. Example: 3301.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_return_updateUpdate a sales return's number, time, memo, status or lines.WriteUpdate Sales Return
Update a sales return's number, time, memo, status or lines. Passing items replaces every line. Returns the updated return with its new revision. Pass revision to avoid overwriting someone else's edit.
- Idempotent
Inputs
return_idintegerrequired- Return ID. Maximum 2147483647. Example: 3301.
itemsarray- Return lines. Each gives the source sales order line ID (order_item_id, from sales_order_get) and the quantity returned. Example: [{"order_item_id": 9001, "quantity": 1}].
memostring- Memo. Example: Weekly restock.
order_revisioninteger- Latest observed source order revision when replacing items. Maximum 9007199254740991. Example: 3.
return_numberstring- Return number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: RT-2026-0007.
return_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
revisioninteger- Latest observed return revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
statusstring- Return status. Recording stock through the return's transaction endpoints advances the status automatically: confirmed becomes in-progress once any quantity is received, and done once nothing remains. A done return is never reverted by such transaction changes. Example: confirmed.one of
confirmedin-progressdone
boxhero_sales_order_createCreate a sales order with lines that each need a quantity and price.WriteCreate Sales Order
Create a sales order with lines that each need a quantity and price. Set is_draft for a draft, or finalize_immediately with location_id to ship everything at once. Returns the order with its id, number and revision. Use sales_order_fulfill to record partial shipments later.
Inputs
itemsarrayrequired- Order lines. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a quantity and a unit price (decimal string); tax and discount objects are optional. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10, "price": "4.50"}].
costsarray- Additional costs to attach, in display order. Included in total_price but not in any items\[\] figure. Example: [{"name": "Shipping", "amount": "15.00"}]
currency_codestring- ISO 4217 currency code. On create, defaults to the team's currency when omitted. On update, omitting it keeps the stored value; it cannot be cleared. Example: USD.
custom_fieldsarray- Ordered custom field name-value pairs. Example: [{"name": "Project", "value": "Spring launch"}]
estimated_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
finalize_immediatelyboolean- Fulfill all lines immediately and mark the order done. Example: true.
is_draftboolean- Create the order in draft status. Example: true.
location_idinteger- Required when finalize_immediately is true. Maximum 2147483647. Example: 3.
memostring- Memo. Example: Weekly restock.
order_numberstring- Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: SO-2026-0042.
order_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
partner_idinteger- Supplier for purchase orders or customer for sales orders. Pass null to clear. Maximum 2147483647. Example: 77.
boxhero_sales_order_fulfillShip part of a sales order: record a Stock Out transaction for the given lines at a location.WriteShip Sales Order Quantities
Ship part of a sales order: record a Stock Out transaction for the given lines at a location. Returns the created transaction and the order's new revision. Use sales_order_fulfill_all to ship everything that remains.
Inputs
itemsarrayrequired- Lines to fulfill. Each names an item by item_id or item_sku with a positive quantity. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 5}].
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_sales_order_fulfill_allShip every remaining quantity of a sales order at a location and mark it done.WriteShip All Remaining Sales Order Quantities
Ship every remaining quantity of a sales order at a location and mark it done. Returns the created transaction and the updated order. Use sales_order_fulfill for a partial shipment.
Inputs
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Revision. Maximum 9007199254740991. Example: 3.
transaction_timestring- Transaction Time. Example: 2026-01-15T10:00:00Z.
boxhero_sales_order_status_updateSet a sales order's status (draft, confirmed, in-progress or done).WriteUpdate Sales Order Status
Set a sales order's status (draft, confirmed, in-progress or done). Any status can move to any other. Returns the updated order. Recording stock with sales_order_fulfill advances the status automatically.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
statusstringrequired- Order status. Purchase and sales orders may also be draft. Recording stock through the order's transaction endpoints advances the status automatically: confirmed becomes in-progress once any quantity is recorded, and done once nothing remains. A done order is never reverted by such transaction changes; only an explicit status update can change it. Example: draft.one of
draftconfirmedin-progressdone revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_sales_order_updateUpdate a sales order's number, partner, dates, memo, custom fields, currency or lines.WriteUpdate Sales Order
Update a sales order's number, partner, dates, memo, custom fields, currency or lines. Passing items replaces every line. Returns the updated order with its new revision. Pass revision to avoid overwriting someone else's edit.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
costsarray- Replacement additional costs, in display order. Omit to preserve the current costs; pass an empty array to remove all of them. Example: [{"name": "Shipping", "amount": "15.00"}]
currency_codestring- ISO 4217 currency code. On create, defaults to the team's currency when omitted. On update, omitting it keeps the stored value; it cannot be cleared. Example: USD.
custom_fieldsarray- Ordered custom field name-value pairs. Example: [{"name": "Project", "value": "Spring launch"}]
estimated_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
itemsarray- Order lines. Each names exactly one of item_id, item_sku, bundle_id or bundle_sku, with a quantity and a unit price (decimal string); tax and discount objects are optional. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10, "price": "4.50"}].
memostring- Memo. Example: Weekly restock.
order_numberstring- Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create. Example: SO-2026-0042.
order_timestring- ISO 8601 timestamp or millisecond epoch. Example: 2026-01-15T10:00:00Z.
partner_idinteger- Supplier for purchase orders or customer for sales orders. Pass null to clear. Maximum 2147483647. Example: 77.
revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_transaction_createRecord a Stock In, Stock Out, Move Stock or Adjust Stock transaction.WriteCreate Transaction
Record a Stock In, Stock Out, Move Stock or Adjust Stock transaction. Returns the transaction with its id and revision. In location mode, set to_location_id (and from_location_id for moves).
Inputs
itemsarrayrequired- Line items, at least one. Each names an item by item_id or item_sku and gives a quantity: positive for Stock In and Move Stock, negative for Stock Out, and the new on-hand amount for Adjust Stock. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10}].
typestringrequired- Transaction type. "in" = Stock In (incoming inventory), "out" = Stock Out (outgoing inventory), "move" = Move Stock (transfer between two locations), "adjust" = Adjust Stock (correction at a single location). Example: in.one of
inoutmoveadjust from_location_idinteger- Source location. Required on Move Stock and rejected on every other transaction type. Maximum 2147483647. Example: 3.
memostring- Free-text memo for the transaction. Example: Weekly restock.
partner_idinteger- Partner (supplier on Stock In, customer on Stock Out). Not allowed on Move Stock or Adjust Stock. Maximum 2147483647. Example: 77.
to_location_idinteger- Destination location. Required on every transaction type — except when the team has exactly one active location, in which case it is auto-filled. If omitted while the team has two or more active locations the request is rejected. Maximum 2147483647. Example: 4.
tx_timestring- Effective time of the transaction (ISO 8601 datetime string). Defaults to now. Cannot be in the future. Not allowed on Adjust Stock — the server rejects the request if it is set. Example: 2026-01-15T10:00:00Z.
boxhero_transaction_updateEdit a transaction's time, locations, partner, memo or line items.WriteUpdate Transaction
Edit a transaction's time, locations, partner, memo or line items. Returns the updated transaction with its new revision. Pass revision to avoid overwriting someone else's edit.
- Idempotent
Inputs
tx_idintegerrequired- Tx ID. Maximum 2147483647. Example: 4401.
from_location_idinteger- New source location. Only allowed on Move Stock transactions; rejected with 400 on other types. Maximum 2147483647. Example: 3.
itemsarray- Line items, at least one. Each names an item by item_id or item_sku and gives a quantity: positive for Stock In and Move Stock, negative for Stock Out, and the new on-hand amount for Adjust Stock. Example: [{"item_sku": "TEA-GREEN-100G", "quantity": 10}].
memostring- New memo. Pass an empty string to clear. Example: Weekly restock.
partner_idinteger- New counterparty. Pass null to clear an existing partner. Not allowed on Move Stock or Adjust Stock. Maximum 2147483647. Example: 77.
revisioninteger- Latest revision you have observed. Omit to skip the concurrency check; pass the current value to refuse the update if another writer beat you to it. Maximum 9007199254740991. Example: 3.
to_location_idinteger- New destination location. Maximum 2147483647. Example: 4.
tx_timestring- New effective time of the transaction (ISO 8601 datetime string). Cannot be in the future. Not allowed on Adjust Stock. Omit to keep the existing transaction time. Moving the time into the past is rejected with tx-modify-too-old-tx-id when more than 5,000 of the team's transactions would need recalculation. Example: 2026-01-15T10:00:00Z.
boxhero_bundle_deleteDelete a bundle.DestructiveDelete Bundle
Delete a bundle. Returns an empty response on success. Its component items are not affected.
- Idempotent
Inputs
bundle_idintegerrequired- Bundle ID. Maximum 2147483647. Example: 501.
boxhero_item_attr_deleteDelete a custom item attribute spec and its values on every item.DestructiveDelete Item Attribute
Delete a custom item attribute spec and its values on every item. Returns an empty response on success. This cannot be undone.
- Idempotent
Inputs
attr_idintegerrequired- Attr ID. Maximum 2147483647. Example: 12.
boxhero_item_deleteDelete an item.DestructiveDelete Item
Delete an item. Returns an empty response on success. Its past transactions stay in the history.
- Idempotent
Inputs
item_idintegerrequired- Item ID. Maximum 2147483647. Example: 1001.
boxhero_location_deleteDelete a location.DestructiveDelete Location
Delete a location. Returns an empty response on success. Move its stock elsewhere first with a move transaction.
- Idempotent
Inputs
location_idintegerrequired- Location ID. Maximum 2147483647. Example: 3.
boxhero_partner_deleteDelete a supplier or customer.DestructiveDelete Partner
Delete a supplier or customer. Returns an empty response on success. Past transactions keep their partner reference.
- Idempotent
Inputs
partner_idintegerrequired- Partner ID. Maximum 2147483647. Example: 77.
boxhero_purchase_order_deleteDelete a purchase order.DestructiveDelete Purchase Order
Delete a purchase order. Returns an empty response on success. Stock already recorded through it stays as transactions.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_return_deleteDelete a sales return.DestructiveDelete Sales Return
Delete a sales return. Returns an empty response on success. Stock already received through it stays as transactions.
- Idempotent
Inputs
return_idintegerrequired- Return ID. Maximum 2147483647. Example: 3301.
revisioninteger- Latest observed return revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_sales_order_deleteDelete a sales order.DestructiveDelete Sales Order
Delete a sales order. Returns an empty response on success. Stock already recorded through it stays as transactions.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Maximum 2147483647. Example: 2201.
memostring- Memo. Example: Weekly restock.
revisioninteger- Latest observed revision. Omit to use the current revision. Maximum 9007199254740991. Example: 3.
boxhero_transaction_deleteDelete a transaction and reverse its stock change.DestructiveDelete Transaction
Delete a transaction and reverse its stock change. Returns an empty response on success. Pass revision to avoid deleting a transaction someone just edited.
- Idempotent
Inputs
tx_idintegerrequired- Tx ID. Maximum 2147483647. Example: 4401.
memostring- Optional memo recorded alongside the deletion (audit log). Example: Weekly restock.
revisioninteger- Latest revision you have observed. Pass to enforce optimistic concurrency. Maximum 9007199254740991. Example: 3.
No tools match.