Restrict
Check restricted goods
Check items against import/export prohibitions and restrictions for a shipping lane.
POST
Requires the
restrict:read scope.
Checks each item against the import rules of the destination country
and — when origin_country is given — the export rules of the origin,
plus any custom rules your
organization has defined. Every request is logged for compliance evidence
(see Restrict history).
Returns 403 when restricted-goods checks are not enabled for the
destination country.
string
required
Ship-to country (ISO alpha-2) — its import rules are checked.
string
Ship-from country (ISO alpha-2) — its export rules are checked when
given.
array
required
1–100 items. All item fields are optional, but prefix rules need an
hs_code and keyword rules need text (title / description /
materials / category / brand):sku— your line reference (up to 100 chars), echoed backtitle— up to 500 charsdescription— up to 2000 charshs_code— 4–10 digits, dots allowed (e.g.0805.50.40.00)country_of_origin— ISO alpha-2 country of manufacture; drives origin-scoped rulesmaterials— up to 500 charscategory— up to 200 charsbrand— up to 200 chars
Response
Your reference for this call is theX-Request-Id response header (a
UUIDv7) — quote it to support or look it up via
GET /api/requests to retrieve the
archived original payload.
array
One entry per item, echoing
sku, title, description, hs_code,
and country_of_origin (each null when not sent), plus
restrictions — null for a clean item, otherwise an array of matches:id—restriction_<n>(platform rule) ororg_rule_<n>(your rule)source—platformororghs_code— the rule’s HS prefix (nullfor keyword/origin rules)imposing_country_code— the country whose rule matchedmeasure_direction—IMPORTorEXPORTrule_type—prohibition,restriction, orobservationtitle,summaryagency— the regulating agency (e.g.FDA),nullfor org rulesagency_flag— the agency’s flag code (e.g. an HTS PGA flag), when the source dataset carries onerequirement—required,may_be_required, ornullsource_url,source_ref— where the rule comes fromconfidence—HIGH(exact/under-prefix HS match, origin rule) orMEDIUM(item code shallower than the rule’s, or keyword match)
number
Total restrictions matched across all items.
boolean
true when any match is a prohibition.boolean
true when any match is a restriction.number
Processing time in milliseconds.