Skip to main content
POST
Archive a lot template

Authorizations

X-API-Key
string
header
required

Path Parameters

template_id
string
required

Template id (UUID or 22-char shortuuid).

Response

OK

A saved generation recipe (latest version).

id
string
required

Template id (22-char shortuuid). Use in /lots/templates/{id}/ paths.

name
string
required

Human-readable template name.

target_field
enum<string>
required

Which GS1 field the identifiers populate.

Available options:
lot,
serial
format_string
string
required

Token format, e.g. LOT-{YYYY}{JJJ}-{####} renders as LOT-2026123-0001.

character_set
string
required

Alphabet identifier or literal characters. Defaults to GS1 AI 82.

check_digit_algorithm
enum<string>
required

Optional check character appended after token expansion.

Available options:
none,
mod10,
iso7064_11_2
reset_condition
enum<string>
required

When the counter resets to its starting value.

Available options:
never,
daily,
weekly,
monthly,
on_product_change,
on_count_reached,
manual
scope_kind
enum<string>
required

How the counter is partitioned (the scope_key shape).

Available options:
global,
per_product,
per_product_per_date_bucket,
tag
starting_value
integer
required

Counter value used after a reset (first sequence emitted).

max_collision_retries
integer
required

Soft-retry budget per identifier for random-source tokens before a hard collision.

version
integer
required

Current template version. Bumps on a format-affecting edit while in use.

is_archived
boolean
required

Archived templates cannot generate until unarchived.

created
string<date-time>
required

Creation timestamp (ISO-8601).

modified
string<date-time>
required

Last-modified timestamp (ISO-8601).

description
string
default:""

Optional free-text notes.

reset_threshold
integer | null

Counter value that triggers a reset when reset_condition=on_count_reached.

parent_template_id
string | null

Reserved for row-per-version chains; null in the current in-place versioning scheme.