Skip to main content
GET
Render a GS1 document's barcode

Authorizations

X-API-Key
string
header
required

Path Parameters

document_id
string<shortuuid>
required

ID of the document.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

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

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

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

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

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

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

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

hri_preset
string

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 or bar_height_mm.

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

Symbology.

Available options:
qr,
datamatrix,
gs1_128
Example:

"qr"

Response

OK

The response is of type file.