Skip to main content
GET
Get product resolver behavior

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

ID of the organization. Caller must have VIEW.

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

GTIN-8, GTIN-12, GTIN-13, or GTIN-14 digits (no separators) with a valid GS1 check digit. Normalized to GTIN-14 for lookup; the product must belong to one of the organization's brands.

Required string length: 8 - 14

Response

OK

A product's resolver state and its per-GTIN resolver behavior.

gtin
string
required

Normalized GTIN-14 (zero-padded).

product_name
string
required

Product name, for display.

resolver_enabled
boolean
required

Whether the product is enrolled in the resolver (its billable unit). While false, its lots and serials are not billable either, whatever their own flags say, and enhanced resolution cannot be on. Scans of the product resolve either way.

enhanced_resolution_enabled
boolean
required

Whether the product is on the paid enhanced tier, which unlocks expiry behavior and the strict serial policy. Requires the resolver to be on.

expiry_behavior
enum<string>
required

What a scan carrying a past use-by (AI 17) or best-before (AI 15) date gets: NONE forwards it unchanged, NOTICE shows a past-date notice, REDIRECT sends it to expiry_redirect_url. Only acted on while enhanced resolution is on.

Available options:
NONE,
NOTICE,
REDIRECT
expiry_redirect_url
string
required

Destination for an expired scan when expiry_behavior is REDIRECT; empty otherwise.

serial_policy
enum<string>
required

PERMISSIVE falls back to the deepest available page for an unknown serial; STRICT shows an unverified-unit page. Only acted on while enhanced resolution is on.

Available options:
PERMISSIVE,
STRICT
age_restricted
boolean
required

Whether scans of this product pass an 18+ age gate first.

resolver_enabled_at
string<date-time> | null

When the resolver was last turned on for this product; null if never.

shelf_life_offset_days
integer | null

Days from manufacture to the printed date; null when not configured.

shelf_life_offset_ai
enum<string> | null

Which printed date the offset produces: 15 best-before or 17 use-by; null when not set.

Available options:
15,
17