Returns a list of serial numbers.

GET /inventory/serial-numbers

Group: Inventory › Serial Numbers · Operation ID: serialNumbers

This collection omits cost, originalCost, afterSaleCost and currency. Read those from GET inventory/serial-numbers/:id or POST inventory/serial-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
serialNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
manufacturerSerialNumber — 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
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isSold — 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
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, serialNumber, expirationDate, lastModifiedDate
Selectable: id, serialNumber, manufacturerSerialNumber, itemId, itemCode, itemName, locationId, locationCode, locationName, entityId, inStock, isSold, lastCostChangeDate, expirationDate, entryDate, active, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of serialNumbersRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the serial number.
`serialNumber`	string or null	no	The serial number assigned to the unit when it was received. It cannot be changed.
`manufacturerSerialNumber`	string or null	no	The manufacturer's own serial number for the unit, where it differs from the assigned serial number.
`itemId`	string or null	no	The unique identifier for the item this unit 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 unit. 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.
`entityId`	string or null	no	The unique identifier for the legal entity the unit belongs to. See id on GET base/entities.
`inStock`	string (decimal) or null	no	1 while the unit is on hand, 0 once it has gone.
`isSold`	boolean or null	no	Whether the unit has been sold.
`lastCostChangeDate`	string (date) or null	no	The date the unit's cost last changed. Format YYYY-MM-DD.
`expirationDate`	string (date) or null	no	The date the unit expires. Format YYYY-MM-DD.
`entryDate`	string (date) or null	no	The date the unit entered the warehouse. Format YYYY-MM-DD.
`active`	boolean or null	no	Whether the serial number can be selected on new documents.
`createdDate`	string (date-time) or null	no	The date and time the serial number record was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the serial number 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