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.

GEThttps://rest.boxhero-app.com/v1/transactions

Xác thực

Authorizationstringbắt buộc

Header xác thực Bearer có dạng Bearer <token>, trong đó <token> là token API của bạn.

Tham số truy vấn

typestring

Filter by transaction type. Pass "in", "out", "move", or "adjust". Omit to list every type.

Giá trị có thể cóinoutmoveadjust

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

Phản hồi

200A page of transactions.

itemsarray of one ofbắt buộc

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

Một trong

SimpleLocationTransactionIn

idintegerminimum 0, maximum 2147483647bắt buộc

Transaction id.

to_locationEntitybắt buộc

Reference to a related entity (location, partner, or user) embedded in a transaction. The snapshot is captured at transaction time and does not update if the source entity is later renamed or removed.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

transaction_timestringdate-timebắt buộc

Effective time of the transaction. Defaults to the creation time if tx_time is omitted on create; change it later by passing tx_time on update.

created_atstringdate-timebắt buộc

Server-side creation timestamp.

created_byEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Number of distinct items in the transaction.

total_quantitynumberbắt buộc

Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.

urlstringuribắt buộc

Web URL to view this transaction in the BoxHero app.

memostringbắt buộc

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Optimistic-concurrency version. Increments on every update. Pass the current value to update/delete to detect concurrent edits — the operation returns 403 (/errors/invalid-request with code: tx-modify-revision-mismatch) if the value does not match the server.

typestringbắt buộc

Giá trị có thể cóin

partnerEntitynullable

Supplier on this Stock In transaction. null or absent when no partner was recorded.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

SimpleLocationTransactionOut

idintegerminimum 0, maximum 2147483647bắt buộc

Transaction id.

to_locationEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

transaction_timestringdate-timebắt buộc

Effective time of the transaction. Defaults to the creation time if tx_time is omitted on create; change it later by passing tx_time on update.

created_atstringdate-timebắt buộc

Server-side creation timestamp.

created_byEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Number of distinct items in the transaction.

total_quantitynumberbắt buộc

Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.

urlstringuribắt buộc

Web URL to view this transaction in the BoxHero app.

memostringbắt buộc

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

typestringbắt buộc

Giá trị có thể cóout

partnerEntitynullable

Customer on this Stock Out transaction. null or absent when no partner was recorded.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

SimpleLocationTransactionMove

idintegerminimum 0, maximum 2147483647bắt buộc

Transaction id.

to_locationEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

transaction_timestringdate-timebắt buộc

Effective time of the transaction. Defaults to the creation time if tx_time is omitted on create; change it later by passing tx_time on update.

created_atstringdate-timebắt buộc

Server-side creation timestamp.

created_byEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Number of distinct items in the transaction.

total_quantitynumberbắt buộc

Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.

urlstringuribắt buộc

Web URL to view this transaction in the BoxHero app.

memostringbắt buộc

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

typestringbắt buộc

Giá trị có thể cómove

from_locationEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

SimpleLocationTransactionAdjust

idintegerminimum 0, maximum 2147483647bắt buộc

Transaction id.

to_locationEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

transaction_timestringdate-timebắt buộc

Effective time of the transaction. Defaults to the creation time if tx_time is omitted on create; change it later by passing tx_time on update.

created_atstringdate-timebắt buộc

Server-side creation timestamp.

created_byEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

Display name of the entity at the time the transaction was recorded.

deletedbooleanbắt buộc

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Number of distinct items in the transaction.

total_quantitynumberbắt buộc

Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.

urlstringuribắt buộc

Web URL to view this transaction in the BoxHero app.

memostringbắt buộc

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

typestringbắt buộc

Giá trị có thể cóadjust

countintegerminimum 0, maximum 9007199254740991bắt buộc

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991bắt buộc

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullablebắt buộc

Cursor to pass as cursor in the next request. null when has_more is false.

has_morebooleanbắt buộc

True when another page is available. The cursor is monotonic — pass it as cursor on the next request to advance the page. Direction follows each resource’s ordering (default: id ascending).

400Team is not in LOCATION mode.

idstringbắt buộc

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

Giá trị có thể có/errors/not-found/errors/invalid-request/errors/invalid-team-mode/errors/tokens/invalid/errors/tokens/required/errors/too-many-requests/errors/core/usage-limit-exceeded/errors/core/forbidden/errors/core/unhandled/errors/unhandled

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. Pass an X-Correlation-Id request header to thread your trace through to ours.

instancestringbắt buộc

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. not-available-for-api-token on 403). Use this for fine-grained branching after dispatching on type.

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

401Missing or invalid API token.

idstringbắt buộc

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestringbắt buộc

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.

idstringbắt buộc

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestringbắt buộc

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

Yêu cầu

curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/transactions' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

const response = await fetch("https://rest.boxhero-app.com/v1/transactions", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://rest.boxhero-app.com/v1/transactions",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()

GET /v1/transactions HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

Phản hồi

{
  "items": [
    {
      "id": 14012345,
      "type": "in",
      "to_location": {
        "id": 47041,
        "name": "Warehouse",
        "deleted": false
      },
      "transaction_time": "2026-01-16T11:00:00.000Z",
      "created_at": "2026-01-16T11:00:00.000Z",
      "created_by": {
        "id": 1001,
        "name": "John Smith",
        "deleted": false
      },
      "count_of_items": 1,
      "total_quantity": 100,
      "url": "https://app.boxhero-app.com/transactions/14012345",
      "memo": "",
      "revision": 1,
      "partner": {
        "id": 431485,
        "name": "Acme Supply Co.",
        "deleted": false
      },
      "items": [
        {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false,
          "item": {
            "id": 14290445,
            "name": "Finish Setting Powder",
            "sku": "SKU-12345678",
            "barcode": "2097678335587",
            "deleted": false
          },
          "quantity": 100,
          "from_location_new_stock_level": null,
          "to_location_new_stock_level": 220,
          "new_stock_level": 220
        }
      ]
    }
  ],
  "count": 1,
  "limit": 100,
  "cursor": 14012345,
  "has_more": false
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-team-mode",
  "title": "This API is only available in Location mode. For Basic or Unit mode, please contact support.",
  "instance": "/transactions"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/transactions",
  "retryAfter": 60
}