Returns a list of batches.

GET /inventory/batch-numbers

Group: Inventory › Batch Numbers · Operation ID: batchNumbers

This collection omits cost, originalCost and currency. Read those from GET inventory/batch-numbers/:id or POST inventory/batch-numbers/search.

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
batchNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
manufacturerBatchNumber — 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
locationId — 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
batchStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
temperatureBreach — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
qcStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — 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, batchNumber, expirationDate, batchStatus, lastModifiedDate
Selectable: id, batchNumber, manufacturerBatchNumber, itemId, itemCode, itemName, locationId, locationCode, locationName, quantity, inStock, expirationDate, manufactureDate, bestBeforeDate, entryDate, batchStatus, temperatureBreach, qcStatus, active, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of batchNumbersRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the batch.
`batchNumber`	string or null	no	The batch number assigned when the stock was received. It cannot be changed.
`manufacturerBatchNumber`	string or null	no	The manufacturer's own batch reference for this batch, where it differs from the assigned batch number.
`itemId`	string or null	no	The unique identifier for the item this batch is of. See id on GET inventory/items/:id.
`itemCode`	string or null	no	The code of that item.
`itemName`	string or null	no	The display name of that item.
`locationId`	string or null	no	The unique identifier for the warehouse holding the batch. 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.
`quantity`	string (decimal) or null	no	The quantity that arrived in the batch.
`inStock`	string (decimal) or null	no	The quantity still on hand. A status of 'QUARANTINED' or 'EXPIRED' does not reduce it.
`expirationDate`	string (date) or null	no	The date the batch expires. Format YYYY-MM-DD.
`manufactureDate`	string (date) or null	no	The date the batch was made. Format YYYY-MM-DD.
`bestBeforeDate`	string (date) or null	no	The best-before date printed on the batch, which may differ from the expiry. Format YYYY-MM-DD.
`entryDate`	string (date) or null	no	The date the batch entered the warehouse. Format YYYY-MM-DD.
`batchStatus`	string or null	no	The status of the batch. Possible values: 'ACTIVE', 'QUARANTINED', 'EXPIRED', 'DISPOSED'. Only 'ACTIVE' stock can be picked, and none of the other three values reduces the quantity on hand.
`temperatureBreach`	boolean or null	no	Whether the batch has been outside its storage temperature range.
`qcStatus`	string or null	no	The tenant's own quality-control state for the batch. This is free text.
`active`	boolean or null	no	Whether the batch can be selected on new documents.
`createdDate`	string (date-time) or null	no	The date and time the batch record was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the batch record 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