Skip to main content
GET
List lot runs

Authorizations

X-API-Key
string
header
required

Query Parameters

status
string | null

Comma-separated LotRunStatus values to include.

product
string | null

Filter to a product's runs by GTIN.

template
string | null

Filter to a template's runs by id.

created_by
string | null

Filter to a creator's runs by user id.

created_after
string<date-time> | null

Only runs created at/after this ISO-8601 timestamp.

created_before
string<date-time> | null

Only runs created at/before this ISO-8601 timestamp.

limit
integer
default:50

Max results (1-200).

Required range: 1 <= x <= 200
offset
integer
default:0

Result offset for paging.

Required range: x >= 0

Response

OK

id
string
required

Run id (22-char shortuuid). Use in /lots/runs/{id}/ paths.

template_id
string
required

Template this run generated against.

template_version
integer
required

Template version pinned at generation time.

scope_key
string
required

Counter scope key derived from the template's scope_kind.

gtin
string
required

GTIN of the product the generated lots belong to.

quantity
integer
required

Number of identifiers requested.

status
enum<string>
required

Lifecycle state of the run.

Available options:
queued,
generating,
reserved,
committed,
discarded,
failed_collision
generated_ids
string[]
required

Denormalized list of identifiers rendered by this run.

soft_collision_count
integer
required

Random-source retries that resolved during generation.

hard_collisions
HardCollisionOut · object[]
required

Populated only on failed_collision runs; empty otherwise.

created
string<date-time>
required

Creation timestamp (ISO-8601).

first_id
string | null

First identifier in the reserved block; null until reserved.

last_id
string | null

Last identifier in the reserved block; null until reserved.

counter_state_before
integer | null

Counter value (post-reset) before this run advanced it.

counter_state_after
integer | null

Counter value after this run; null on failed_collision.

chunks_done
integer | null

Async progress: chunks written so far.

chunks_total
integer | null

Async progress: total chunks the run will write.

created_by_id
string | null

User id that created the run; null if the user was deleted.

queued_at
string<date-time> | null

When the async run was enqueued.

generating_started_at
string<date-time> | null

When the worker began generating.

committed_at
string<date-time> | null

When the run was committed.

discarded_at
string<date-time> | null

When the run was discarded.

failed_at
string<date-time> | null

When the run failed on a hard collision.

discard_mode
enum<string> | null

rollback or burn on a discarded run; null otherwise.

Available options:
rollback,
burn
discard_reason
string
default:""

Free-text reason recorded when the run was discarded.