Skip to main content
GET
Scope: batches:read. A paginated list (items, total, page, pageSize); see Requests and responses.
string
draft, signing, at_printer, printed or revoked. Any other value is ignored.
string
gs1_signed or private_code. Any other value is ignored.
string
Matches part of the batch number, the product name or the lot. A full serial finds the batch it was issued in.
string
created, product, quantity, status or number; prefix with - for descending (-quantity). Without it, or with any other value, newest first.
integer
default:"1"
integer
default:"20"
Up to 200.
Each item:
string
required
The batch number, such as B-1045. Use it with Get a batch.
string
required
string
required
string
The product’s GTIN-14, when it has one.
string
required
gs1_signed or private_code.
string
required
Where the codes are checked: online, offline or both. See Verification modes.
integer
required
string
required
draft, signing, at_printer, printed or revoked.
object
The batch’s first and last serial. Absent on drafts.
string
string
YYYY-MM-DD; expiryDate likewise.
string
Where the batch may be sold. Absent when it may be sold everywhere.
string
required
The print line’s name; empty when the files are printed outside Satyakod.
string
The key that signed the serials. Absent on drafts.
integer
required
Scans of this batch’s codes so far.
object
required
id, name and email; {"id": "system", "name": "System", "email": ""} when no person created it.
string
required
ISO 8601; updatedAt likewise.
string
When codes were revoked. revokedRange (first, last) is the range revoked, when only part of the batch was, and revokedCount how many serials are revoked (the whole batch or the range).
Also signedCodes (true when each code also carries a signature that can be checked offline) and designId (the Private Code design, on private_code batches).