Returns the serial number with the given identifier.

GET /inventory/serial-numbers/{id}

Group: Inventory › Serial Numbers · Operation ID: getSerialNumber

Returns the same fields as POST inventory/serial-numbers/search. The collection GET inventory/serial-numbers omits cost, originalCost, afterSaleCost and currency.

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.
id path string yes The unique identifier for the serial number to return.

Response

200 Success

Under data (getSerialNumberOutput):

Field Type Required Description
id string yes The unique identifier for the serial number.
serialNumber string no The serial number assigned to the unit when it was received. It cannot be changed.
manufacturerSerialNumber string no The manufacturer's own serial number for the unit, where it differs from the assigned serial number.
itemId string no The unique identifier for the item this unit is of. See id on GET inventory/items/:id.
itemCode string no The code of that item.
itemName string no The display name of that item.
locationId string no The unique identifier for the warehouse holding the unit. See id on GET inventory/warehouses/:id.
locationCode string no The code of that warehouse.
locationName string no The display name of that warehouse.
entityId string no The unique identifier for the legal entity the unit belongs to. See id on GET base/entities.
inStock string (decimal) no 1 while the unit is on hand, 0 once it has gone.
isSold boolean no Whether the unit has been sold.
cost string (decimal) no The value the unit is carried at, in the currency named by currency.
originalCost string (decimal) no The value the unit was carried at when it arrived, in the currency named by currency.
afterSaleCost string (decimal) no The value of the unit after it was sold, in the currency named by currency.
currency string no The currency the cost fields are stated in. Format ISO 4217, for example 'USD'.
lastCostChangeDate string (date) no The date the unit's cost last changed. Format YYYY-MM-DD.
expirationDate string (date) no The date the unit expires. Format YYYY-MM-DD.
entryDate string (date) no The date the unit entered the warehouse. Format YYYY-MM-DD.
active boolean no Whether the serial number can be selected on new documents.
createdDate string (date-time) no The date and time the serial number record was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the serial number record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses