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.

GEThttps://rest.boxhero-app.com/v1/transactions/{tx_id}

การยืนยันสิทธิ์

Authorizationstringจำเป็น

เฮดเดอร์การยืนยันตัวตนแบบ Bearer ในรูปแบบ Bearer <token> โดย <token> คือ โทเค็น API ของคุณ

พารามิเตอร์ของพาธ

tx_idintegerminimum 0, maximum 2147483647จำเป็น

พารามิเตอร์ของคิวรี

revisionintegermaximum 9007199254740991

Fetch a specific historical revision of this transaction. Omit to fetch the latest revision.

การตอบกลับ

200The requested transaction with line items.

itemone 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

idintegerminimum 0, maximum 2147483647จำเป็น

Transaction id.

to_locationEntityจำเป็น

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.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

transaction_timestringdate-timeจำเป็น

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-timeจำเป็น

Server-side creation timestamp.

created_byEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

Number of distinct items in the transaction.

total_quantitynumberจำเป็น

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

urlstringuriจำเป็น

Web URL to view this transaction in the BoxHero app.

memostringจำเป็น

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

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.

typestringจำเป็น

ค่าที่เป็นไปได้in

partnerEntitynullable

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

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

itemsarray of LocationTransactionItemจำเป็น

Line items recorded by this transaction.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item id. Deprecated — prefer item.id.

namestringจำเป็น

Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.

skustringจำเป็น

Item SKU. Empty string when unset. Deprecated — prefer item.sku.

barcodestringจำเป็น

Item barcode. Empty string when unset. Deprecated — prefer item.barcode.

deletedbooleanจำเป็น

true when the item itself has since been deleted. Deprecated — prefer item.deleted.

itemExtendedItemEntityจำเป็น

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item or bundle id.

namestringจำเป็น

Display name.

skustringจำเป็น

SKU. Empty string when unset.

barcodestringจำเป็น

Barcode. Empty string when unset.

deletedbooleanจำเป็น

Whether the underlying item or bundle is deleted.

quantitynumberจำเป็น

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.

from_location_new_stock_levelnumber

Source-location stock level for this item after the transaction. Set only on Move Stock.

to_location_new_stock_levelnumberจำเป็น

Destination-location stock level for this item after the transaction.

new_stock_levelnumberจำเป็น

Total on-hand quantity for this item across all locations after the transaction.

LocationTransactionOut

idintegerminimum 0, maximum 2147483647จำเป็น

Transaction id.

to_locationEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

transaction_timestringdate-timeจำเป็น

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-timeจำเป็น

Server-side creation timestamp.

created_byEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

Number of distinct items in the transaction.

total_quantitynumberจำเป็น

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

urlstringuriจำเป็น

Web URL to view this transaction in the BoxHero app.

memostringจำเป็น

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

typestringจำเป็น

ค่าที่เป็นไปได้out

partnerEntitynullable

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

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

itemsarray of LocationTransactionItemจำเป็น

Line items recorded by this transaction.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item id. Deprecated — prefer item.id.

namestringจำเป็น

Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.

skustringจำเป็น

Item SKU. Empty string when unset. Deprecated — prefer item.sku.

barcodestringจำเป็น

Item barcode. Empty string when unset. Deprecated — prefer item.barcode.

deletedbooleanจำเป็น

true when the item itself has since been deleted. Deprecated — prefer item.deleted.

itemExtendedItemEntityจำเป็น

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item or bundle id.

namestringจำเป็น

Display name.

skustringจำเป็น

SKU. Empty string when unset.

barcodestringจำเป็น

Barcode. Empty string when unset.

deletedbooleanจำเป็น

Whether the underlying item or bundle is deleted.

quantitynumberจำเป็น

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.

from_location_new_stock_levelnumber

Source-location stock level for this item after the transaction. Set only on Move Stock.

to_location_new_stock_levelnumberจำเป็น

Destination-location stock level for this item after the transaction.

new_stock_levelnumberจำเป็น

