Returns a list of serial transactions.

GET /inventory/serial-transactions

Group: Inventory › Serial Transactions · Operation ID: serialTransactions

This collection returns the full item schema, the same fields get and search return. Page size defaults to 25, up to a maximum of 100.

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
serialNumberId — 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
expirationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entryDate — 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
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, entryDate, expirationDate, serialNumber, itemCode, locationCode, lastModifiedDate
Selectable: id, serialNumberId, serialNumber, manufacturerSerialNumber, expirationDate, entryDate, isSold, transactionId, itemId, itemCode, itemName, locationId, locationCode, locationName, transactionDate, inQuantity, outQuantity, cost, currency, sourceDocumentLineType, lastModifiedDate

Response

200 Success

Under data, an array of serialTransactionsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the serial transaction line. This is a different record from the ledger row (transactionId) and the unit (serialNumberId).
`serialNumberId`	string	no	The unique identifier for the serial number that moved. See id on GET inventory/serial-numbers/:id.
`serialNumber`	string or null	no	The serial number stamped on the unit, for example 'SN-000412'.
`manufacturerSerialNumber`	string or null	no	The manufacturer's own serial number for the unit, where one is recorded.
`expirationDate`	string (date) or null	no	The date the unit expires, from the serial record. Format YYYY-MM-DD.
`entryDate`	string (date) or null	no	The date the unit entered inventory, from the serial record. Format YYYY-MM-DD.
`isSold`	boolean or null	no	Whether the unit has since been sold. This is a current property of the unit, not of this movement, so a receipt line shows true once the unit is later sold.
`transactionId`	string or null	no	The unique identifier for the ledger row this serial line belongs to. See id on GET inventory/inventory-transactions/:id.
`itemId`	string or null	no	The unique identifier for the item that moved, from the ledger row, not the unit's current item. 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 location the movement was posted at, from the ledger row, not where the unit is now. See id on GET inventory/warehouses/:id.
`locationCode`	string or null	no	The code of that location.
`locationName`	string or null	no	The display name of that location.
`transactionDate`	string (date) or null	no	The date the movement was posted. Format YYYY-MM-DD.
`inQuantity`	string (decimal) or null	no	The quantity into stock for this movement. It is 1 when the movement received the unit and 0 otherwise.
`outQuantity`	string (decimal) or null	no	The quantity out of stock for this movement. It is 1 when the movement issued the unit and 0 otherwise.
`cost`	string (decimal) or null	no	The cost of the unit at this movement, in the currency named by currency.
`currency`	string or null	no	The currency the cost is stated in. Format ISO 4217, for example 'USD'.
`sourceDocumentLineType`	string or null	no	The kind of document line that produced the movement, from the ledger row. Possible values: 'IMInventorySalesOrderLine', 'IMInventorySalesDeliveryLine', 'IMSalesOrderLine', 'IMInventoryPurchaseReturnLine', 'IMInventorySalesReturnLine', 'IMWarehouseTransferLine', 'IMInventoryDecreaseLine', 'IMInventoryIncreaseLine', 'IMInventoryRevaluationLine', 'IMInventoryTransferLine', 'IMInventoryAdjustmentLine', 'IMInventoryCountLine', 'IMInventoryPutAwayTask', 'IMInventoryPurchaseReturnReversal', 'PurchaseOrderLine', 'IMLandedCostAllocationLine', 'SalesOrderProductItem', 'IMWarehouseTransferOrderLine', 'VendorBillItemBase', 'InvPurchaseDeliveryLine'.
`lastModifiedDate`	string (date-time) or null	no	The date and time the serial 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