Create routing rule
curl --request POST \
--url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gtin": "09506000134352",
"match_values": [
"L2406A",
"L2406B"
],
"name": "Recalled lots to landing page",
"param_overrides": {
"utm_campaign": "recall-{lot}"
},
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST"
}
'import requests
url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules"
payload = {
"gtin": "09506000134352",
"match_values": ["L2406A", "L2406B"],
"name": "Recalled lots to landing page",
"param_overrides": { "utm_campaign": "recall-{lot}" },
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST"
}
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({
gtin: '09506000134352',
match_values: ['L2406A', 'L2406B'],
name: 'Recalled lots to landing page',
param_overrides: {utm_campaign: 'recall-{lot}'},
path_override: '/lot-notice',
predicate_kind: 'LOT_LIST'
})
};
fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules', 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/resolver/api/v1/organizations/{organization_id}/routing-rules",
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([
'gtin' => '09506000134352',
'match_values' => [
'L2406A',
'L2406B'
],
'name' => 'Recalled lots to landing page',
'param_overrides' => [
'utm_campaign' => 'recall-{lot}'
],
'path_override' => '/lot-notice',
'predicate_kind' => 'LOT_LIST'
]),
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/resolver/api/v1/organizations/{organization_id}/routing-rules"
payload := strings.NewReader("{\n \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\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/resolver/api/v1/organizations/{organization_id}/routing-rules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules")
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 \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2026-06-01T09:00:00Z",
"effective": true,
"gtin": "09506000134352",
"id": "a1b2c3d4e5f6",
"is_active": true,
"match_values": [
"L2406A",
"L2406B"
],
"modified": "2026-06-19T14:30:00Z",
"name": "Recalled lots to landing page",
"organization_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"param_overrides": {
"utm_campaign": "recall-{lot}"
},
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST",
"priority": 100
}{
"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"
}Routing rules
Create routing rule
Create a conditional routing rule on one of the organization’s products. A rule decorates the redirect the resolver already chose (query parameters and/or the path, never the host) when a scan matches its predicate. Authoring is not tier-gated: on a product without the Enhanced ROUTING_RULES capability the rule is saved but inert (effective is false) until the product is Enhanced. A value the model refuses (predicate shape, override shape, an off-host path, more than 50 rules on a product) is 422. Requires CONTRIBUTE: a read-only key gets 403.
POST
/
resolver
/
api
/
v1
/
organizations
/
{organization_id}
/
routing-rules
Create routing rule
curl --request POST \
--url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gtin": "09506000134352",
"match_values": [
"L2406A",
"L2406B"
],
"name": "Recalled lots to landing page",
"param_overrides": {
"utm_campaign": "recall-{lot}"
},
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST"
}
'import requests
url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules"
payload = {
"gtin": "09506000134352",
"match_values": ["L2406A", "L2406B"],
"name": "Recalled lots to landing page",
"param_overrides": { "utm_campaign": "recall-{lot}" },
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST"
}
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({
gtin: '09506000134352',
match_values: ['L2406A', 'L2406B'],
name: 'Recalled lots to landing page',
param_overrides: {utm_campaign: 'recall-{lot}'},
path_override: '/lot-notice',
predicate_kind: 'LOT_LIST'
})
};
fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules', 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/resolver/api/v1/organizations/{organization_id}/routing-rules",
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([
'gtin' => '09506000134352',
'match_values' => [
'L2406A',
'L2406B'
],
'name' => 'Recalled lots to landing page',
'param_overrides' => [
'utm_campaign' => 'recall-{lot}'
],
'path_override' => '/lot-notice',
'predicate_kind' => 'LOT_LIST'
]),
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/resolver/api/v1/organizations/{organization_id}/routing-rules"
payload := strings.NewReader("{\n \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\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/resolver/api/v1/organizations/{organization_id}/routing-rules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/routing-rules")
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 \"gtin\": \"09506000134352\",\n \"match_values\": [\n \"L2406A\",\n \"L2406B\"\n ],\n \"name\": \"Recalled lots to landing page\",\n \"param_overrides\": {\n \"utm_campaign\": \"recall-{lot}\"\n },\n \"path_override\": \"/lot-notice\",\n \"predicate_kind\": \"LOT_LIST\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2026-06-01T09:00:00Z",
"effective": true,
"gtin": "09506000134352",
"id": "a1b2c3d4e5f6",
"is_active": true,
"match_values": [
"L2406A",
"L2406B"
],
"modified": "2026-06-19T14:30:00Z",
"name": "Recalled lots to landing page",
"organization_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"param_overrides": {
"utm_campaign": "recall-{lot}"
},
"path_override": "/lot-notice",
"predicate_kind": "LOT_LIST",
"priority": 100
}{
"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
Path Parameters
UUID of the organization that owns the rules.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
application/json
Payload to create a routing rule.
The GTIN of one of the organization's products.
Maximum string length:
14Pattern:
^[^\x00]{0,14}$Operator-facing label (max 100 characters).
Maximum string length:
100Pattern:
^[^\x00]{0,100}$What the rule matches: DATE_WINDOW (the scanned use-by or best-before date falls in the window), LOT_LIST (the scanned lot, AI 10, is in match_values) or SERIAL_SET (the scanned serial, AI 21, is in match_values).
Available options:
DATE_WINDOW, LOT_LIST, SERIAL_SET Lower priorities are evaluated first and the first matching rule wins (0 to 32767, default 100).
Required range:
0 <= x <= 32767DATE_WINDOW: inclusive start (YYYY-MM-DD); null for no lower bound.
DATE_WINDOW: inclusive end (YYYY-MM-DD); null for no upper bound.
LOT_LIST or SERIAL_SET: the lot or serial values to match, one entry each.
Pattern:
^[^\x00]{0,}$Query parameters to set on the redirect when the rule matches: a flat map of string keys to string values. Values may use tokens such as {gtin} and {lot}.
Show child attributes
Show child attributes
A same-host absolute path to swap into the destination when the rule matches (for example /spring-sale); empty keeps the destination's path. Must start with a single '/'.
Maximum string length:
500Pattern:
^[^\x00]{0,500}$Response
Created
A routing rule as read from the API.
URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$The GTIN of the product this rule decorates.
Operator-facing label (max 100 characters).
Lower priorities are evaluated first and the first matching rule wins (0 to 32767, default 100).
What the rule matches: DATE_WINDOW (the scanned use-by or best-before date falls in the window), LOT_LIST (the scanned lot, AI 10, is in match_values) or SERIAL_SET (the scanned serial, AI 21, is in match_values).
Available options:
DATE_WINDOW, LOT_LIST, SERIAL_SET LOT_LIST or SERIAL_SET: the lot or serial values to match, one entry each.
Query parameters to set on the redirect when the rule matches: a flat map of string keys to string values. Values may use tokens such as {gtin} and {lot}.
Show child attributes
Show child attributes
A same-host absolute path to swap into the destination when the rule matches (for example /spring-sale); empty keeps the destination's path. Must start with a single '/'.
Whether the rule is switched on. A deactivated rule is never evaluated.
Whether the rule can change a scan: true only when it is active and its product has the Enhanced ROUTING_RULES capability. A rule on a product without it is saved but inert; read this back after a write.
UUID of the organization that owns the product.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ISO-8601 creation timestamp.
ISO-8601 last-modified timestamp.
DATE_WINDOW: inclusive start (YYYY-MM-DD); null for no lower bound.
DATE_WINDOW: inclusive end (YYYY-MM-DD); null for no upper bound.