Transactions
Inventory transactions: Stock In, Stock Out, Move Stock, and Adjust Stock.
Each transaction is immutable except via update or delete with a matching revision.
Đối tượng LocationTransaction
Phần tiêu đề “Đối tượng LocationTransaction”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).
one of
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Giá trị có thể cóin
Supplier on this Stock In transaction. null or absent when no partner was recorded.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Giá trị có thể cóout
Customer on this Stock Out transaction. null or absent when no partner was recorded.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Giá trị có thể cómove
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
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Giá trị có thể cóadjust
Line items recorded by this transaction.
Hiển thị thuộc tính
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.
Hiển thị thuộc tính
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.
Ví dụ
{ "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 } ]}Endpoint
Phần tiêu đề “Endpoint”- List transactions
GET /v1/transactions - Create a transaction
POST /v1/transactions - Get a transaction
GET /v1/transactions/{tx_id} - Update a transaction
PUT /v1/transactions/{tx_id} - Delete a transaction
DELETE /v1/transactions/{tx_id}