Total on-hand quantity for this item across all locations after the transaction.

LocationTransactionMove

idintegerminimum 0, maximum 2147483647จำเป็น

Transaction id.

to_locationEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

transaction_timestringdate-timeจำเป็น

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-timeจำเป็น

Server-side creation timestamp.

created_byEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

Number of distinct items in the transaction.

total_quantitynumberจำเป็น

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

urlstringuriจำเป็น

Web URL to view this transaction in the BoxHero app.

memostringจำเป็น

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

typestringจำเป็น

ค่าที่เป็นไปได้move

from_locationEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

itemsarray of LocationTransactionItemจำเป็น

Line items recorded by this transaction.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item id. Deprecated — prefer item.id.

namestringจำเป็น

Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.

skustringจำเป็น

Item SKU. Empty string when unset. Deprecated — prefer item.sku.

barcodestringจำเป็น

Item barcode. Empty string when unset. Deprecated — prefer item.barcode.

deletedbooleanจำเป็น

true when the item itself has since been deleted. Deprecated — prefer item.deleted.

itemExtendedItemEntityจำเป็น

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item or bundle id.

namestringจำเป็น

Display name.

skustringจำเป็น

SKU. Empty string when unset.

barcodestringจำเป็น

Barcode. Empty string when unset.

deletedbooleanจำเป็น

Whether the underlying item or bundle is deleted.

quantitynumberจำเป็น

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.

from_location_new_stock_levelnumber

Source-location stock level for this item after the transaction. Set only on Move Stock.

to_location_new_stock_levelnumberจำเป็น

Destination-location stock level for this item after the transaction.

new_stock_levelnumberจำเป็น

Total on-hand quantity for this item across all locations after the transaction.

LocationTransactionAdjust

idintegerminimum 0, maximum 2147483647จำเป็น

Transaction id.

to_locationEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

transaction_timestringdate-timeจำเป็น

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-timeจำเป็น

Server-side creation timestamp.

created_byEntityจำเป็น

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the referenced entity.

namestringจำเป็น

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

deletedbooleanจำเป็น

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

count_of_itemsintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

Number of distinct items in the transaction.

total_quantitynumberจำเป็น

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

urlstringuriจำเป็น

Web URL to view this transaction in the BoxHero app.

memostringจำเป็น

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991จำเป็น

typestringจำเป็น

ค่าที่เป็นไปได้adjust

itemsarray of LocationTransactionItemจำเป็น

Line items recorded by this transaction.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item id. Deprecated — prefer item.id.

namestringจำเป็น

Item display name at the time of the transaction (snapshot). Deprecated — prefer item.name.

skustringจำเป็น

Item SKU. Empty string when unset. Deprecated — prefer item.sku.

barcodestringจำเป็น

Item barcode. Empty string when unset. Deprecated — prefer item.barcode.

deletedbooleanจำเป็น

true when the item itself has since been deleted. Deprecated — prefer item.deleted.

itemExtendedItemEntityจำเป็น

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Item or bundle id.

namestringจำเป็น

Display name.

skustringจำเป็น

SKU. Empty string when unset.

barcodestringจำเป็น

Barcode. Empty string when unset.

deletedbooleanจำเป็น

Whether the underlying item or bundle is deleted.

quantitynumberจำเป็น

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.

from_location_new_stock_levelnumber

Source-location stock level for this item after the transaction. Set only on Move Stock.

to_location_new_stock_levelnumberจำเป็น

Destination-location stock level for this item after the transaction.

new_stock_levelnumberจำเป็น

Total on-hand quantity for this item across all locations after the transaction.

400Team is not in LOCATION mode.

idstringจำเป็น

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.

typestringจำเป็น

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

ค่าที่เป็นไปได้/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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

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.

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

401Missing or invalid API token.

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

404No transaction with the given id (and revision, when supplied) was found in this team.

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

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

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

คำขอ

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 os
import 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.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

การตอบกลับ

{
  "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
}