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.
https://rest.boxhero-app.com/v1/transactions/{tx_id}Authorizations
Section titled “Authorizations”Bearer authentication header of the form Bearer <token>, where <token> is your API token.
Path parameters
Section titled “Path parameters”Query parameters
Section titled “Query parameters”Fetch a specific historical revision of this transaction. Omit to fetch the latest revision.
Responses
Section titled “Responses”200The requested transaction with line items.
An inventory transaction with its full line-item detail. Branch on type to narrow the variant (e.g. tx.type === 'move' makes tx.from_location available).
LocationTransactionIn
Transaction id.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
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.
Server-side creation timestamp.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Number of distinct items in the transaction.
Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
Web URL to view this transaction in the BoxHero app.
Free-text memo. Empty string when not set.
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.
Possible valuesin
Supplier on this Stock In transaction. null or absent when no partner was recorded.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Line items recorded by this transaction.
Show properties
Item id. Deprecated — prefer item.id.
Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.
Item SKU. Empty string when unset. Deprecated — prefer item.sku.
Item barcode. Empty string when unset. Deprecated — prefer item.barcode.
true when the item itself has since been deleted. Deprecated — prefer item.deleted.
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Signed quantity moved by this line. Positive for Stock In and Move Stock (the quantity arriving at the destination); negative for Stock Out; signed for Adjust Stock.
Source-location stock level for this item after the transaction. Set only on Move Stock.
Destination-location stock level for this item after the transaction.
Total on-hand quantity for this item across all locations after the transaction.
LocationTransactionOut
Transaction id.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
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.
Server-side creation timestamp.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Number of distinct items in the transaction.
Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
Web URL to view this transaction in the BoxHero app.
Free-text memo. Empty string when not set.
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.
Possible valuesout
Customer on this Stock Out transaction. null or absent when no partner was recorded.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Line items recorded by this transaction.
Show properties
Item id. Deprecated — prefer item.id.
Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.
Item SKU. Empty string when unset. Deprecated — prefer item.sku.
Item barcode. Empty string when unset. Deprecated — prefer item.barcode.
true when the item itself has since been deleted. Deprecated — prefer item.deleted.
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Signed quantity moved by this line. Positive for Stock In and Move Stock (the quantity arriving at the destination); negative for Stock Out; signed for Adjust Stock.
Source-location stock level for this item after the transaction. Set only on Move Stock.
Destination-location stock level for this item after the transaction.
Total on-hand quantity for this item across all locations after the transaction.
LocationTransactionMove
Transaction id.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
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.
Server-side creation timestamp.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Number of distinct items in the transaction.
Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
Web URL to view this transaction in the BoxHero app.
Free-text memo. Empty string when not set.
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.
Possible valuesmove
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Line items recorded by this transaction.
Show properties
Item id. Deprecated — prefer item.id.
Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.
Item SKU. Empty string when unset. Deprecated — prefer item.sku.
Item barcode. Empty string when unset. Deprecated — prefer item.barcode.
true when the item itself has since been deleted. Deprecated — prefer item.deleted.
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Signed quantity moved by this line. Positive for Stock In and Move Stock (the quantity arriving at the destination); negative for Stock Out; signed for Adjust Stock.
Source-location stock level for this item after the transaction. Set only on Move Stock.
Destination-location stock level for this item after the transaction.
Total on-hand quantity for this item across all locations after the transaction.
LocationTransactionAdjust
Transaction id.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
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.
Server-side creation timestamp.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Number of distinct items in the transaction.
Signed sum of quantity across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
Web URL to view this transaction in the BoxHero app.
Free-text memo. Empty string when not set.
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.
Possible valuesadjust
Line items recorded by this transaction.
Show properties
Item id. Deprecated — prefer item.id.
Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.
Item SKU. Empty string when unset. Deprecated — prefer item.sku.
Item barcode. Empty string when unset. Deprecated — prefer item.barcode.
true when the item itself has since been deleted. Deprecated — prefer item.deleted.
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Signed quantity moved by this line. Positive for Stock In and Move Stock (the quantity arriving at the destination); negative for Stock Out; signed for Adjust Stock.
Source-location stock level for this item after the transaction. Set only on Move Stock.
Destination-location stock level for this item after the transaction.
Total on-hand quantity for this item across all locations after the transaction.
400Team is not in LOCATION mode.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
401Missing or invalid API token.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
404No transaction with the given id (and revision, when supplied) was found in this team.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
Request
curl --request GET \ --url 'https://rest.boxhero-app.com/v1/transactions/{tx_id}' \ --header "Authorization: Bearer $BOXHERO_API_TOKEN"const response = await fetch("https://rest.boxhero-app.com/v1/transactions/{tx_id}", { method: "GET", headers: { Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://rest.boxhero-app.com/v1/transactions/{tx_id}", headers={ "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"], },)data = response.json()GET /v1/transactions/{tx_id} HTTP/1.1Host: rest.boxhero-app.comAuthorization: Bearer <token>Response
{ "item": { "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 } ] }}{ "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/12345"}{ "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/not-found", "title": "No transaction with the given id (and revision, when supplied) was found in this team.", "instance": "/transactions/12345"}{ "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a", "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2", "type": "/errors/too-many-requests", "title": "Too many requests.", "instance": "/transactions/12345", "retryAfter": 60}