Skip to main content
POST
Render barcodes for many lots and serials

Authorizations

X-API-Key
string
header
required

Path Parameters

gtin
string<gtin>
required

GTIN barcode (8, 12, 13 or 14 digits), normalized to GTIN-14 for lookup.

Required string length: 8 - 14
Pattern: ^[0-9]{8}$|^[0-9]{12,14}$

Body

application/json

A batch of the product's lots and serials, rendered with one set of options.

items
(BulkLotItem · object | BulkSerialItem · object)[]
required

1 to 5000 records.

Required array length: 1 - 5000 elements

One stored lot of the product to render.

Example:
format
enum<string>
default:svg

Image format. Which formats a symbology writes is published as x-closient-symbology-formats; qr also writes tif, datamatrix writes svg, png and pdf, the linear symbologies svg, png, pdf and eps.

Available options:
svg,
png,
pdf,
eps,
tif
Example:

"svg"

size
integer | null

QR only: side length in pixels, or SVG/PDF/EPS user units, when xdim_mm is not set. Default 400.

Required range: 50 <= x <= 2000
xdim_mm
number | null

X-dimension (narrowest module) in millimetres. QR: sizes the symbol physically. Linear symbologies: the bar module width, default 0.33. DataMatrix: only with composed HRI. Composed HRI on qr or datamatrix requires it.

Required range: 0.1 <= x <= 10
dpi
integer | null

PNG resolution, 300 or 600. QR: only with xdim_mm. DataMatrix: always. Linear symbologies: only with composed HRI. Default 300.

Required range: 300 <= x <= 600Must be a multiple of 300
bar_height_mm
number | null

Linear symbologies only: bar height in millimetres, for the bare symbol. Default 25.

Required range: 1 <= x <= 100
cmyk
boolean | null

QR with format=eps only: CMYK process colours instead of RGB, for the bare symbol.

write_text
boolean | null

Linear symbologies only (gs1_128, gs1_databar_expanded, ean13, ean8, upca, itf14), for the bare symbol: print the human-readable text under the bars. Default true. With a composed HRI the preset owns the text.

font_size
number | null

Linear symbologies only, for the bare symbol: human-readable text size in points. The renderer has two sizes: below 8 prints compact text, 8 and above standard. Default 10. Not with write_text=false.

Required range: 4 <= x <= 24
embed_font
boolean | null

Linear symbologies only, for the bare symbol, with format=svg or pdf: embed the OCR-B text glyphs in the file, so it renders the same without the font installed. Default true. Not with write_text=false.

quiet_zone
boolean | null

gs1_128 only, for the bare symbol: leave the standard 6.5 mm quiet zone around the bars. Default true. The other linear symbologies always print their own quiet zone marks.

hri_preset
string | null

Name of a saved HRI preset to compose human-readable text around the symbol (qr, datamatrix, gs1_128, gs1_databar_expanded). Without it the organization's default preset applies when the request can take it: xdim_mm set (or a linear symbology), a format other than tif, and none of size, cmyk, bar_height_mm, write_text, font_size, embed_font or quiet_zone.

Maximum string length: 128
Pattern: ^[^\x00]{0,}$
symbology
enum<string> | null

Symbology. Default qr.

Available options:
qr,
datamatrix,
gs1_128,
gs1_databar_expanded
Example:

"qr"

Response

Accepted

An accepted bulk job.

job
string
required

The job handle; poll it at poll_url.

status
enum<string>
required

The job's state; pending until a worker picks it up.

Available options:
pending,
running,
completed,
failed
Example:

"pending"

items
integer
required

How many records the job renders.

poll_url
string
required

Where to poll for the job's state and its ZIP.