Register GS1 company prefix(es) (closes the GS1 gate)
POST/api/v1/companies/me/gs1-prefixes
Required scope: dpp:draft:write. A WRITE (HMAC + Idempotency-Key).
ADD semantics — the provided prefixes are merged into your company's
existing set (deduped). Each prefix must be 4-12 digits. Registering at
least one prefix closes the gs1_prefix_not_registered publish gate that
otherwise blocks every paid-plan publish. Returns the resulting set.
Request
Responses
- 201
- 400
- 401
- 403
- 422
- 429
- 503
Registered
400 — INVALID_JSON, VALIDATION_ERROR, or IDEMPOTENCY_KEY_REQUIRED.
401 — INVALID_SIGNATURE or SIGNING_NOT_CONFIGURED (or bearer auth failure).
403 — missing scope (FORBIDDEN_SCOPE) or module (FORBIDDEN_MODULE).
A prefix is not 4-12 digits (GS1_PREFIX_INVALID).
429 — RATE_LIMITED (per-key limit, reads and writes alike; fails closed,
so a limiter outage also returns 429). A limiter-down 429 is deliberately
indistinguishable from a quota 429. Carries Retry-After (seconds).
Response Headers
Seconds to wait before retrying (429 only).
Per-minute request ceiling for this key's tier.
Requests left in the current window (floored at 0).
Seconds until the window resets.
503 — the API is not enabled on this environment (FEATURE_DISABLED).