Returns a list of batch transactions.

GET /inventory/batch-transactions

Group: Inventory › Batch Transactions · Operation ID: batchTransactions

This collection returns the same fields as GET inventory/batch-transactions/:id and POST inventory/batch-transactions/search. Nothing is withheld.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
batchNumberId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
batchNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
expirationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
transactionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
sourceDocumentLineType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, transactionDate, expirationDate, batchNumber, itemCode, locationCode, lastModifiedDate
Selectable: id, batchNumberId, batchNumber, expirationDate, transactionId, itemId, itemCode, itemName, locationId, locationCode, locationName, unitId, unitCode, transactionDate, inQuantity, outQuantity, unitInQuantity, unitOutQuantity, cost, valueDelta, currency, sourceDocumentLineType, lastModifiedDate

Response

200 Success

Under data, an array of batchTransactionsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the batch transaction line, not the ledger row. The ledger row's identifier is transactionId.
`batchNumberId`	string	no	The unique identifier for the batch that moved. See id on GET inventory/batch-numbers/:id.
`batchNumber`	string or null	no	The batch number as printed on the label, for example 'LOT-2026-08-14'. It is not unique across items.
`expirationDate`	string (date) or null	no	The date the batch expires. Format YYYY-MM-DD.
`transactionId`	string or null	no	The unique identifier for the ledger row this batch line belongs to. See id on GET inventory/inventory-transactions/:id.
`itemId`	string or null	no	The unique identifier for the item. See id on GET inventory/items/:id.
`itemCode`	string or null	no	The code of the item.
`itemName`	string or null	no	The display name of the item.
`locationId`	string or null	no	The unique identifier for the warehouse the movement was at. See id on GET inventory/warehouses/:id.
`locationCode`	string or null	no	The code of that warehouse.
`locationName`	string or null	no	The display name of that warehouse.
`unitId`	string or null	no	The unique identifier for the unit the movement was recorded in. See id on GET inventory/unit-of-measures/:id.
`unitCode`	string or null	no	The code of that unit, for example 'BOX'.
`transactionDate`	string (date) or null	no	The date the movement was posted. Format YYYY-MM-DD.
`inQuantity`	string (decimal) or null	no	The quantity of this batch that moved into stock, in the item's stocking unit.
`outQuantity`	string (decimal) or null	no	The quantity of this batch that moved out of stock, in the item's stocking unit.
`unitInQuantity`	string (decimal) or null	no	The same inbound movement in the transaction's own unit.
`unitOutQuantity`	string (decimal) or null	no	The same outbound movement in the transaction's own unit.
`cost`	string (decimal) or null	no	The unit cost of the batch at this movement, in the currency named by currency.
`valueDelta`	string (decimal) or null	no	The change in the batch's carried value at this movement, in the currency named by currency.
`currency`	string or null	no	The currency the cost fields are stated in. Format ISO 4217, for example 'USD'.
`sourceDocumentLineType`	string or null	no	The kind of document line that produced the movement.
`lastModifiedDate`	string (date-time) or null	no	The date and time the batch line last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error