> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/ja/developers/api/reference/transactions.md).

# 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`.

## 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).

次のいずれか

- `id` (integer, minimum 0, maximum 2147483647, 必須): Transaction id.
- `to_location` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `transaction_time` (string, date-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_at` (string, date-time, 必須): Server-side creation timestamp.
- `created_by` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `count_of_items` (integer, minimum -9007199254740991, maximum 9007199254740991, 必須): Number of distinct items in the transaction.
- `total_quantity` (number, 必須): Signed sum of `quantity` across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
- `url` (string, uri, 必須): Web URL to view this transaction in the BoxHero app.
- `memo` (string, 必須): Free-text memo. Empty string when not set.
- `revision` (integer, minimum -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.
- `type` (string, 必須): 指定可能な値: `in`
- `partner` (Entity, nullable): Supplier on this Stock In transaction. `null` or absent when no partner was recorded.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `items` (array of LocationTransactionItem, 必須): Line items recorded by this transaction.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Item id. **Deprecated** — prefer `item.id`.
  - `name` (string, 必須): Item display name at the time of the transaction (snapshot). **Deprecated** — prefer `item.name`.
  - `sku` (string, 必須): Item SKU. Empty string when unset. **Deprecated** — prefer `item.sku`.
  - `barcode` (string, 必須): Item barcode. Empty string when unset. **Deprecated** — prefer `item.barcode`.
  - `deleted` (boolean, 必須): `true` when the item itself has since been deleted. **Deprecated** — prefer `item.deleted`.
  - `item` (ExtendedItemEntity, 必須): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

    - `id` (integer, minimum 0, maximum 2147483647, 必須): Item or bundle id.
    - `name` (string, 必須): Display name.
    - `sku` (string, 必須): SKU. Empty string when unset.
    - `barcode` (string, 必須): Barcode. Empty string when unset.
    - `deleted` (boolean, 必須): Whether the underlying item or bundle is deleted.
  - `quantity` (number, 必須): 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_level` (number): Source-location stock level for this item **after** the transaction. Set only on Move Stock.
  - `to_location_new_stock_level` (number, 必須): Destination-location stock level for this item **after** the transaction.
  - `new_stock_level` (number, 必須): Total on-hand quantity for this item across all locations **after** the transaction.

- `id` (integer, minimum 0, maximum 2147483647, 必須): Transaction id.
- `to_location` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `transaction_time` (string, date-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_at` (string, date-time, 必須): Server-side creation timestamp.
- `created_by` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `count_of_items` (integer, minimum -9007199254740991, maximum 9007199254740991, 必須): Number of distinct items in the transaction.
- `total_quantity` (number, 必須): Signed sum of `quantity` across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
- `url` (string, uri, 必須): Web URL to view this transaction in the BoxHero app.
- `memo` (string, 必須): Free-text memo. Empty string when not set.
- `revision` (integer, minimum -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.
- `type` (string, 必須): 指定可能な値: `out`
- `partner` (Entity, nullable): Customer on this Stock Out transaction. `null` or absent when no partner was recorded.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `items` (array of LocationTransactionItem, 必須): Line items recorded by this transaction.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Item id. **Deprecated** — prefer `item.id`.
  - `name` (string, 必須): Item display name at the time of the transaction (snapshot). **Deprecated** — prefer `item.name`.
  - `sku` (string, 必須): Item SKU. Empty string when unset. **Deprecated** — prefer `item.sku`.
  - `barcode` (string, 必須): Item barcode. Empty string when unset. **Deprecated** — prefer `item.barcode`.
  - `deleted` (boolean, 必須): `true` when the item itself has since been deleted. **Deprecated** — prefer `item.deleted`.
  - `item` (ExtendedItemEntity, 必須): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

    - `id` (integer, minimum 0, maximum 2147483647, 必須): Item or bundle id.
    - `name` (string, 必須): Display name.
    - `sku` (string, 必須): SKU. Empty string when unset.
    - `barcode` (string, 必須): Barcode. Empty string when unset.
    - `deleted` (boolean, 必須): Whether the underlying item or bundle is deleted.
  - `quantity` (number, 必須): 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_level` (number): Source-location stock level for this item **after** the transaction. Set only on Move Stock.
  - `to_location_new_stock_level` (number, 必須): Destination-location stock level for this item **after** the transaction.
  - `new_stock_level` (number, 必須): Total on-hand quantity for this item across all locations **after** the transaction.

- `id` (integer, minimum 0, maximum 2147483647, 必須): Transaction id.
- `to_location` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `transaction_time` (string, date-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_at` (string, date-time, 必須): Server-side creation timestamp.
- `created_by` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `count_of_items` (integer, minimum -9007199254740991, maximum 9007199254740991, 必須): Number of distinct items in the transaction.
- `total_quantity` (number, 必須): Signed sum of `quantity` across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
- `url` (string, uri, 必須): Web URL to view this transaction in the BoxHero app.
- `memo` (string, 必須): Free-text memo. Empty string when not set.
- `revision` (integer, minimum -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.
- `type` (string, 必須): 指定可能な値: `move`
- `from_location` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `items` (array of LocationTransactionItem, 必須): Line items recorded by this transaction.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Item id. **Deprecated** — prefer `item.id`.
  - `name` (string, 必須): Item display name at the time of the transaction (snapshot). **Deprecated** — prefer `item.name`.
  - `sku` (string, 必須): Item SKU. Empty string when unset. **Deprecated** — prefer `item.sku`.
  - `barcode` (string, 必須): Item barcode. Empty string when unset. **Deprecated** — prefer `item.barcode`.
  - `deleted` (boolean, 必須): `true` when the item itself has since been deleted. **Deprecated** — prefer `item.deleted`.
  - `item` (ExtendedItemEntity, 必須): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

    - `id` (integer, minimum 0, maximum 2147483647, 必須): Item or bundle id.
    - `name` (string, 必須): Display name.
    - `sku` (string, 必須): SKU. Empty string when unset.
    - `barcode` (string, 必須): Barcode. Empty string when unset.
    - `deleted` (boolean, 必須): Whether the underlying item or bundle is deleted.
  - `quantity` (number, 必須): 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_level` (number): Source-location stock level for this item **after** the transaction. Set only on Move Stock.
  - `to_location_new_stock_level` (number, 必須): Destination-location stock level for this item **after** the transaction.
  - `new_stock_level` (number, 必須): Total on-hand quantity for this item across all locations **after** the transaction.

- `id` (integer, minimum 0, maximum 2147483647, 必須): Transaction id.
- `to_location` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `transaction_time` (string, date-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_at` (string, date-time, 必須): Server-side creation timestamp.
- `created_by` (Entity, 必須): 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.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Id of the referenced entity.
  - `name` (string, 必須): Display name of the entity at the time the transaction was recorded.
  - `deleted` (boolean, 必須): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
- `count_of_items` (integer, minimum -9007199254740991, maximum 9007199254740991, 必須): Number of distinct items in the transaction.
- `total_quantity` (number, 必須): Signed sum of `quantity` across every item in the transaction. For Move Stock, the sum of the quantities moved to the destination.
- `url` (string, uri, 必須): Web URL to view this transaction in the BoxHero app.
- `memo` (string, 必須): Free-text memo. Empty string when not set.
- `revision` (integer, minimum -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.
- `type` (string, 必須): 指定可能な値: `adjust`
- `items` (array of LocationTransactionItem, 必須): Line items recorded by this transaction.

  - `id` (integer, minimum 0, maximum 2147483647, 必須): Item id. **Deprecated** — prefer `item.id`.
  - `name` (string, 必須): Item display name at the time of the transaction (snapshot). **Deprecated** — prefer `item.name`.
  - `sku` (string, 必須): Item SKU. Empty string when unset. **Deprecated** — prefer `item.sku`.
  - `barcode` (string, 必須): Item barcode. Empty string when unset. **Deprecated** — prefer `item.barcode`.
  - `deleted` (boolean, 必須): `true` when the item itself has since been deleted. **Deprecated** — prefer `item.deleted`.
  - `item` (ExtendedItemEntity, 必須): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

    - `id` (integer, minimum 0, maximum 2147483647, 必須): Item or bundle id.
    - `name` (string, 必須): Display name.
    - `sku` (string, 必須): SKU. Empty string when unset.
    - `barcode` (string, 必須): Barcode. Empty string when unset.
    - `deleted` (boolean, 必須): Whether the underlying item or bundle is deleted.
  - `quantity` (number, 必須): 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_level` (number): Source-location stock level for this item **after** the transaction. Set only on Move Stock.
  - `to_location_new_stock_level` (number, 必須): Destination-location stock level for this item **after** the transaction.
  - `new_stock_level` (number, 必須): Total on-hand quantity for this item across all locations **after** the transaction.

例

```json
{
  "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
    }
  ]
}
```

## エンドポイント

- [List transactions](https://www.boxhero.io/docs/ja/developers/api/reference/transactions/list-transactions) `GET /v1/transactions`
- [Create a transaction](https://www.boxhero.io/docs/ja/developers/api/reference/transactions/create-transaction) `POST /v1/transactions`
- [Get a transaction](https://www.boxhero.io/docs/ja/developers/api/reference/transactions/get-transaction) `GET /v1/transactions/{tx_id}`
- [Update a transaction](https://www.boxhero.io/docs/ja/developers/api/reference/transactions/update-transaction) `PUT /v1/transactions/{tx_id}`
- [Delete a transaction](https://www.boxhero.io/docs/ja/developers/api/reference/transactions/delete-transaction) `DELETE /v1/transactions/{tx_id}`