Skip to main content
POST
Dismiss a suggested recall scope

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
recall_id
string<shortuuid>
required

Identifier of the recall.

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

GTIN of your affected product.

Required string length: 8 - 14
Pattern: ^[0-9]{8}$|^[0-9]{12,14}$
scope_id
string<shortuuid>
required

Identifier of the suggested scope.

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

Response

OK

A scope on a recall for one of your products, confirmed or suggested.

id
string<shortuuid>
required

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: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
kind
string
required

DATE_WINDOW, LOT_LIST, SERIAL_SET or PRODUCTION_SITE.

status
string
required

CONFIRMED scopes narrow the live recall verdict. SUGGESTED is a regulator-fed draft that narrows nothing until you confirm it.

is_active
boolean
required

False once deactivated or dismissed; kept for audit, never deleted.

values
string[]
required

Lot, serial or production-site GLN values; empty for a date window.

date_ai
string
required

Printed-date AI (15 or 17) of a date window; empty otherwise.

note
string
required

Free-text note on the scope.

pack_date_start
string<date> | null

Inclusive start of a date window.

pack_date_end
string<date> | null

Inclusive end of a date window.

confidence_score
number | null

Extraction confidence from 0.0 to 1.0 for a suggestion; null for a scope you authored.