Boxhero integration: operations for AI agents
Boxhero connects to Type.com as an integration. This page lists the 85 operations documented for Claude and Codex in Type.com: 28 read, 42 write, 15 destructive.
About 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.
Categories: Productivity & Project Management
How to connect Boxhero to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
85 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
85 operations listed.
Bundles
- Read
Get a bundle by SKU
Looks up a bundle by SKU (case-sensitive) and returns the same payload as GET /bundles/{bundle_id}. URL-encode special characters in the SKU.
GET /v1/bundles/by-sku/{sku} - Read
Get a bundle
Returns a single active bundle with its component items. Deleting an item removes it from its bundles, so components only reference existing items.
GET /v1/bundles/{bundle_id} - Read
List bundles
Returns a cursor-paginated list of active bundles. Bundle stock is not tracked directly; stock belongs to the underlying component items.
GET /v1/bundles - Write
Create a bundle
Creates a bundle from existing items. Bundles cannot contain other bundles and do not create stock on their own.
POST /v1/bundles - Write
Update a bundle by SKU
Looks up a bundle by SKU (case-sensitive) and applies the same partial update as PUT /bundles/{bundle_id}.
PUT /v1/bundles/by-sku/{sku} - Write
Update a bundle
Partially updates a bundle. Omitted scalar fields are preserved. When `components` is provided, it replaces the full component list.
PUT /v1/bundles/{bundle_id} - Destructive
Delete a bundle by SKU
Looks up a bundle by SKU (case-sensitive) and soft-deletes it.
DELETE /v1/bundles/by-sku/{sku} - Destructive
Delete a bundle
Soft-deletes a bundle. Existing orders and returns retain historical line references.
DELETE /v1/bundles/{bundle_id}
Item Attrs
- Read
Get an attribute spec
Returns a single custom attribute spec by id.
GET /v1/item-attrs/{attr_id} - Read
List attribute specs
Lists every custom attribute spec defined for the team, sorted by rank ascending. File-type attributes are excluded.
GET /v1/item-attrs - Write
Create an attribute spec
Creates a new custom attribute spec for the team. The `type` cannot be changed after creation.
POST /v1/item-attrs - Write
Rename an attribute spec
Renames an attribute spec. Only `name` is editable — create a new attribute if you need a different `type`.
PUT /v1/item-attrs/{attr_id} - Write
Reorder attribute specs
Updates the rank of one or more attribute specs in a single call. Pass a list of `(id, rank)` pairs; ranks need not be contiguous and only the specs you include are updated.
PUT /v1/item-attrs/ranks - Destructive
Delete an attribute spec
Deletes an attribute spec. The spec's existing values on items are no longer returned.
DELETE /v1/item-attrs/{attr_id}
Items
- Read
Get an item by SKU
Looks up an item by SKU (case-insensitive) and returns the same payload as GET /items/{item_id}. URL-encode special characters in the SKU.
GET /v1/items/by-sku/{sku} - Read
Get an item
Returns a single item by id. The response includes a `quantities` per-location breakdown alongside the rolled-up `quantity`; pass `location_ids` to scope the breakdown to specific locations.
GET /v1/items/{item_id} - Read
List items
Returns a cursor-paginated list of items in the team. Each item carries a `quantities` per-location breakdown; pass `location_ids` to scope that breakdown to specific locations. `location_ids` also filters the list to items with nonzero stock at those locations.
GET /v1/items - Write
Create an item
Creates a new item in the team. Pass `location_id` (query) together with `quantity` (body) to seed initial stock at a single location; otherwise the item starts with zero stock everywhere. When `quantity` is provided without `location_id`, the team must have exactly one active location (it is used automatically); otherwise the request fails with `400`. Initial stock is applied in a second step after the item is created: if it fails, the item still exists and the error is returned, so add stock with a transaction instead of re-creating the item.
POST /v1/items - Write
Update an item by SKU
Looks up an item by SKU (case-insensitive) and applies the same partial update as PUT /items/{item_id}.
PUT /v1/items/by-sku/{sku} - Write
Update an item
Partially updates an item. Only the fields you include are changed. Use `attrs[ ] = null` to remove a single custom attribute value. Stock levels are not modified here — issue a transaction instead.
PUT /v1/items/{item_id} - Destructive
Delete an item by SKU
Looks up an item by SKU (case-insensitive) and deletes it.
DELETE /v1/items/by-sku/{sku} - Destructive
Delete an item
Deletes an item. The item is also removed from every bundle that contains it. Existing transactions retain a snapshot of the item's name and stay readable.
DELETE /v1/items/{item_id}
Locations
- Read
Get a location
Returns a single location by id.
GET /v1/locations/{location_id} - Read
List locations
Returns every active location in the team, with each location's rolled-up quantity.
GET /v1/locations - Write
Create a location
Creates a new location. `name` must be unique within the team. Returns `400` on a name collision and `402` when the team is over a plan limit.
POST /v1/locations - Write
Update a location
Updates a location's name and/or memo. Renames must remain unique within the team. May return `402` when the team is over a plan limit.
PUT /v1/locations/{location_id} - Destructive
Delete a location
Deletes a location, except the team's last remaining location (403). Locations may be deleted regardless of remaining stock; transactions that referenced the deleted location stay readable, but the embedded `to_location` / `from_location` will report `deleted: true`.
DELETE /v1/locations/{location_id}
Members
- Read
Get a team member
Returns a single team member by id.
GET /v1/members/{member_id} - Read
List team members
Lists every active member of the team linked to the current API token. Read-only — membership is managed in the BoxHero app. Membership is limited by the team's plan, so the response is returned as a single unbounded `{items, count}` payload.
GET /v1/members
Partners
- Read
Get a partner
Returns a single partner by id.
GET /v1/partners/{partner_id} - Read
List partners
Returns a cursor-paginated list of partners (suppliers and customers). Items are ordered by id **ascending** (legacy wire-compat). Pass `type=0` for suppliers only or `type=1` for customers only.
GET /v1/partners - Write
Create a partner
Creates a new partner. Set `type` to `0` for a supplier (used in Stock In) or `1` for a customer (used in Stock Out). May return `402` when the team is over a plan limit.
POST /v1/partners - Write
Update a partner
Updates an existing partner's name, contact details, and memo. `type` cannot be changed once set.
PUT /v1/partners/{partner_id} - Destructive
Delete a partner
Deletes a partner. Existing transactions stay readable and reference the partner with `deleted: true`; they show the partner's current name, not a snapshot.
DELETE /v1/partners/{partner_id}
Price Lists
- Read
Get a price list
Returns a single price list by id, including its line items. Each item references either an `item` or a `bundle`.
GET /v1/price-lists/{price_list_id} - Read
List price lists
Returns a cursor-paginated list of price lists (id ascending), without their line items. Pass `order_type` to filter by purchase or sales price lists.
GET /v1/price-lists - Write
Create a price list
Creates a price list with at least one line item. Each item provides exactly one of `item_id`, `item_sku`, `bundle_id`, or `bundle_sku`, plus a `price`. `item_id` / `bundle_id` of a deleted item or bundle is accepted; `item_sku` / `bundle_sku` only match existing ones.
POST /v1/price-lists - Write
Update a price list
Updates a price list. Only included fields change. When `items` is provided it replaces the entire line set; omit it to leave items unchanged. Pass `currency_code: null` to clear the currency.
PUT /v1/price-lists/{price_list_id} - Destructive
Delete a price list
Soft-deletes a price list.
DELETE /v1/price-lists/{price_list_id}
Purchase Orders
- Read
Get a purchase order by order number
Looks up a purchase order by order number and returns the same payload as the by-id endpoint. Whitespace is ignored and letters are uppercased.
GET /v1/purchase-orders/by-number/{order_number} - Read
Get a purchase order
Returns a purchase order by id, with lines, per-item fulfillment progress, and linked stock transactions. Use `/v1/purchase-orders/by-number/{order_number}` for lookup by order number. Per-line pending quantity is not available because fulfillment transactions are tracked per item.
GET /v1/purchase-orders/{order_id} - Read
List purchase orders
Returns a cursor-paginated list of active purchase orders. Ordered newest first by `order_time`, then by id (descending); the cursor follows this order. Line items, fulfillment progress, tags, and custom fields are available from the single-order endpoint.
GET /v1/purchase-orders - Write
Complete all remaining purchase order fulfillment by order number
Looks up a purchase order by order number and fulfills every remaining quantity, marking the order done. The target `location_id` must be covered by the team's plan. Whitespace is ignored and letters are uppercased.
POST /v1/purchase-orders/by-number/{order_number}/transactions/complete - Write
Receive all remaining purchase order quantities
Creates fulfillment transactions for every remaining purchase order quantity and marks the order done. The target `location_id` must be covered by the team's plan.
POST /v1/purchase-orders/{order_id}/transactions/complete - Write
Create purchase order fulfillment transaction by order number
Looks up a purchase order by order number and creates a partial fulfillment transaction. The target `location_id` must be covered by the team's plan. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes. Whitespace is ignored and letters are uppercased.
POST /v1/purchase-orders/by-number/{order_number}/transactions - Write
Receive purchase order quantities
Creates a partial fulfillment transaction for a purchase order. Quantities are positive; the transaction direction is Stock In. The target `location_id` must be covered by the team's plan. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes.
POST /v1/purchase-orders/{order_id}/transactions - Write
Create a purchase order
Creates a purchase order. Each item in `items[]` requires `price`. Set `finalize_immediately` with `location_id` to receive all ordered quantities immediately — the location must be covered by the team's plan or the request fails with `402`. `order_number` may only contain letters, numbers, hyphens, underscores, and whitespace; auto-generated when omitted.
POST /v1/purchase-orders - Write
Update a purchase order by order number
Looks up a purchase order by order number and applies the same partial update as the by-id endpoint. Whitespace is ignored and letters are uppercased.
PUT /v1/purchase-orders/by-number/{order_number} - Write
Update purchase order status by order number
Looks up a purchase order by order number and updates its status. No transition guard is applied: any status may transition to any other status, including backward (e.g. `done` → `draft`). Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes. Whitespace is ignored and letters are uppercased.
PUT /v1/purchase-orders/by-number/{order_number}/status - Write
Update purchase order status
Sets the purchase order status directly. No transition guard is applied: any status may transition to any other status, including backward (e.g. `done` → `draft`). This mirrors core behavior. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes.
PUT /v1/purchase-orders/{order_id}/status - Write
Update a purchase order
Partially updates a purchase order. Omitted scalar fields are preserved; when `items` is provided it replaces the full line list.
PUT /v1/purchase-orders/{order_id} - Destructive
Delete a purchase order by order number
Looks up a purchase order by order number and deletes it: the order itself is soft-deleted (no longer returned), but its line items and costs are permanently removed. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory. Whitespace is ignored and letters are uppercased.
DELETE /v1/purchase-orders/by-number/{order_number} - Destructive
Delete a purchase order
Deletes a purchase order: the order itself is soft-deleted (no longer returned), but its line items and costs are permanently removed. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory.
DELETE /v1/purchase-orders/{order_id}
Returns
- Read
Get a sales return by return number
Looks up a sales return by return number and returns the same payload as GET /returns/{return_id}. Whitespace is ignored and letters are uppercased.
GET /v1/returns/by-number/{return_number} - Read
Get a sales return
Returns a sales return by id, with source order reference, lines, per-item receiving progress, and linked stock transactions.
GET /v1/returns/{return_id} - Read
List sales returns
Returns a cursor-paginated list of active sales returns. Ordered newest first by `return_time`, then by id (descending); the cursor follows this order. Line items, tags, and receiving progress are available from the single-return endpoint.
GET /v1/returns - Write
Receive all remaining returned quantities by return number
Looks up a sales return by return number and creates receiving transactions for every remaining returned quantity, marking the return done. Whitespace is ignored and letters are uppercased.
POST /v1/returns/by-number/{return_number}/transactions/complete - Write
Receive all remaining returned quantities
Creates receiving transactions for every remaining returned quantity and marks the return done.
POST /v1/returns/{return_id}/transactions/complete - Write
Receive returned quantities by return number
Looks up a sales return by return number and creates a partial receiving transaction. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` return is never reverted by later transaction changes. Whitespace is ignored and letters are uppercased.
POST /v1/returns/by-number/{return_number}/transactions - Write
Receive returned quantities
Creates a partial receiving transaction for a sales return. Quantities are positive; the transaction direction is Stock In. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` return is never reverted by later transaction changes.
POST /v1/returns/{return_id}/transactions - Write
Create a sales return
Creates a sales return for a sales order. Set `finalize_immediately` with `location_id` to receive all returned quantities immediately. `return_number` may only contain letters, numbers, hyphens, underscores, and whitespace; auto-generated when omitted.
POST /v1/returns - Write
Update a sales return by return number
Looks up a sales return by return number and applies the same partial update as PUT /returns/{return_id}. Whitespace is ignored and letters are uppercased.
PUT /v1/returns/by-number/{return_number} - Write
Update a sales return
Partially updates a sales return. Omitted scalar fields are preserved; when `items` is provided it replaces the full line list.
PUT /v1/returns/{return_id} - Destructive
Delete a sales return by return number
Looks up a sales return by return number and deletes it: the return itself is soft-deleted (no longer returned), but its line items are permanently removed. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory. Whitespace is ignored and letters are uppercased.
DELETE /v1/returns/by-number/{return_number} - Destructive
Delete a sales return
Deletes a sales return: the return itself is soft-deleted (no longer returned), but its line items are permanently removed. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory.
DELETE /v1/returns/{return_id}
Sales Orders
- Read
Get a sales order by order number
Looks up a sales order by order number and returns the same payload as the by-id endpoint. Whitespace is ignored and letters are uppercased.
GET /v1/sales-orders/by-number/{order_number} - Read
Get a sales order
Returns a sales order by id, with lines, sales-return totals, per-item fulfillment progress, and linked stock transactions. Use `/v1/sales-orders/by-number/{order_number}` for lookup by order number. Per-line pending quantity is not available because fulfillment transactions are tracked per item.
GET /v1/sales-orders/{order_id} - Read
List sales orders
Returns a cursor-paginated list of active sales orders. Ordered newest first by `order_time`, then by id (descending); the cursor follows this order. Line items, return totals, fulfillment progress, tags, and custom fields are available from the single-order endpoint.
GET /v1/sales-orders - Write
Complete all remaining sales order fulfillment by order number
Looks up a sales order by order number and fulfills every remaining quantity, marking the order done. The target `location_id` must be covered by the team's plan. Whitespace is ignored and letters are uppercased.
POST /v1/sales-orders/by-number/{order_number}/transactions/complete - Write
Ship all remaining sales order quantities
Creates fulfillment transactions for every remaining sales order quantity and marks the order done. The target `location_id` must be covered by the team's plan.
POST /v1/sales-orders/{order_id}/transactions/complete - Write
Create sales order fulfillment transaction by order number
Looks up a sales order by order number and creates a partial fulfillment transaction. The target `location_id` must be covered by the team's plan. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes. Whitespace is ignored and letters are uppercased.
POST /v1/sales-orders/by-number/{order_number}/transactions - Write
Ship sales order quantities
Creates a partial fulfillment transaction for a sales order. Public quantities are positive; the core payload is recorded as Stock Out. The target `location_id` must be covered by the team's plan. Stock is allowed to go negative if the requested quantity exceeds on-hand. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes.
POST /v1/sales-orders/{order_id}/transactions - Write
Create a sales order
Creates a sales order. Each item in `items[]` requires `price`. Set `finalize_immediately` with `location_id` to ship all ordered quantities immediately — the location must be covered by the team's plan or the request fails with `402`. `order_number` may only contain letters, numbers, hyphens, underscores, and whitespace; auto-generated when omitted.
POST /v1/sales-orders - Write
Update a sales order by order number
Looks up a sales order by order number and applies the same partial update as the by-id endpoint. Whitespace is ignored and letters are uppercased.
PUT /v1/sales-orders/by-number/{order_number} - Write
Update sales order status by order number
Looks up a sales order by order number and updates its status. No transition guard is applied: any status may transition to any other status, including backward (e.g. `done` → `draft`). Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes. Whitespace is ignored and letters are uppercased.
PUT /v1/sales-orders/by-number/{order_number}/status - Write
Update sales order status
Sets the sales order status directly. No transition guard is applied: any status may transition to any other status, including backward (e.g. `done` → `draft`). This mirrors core behavior. Recording stock through the transaction endpoints moves the status forward automatically: `confirmed` becomes `in-progress` once any quantity is recorded, and `done` once nothing remains; a `done` order is never reverted by later transaction changes.
PUT /v1/sales-orders/{order_id}/status - Write
Update a sales order
Partially updates a sales order. Omitted scalar fields are preserved; when `items` is provided it replaces the full line list.
PUT /v1/sales-orders/{order_id} - Destructive
Delete a sales order by order number
Looks up a sales order by order number and deletes it: the order itself is soft-deleted (no longer returned), but its line items and costs are permanently removed. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory. Whitespace is ignored and letters are uppercased.
DELETE /v1/sales-orders/by-number/{order_number} - Destructive
Delete a sales order
Deletes a sales order: the order itself is soft-deleted (no longer returned), but its line items and costs are permanently removed. A sales order that has returns cannot be deleted — delete its returns first. Linked stock transactions are NOT auto-reversed — delete them separately via `/v1/transactions/{tx_id}` if you need to restore inventory.
DELETE /v1/sales-orders/{order_id}
Teams
- Read
Get the linked team
Returns metadata for the team that owns the current API token (id, name, currency, mode). Use this to confirm the token's tenant and to check whether the team is in LOCATION mode.
GET /v1/teams/linked
Transactions
- Read
Get a transaction
Returns a single transaction with its full line items. Pass `revision` to fetch a specific historical version; omit it to fetch the latest.
GET /v1/transactions/{tx_id} - Read
List transactions
Returns a cursor-paginated list of inventory transactions (Stock In, Stock Out, Move Stock, Adjust Stock) without per-item detail. Items are ordered by `transaction_time` **descending** (latest first), then by id descending — overrides the shared "id ascending" default noted on the pagination schema. The `cursor` is the id of the last transaction on the page; the next page continues after that transaction's (`transaction_time`, id) position. Filter by `type` to narrow the result.
GET /v1/transactions - Write
Create a transaction
Records a new inventory transaction. Fields by type: Stock In/Out → `to_location_id` (optional `partner_id`/`tx_time`); Move Stock → `from_location_id` and `to_location_id` (optional `tx_time`); Adjust Stock → `to_location_id`. `to_location_id` may be omitted only when the team has exactly one active location, in which case it is filled in automatically. `partner_id` is rejected on Move Stock and Adjust Stock; `tx_time` is rejected on Adjust Stock and cannot be in the future. Each item may appear only once per transaction. Semantics: - Adjust Stock: `quantity` is a **relative** signed increment, not an absolute target. `quantity: 50` adds 50 to the current on-hand stock at the location. - Stock Out: stock is allowed to go negative; the API does not reject out-transactions that exceed the current on-hand quantity. - A team that is over any plan limit (items, locations, or members) gets `402` on stock writes until it upgrades or reduces usage.
POST /v1/transactions - Write
Update a transaction
Partially updates an existing transaction. Only the fields you include are changed; pass `items` to replace the entire line-item list, or `tx_time` to change the transaction's effective time (e.g. correct a shipment date). Provide `revision` to enforce optimistic concurrency. Type-specific rules from create still apply (`tx_time` is rejected on Adjust Stock). When `to_location_id` is omitted, the existing transaction's `to_location` is preserved (memo-only / partial updates are supported).
PUT /v1/transactions/{tx_id} - Destructive
Delete a transaction
Soft-deletes a transaction. Pass `revision` to enforce optimistic concurrency. Returns `404` if the transaction does not exist or was already deleted.
DELETE /v1/transactions/{tx_id}
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 28, 2026. Boxhero API docs.