PROBLEM TYPES
Every refusal, and what to do about it.
When the API refuses something, the response carries a machine-readable body with a
type address in it. That address is a page on this site, and this is the
list of them. Each one states the rule, names the likely cause, and says what to do.
There are 37, generated from the same registry the API answers from.
The request itself
The value sent was not the shape the endpoint accepts. Nothing was written.
Signing in and permissions
Who you are, which organisation you are acting for, and what your role allows.
Prefixes and claims
A GTIN identifies one product globally, so claiming one is a decision with somebody else on the other side of it.
Your catalogue
Products, SKUs and the states a product moves between.
Printing and artwork
The only refusals in the product that stop you outright. Everything else warns and lets you carry on — these five are the ones that cannot be undone once labels exist.
- DOMAIN_NEVER_LIVE This domain has never answered a request 409
- PRODUCT_ARCHIVED This product is archived 409
- PRODUCT_DRAFT This product is not published yet 409
- PRODUCT_TOMBSTONED This product has been permanently retired 409
- XDIM_BELOW_MINIMUM That module width is below the minimum for the chosen application 409
Links and resolution
Every rule here is one that makes a linkset conformant. They are refused when a link is created, because after printing they are refused by a phone.
- DEFAULT_NEEDS_TITLE A default link needs a title 400
- DEFAULT_SLOT_OCCUPIED This grain already has a default link 409
- DEFAULT_SLOT_REQUIRED This GTIN would be left with nowhere for plain scans to go 409
- LINK_LIMIT_REACHED This GTIN has reached its link limit 409
- LINK_TYPE_NOT_ASSIGNABLE That link type cannot hold a default slot 400
- PUBLISH_NEEDS_DEFAULT A published GTIN needs a destination for plain scans 409
- REORDER_SET_MISMATCH A reorder must name every link for this GTIN 400
- UNKNOWN_LINK_TYPE That is not a GS1 link type 400
Recall notices
Every refusal in this section is about the scope of a notice. None of them refuses the safety action itself, on any plan, in any billing state.
- DEFAULT_IN_RECALL_SCOPE That grain is inside an active recall's scope 409
- RECALL_ALREADY_ACTIVE This GTIN already has an active recall 409
- RECALL_HEAD_ORDER Recall links must stay at the head 409
- RECALL_LINK_LOCKED That link belongs to an active recall 409
- RECALL_NOT_ACTIVE That recall is no longer active 409
- RECALL_SCOPE_NARROWED A recall's scope can only widen 409
- RECALL_SCOPE_TOO_WIDE That many lots will not fit in one entry 409
Everything else
The two answers that carry no more specific meaning.