Generate a single GS1 DataMatrix
curl --request POST \
--url https://www.closient.com/products/api/v1/datamatrix/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"expiry": "270630",
"format": "svg",
"gtin": "00012345678905",
"lot": "LOT-A001",
"serial": "SN-0001"
}
'import requests
url = "https://www.closient.com/products/api/v1/datamatrix/"
payload = {
"expiry": "270630",
"format": "svg",
"gtin": "00012345678905",
"lot": "LOT-A001",
"serial": "SN-0001"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expiry: '270630',
format: 'svg',
gtin: '00012345678905',
lot: 'LOT-A001',
serial: 'SN-0001'
})
};
fetch('https://www.closient.com/products/api/v1/datamatrix/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/products/api/v1/datamatrix/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expiry' => '270630',
'format' => 'svg',
'gtin' => '00012345678905',
'lot' => 'LOT-A001',
'serial' => 'SN-0001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/products/api/v1/datamatrix/"
payload := strings.NewReader("{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/products/api/v1/datamatrix/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/datamatrix/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}"
response = http.request(request)
puts response.read_body<string>{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Codes
Generate a single GS1 DataMatrix
Render a GS1 DataMatrix for a GTIN plus any subset of (lot, serial, expiry). At least one of lot or serial is required. Returns image bytes (image/svg+xml, image/png, or application/pdf).
HRI (C-5840): pass hri (inline options), hri_preset (a saved preset name), or neither — in which case the calling organization’s default preset applies, if one is set. Composing HRI requires xdim_mm; the HRI text follows the encoding order (01), (17), (10), (21).
Caching: responses are deterministic given the request body. The endpoint sets Cache-Control: public, max-age=2592000 (30 days) and a strong ETag over the image bytes. When a named or default preset supplies the HRI configuration the response is cached private instead. Clients sending If-None-Match with a matching ETag get 304 Not Modified.
POST
/
products
/
api
/
v1
/
datamatrix
/
Generate a single GS1 DataMatrix
curl --request POST \
--url https://www.closient.com/products/api/v1/datamatrix/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"expiry": "270630",
"format": "svg",
"gtin": "00012345678905",
"lot": "LOT-A001",
"serial": "SN-0001"
}
'import requests
url = "https://www.closient.com/products/api/v1/datamatrix/"
payload = {
"expiry": "270630",
"format": "svg",
"gtin": "00012345678905",
"lot": "LOT-A001",
"serial": "SN-0001"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expiry: '270630',
format: 'svg',
gtin: '00012345678905',
lot: 'LOT-A001',
serial: 'SN-0001'
})
};
fetch('https://www.closient.com/products/api/v1/datamatrix/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/products/api/v1/datamatrix/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expiry' => '270630',
'format' => 'svg',
'gtin' => '00012345678905',
'lot' => 'LOT-A001',
'serial' => 'SN-0001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/products/api/v1/datamatrix/"
payload := strings.NewReader("{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/products/api/v1/datamatrix/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/datamatrix/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiry\": \"270630\",\n \"format\": \"svg\",\n \"gtin\": \"00012345678905\",\n \"lot\": \"LOT-A001\",\n \"serial\": \"SN-0001\"\n}"
response = http.request(request)
puts response.read_body<string>{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Authorizations
APIKeyHeaderAuthOAuthTokenAuthCookieGatedSessionAuth
Body
application/json
Request body for synchronous GS1 DataMatrix generation.
GTIN (8/12/13/14 digits, normalized to GTIN-14).
Optional GS1 AI(10) lot/batch (1-20 printable ASCII).
Optional GS1 AI(21) serial (1-20 printable ASCII).
Optional GS1 AI(17) expiry as YYMMDD (e.g. '270630' for 2027-06-30).
Output image format. svg is the default scalable vector output; png is raster output; pdf is single-page vector PDF for print workflows (C-2852) — path operators in the content stream rather than a rasterised preview, so a print shop can scale to its target label size at the press.
Available options:
svg, png, pdf Target physical X-dimension (module width) in millimetres. Used only when an HRI configuration applies, where it is required — HRI legibility is evaluated against a physical size. The bare symbol ignores it.
Required range:
0.1 <= x <= 10Raster resolution for format='png' when HRI is composed — 300 or 600 dpi, the two resolutions the HRI print-export pipeline supports. Ignored for vector formats and when no HRI configuration applies.
Available options:
300, 600 Human Readable Interpretation configuration to compose onto the symbol (C-4395) — placement, layout, notation and typography. Takes precedence over hri_preset and the organization's default preset.
Show child attributes
Show child attributes
Example:
{
"enabled": true,
"layout": "single_line",
"notation": "bracketed_ai",
"placement": "below",
"pos_profile": false,
"typography": {
"alignment": "center",
"font_family": "OCR-B",
"font_size": 24,
"leading": 1.2
}
}
Name of a saved HRI preset (see POST /hri-presets/) to apply instead of specifying hri inline. Resolved against the calling organization; unknown names return 422. Ignored when hri is set.
Maximum string length:
128Response
OK
The response is of type file.