Object IDs
Every object exposed by the API has an id made of a type prefix and a 22-character opaque
suffix:
br_2xKq8Fh3LmN9pQrT4vWy6ZThe prefix tells you at a glance what an ID points to — handy in logs, support tickets and spreadsheets. IDs are stable: an object keeps its ID for life.
| Prefix | Object |
|---|---|
org_ | Workspace (organization) |
br_ | Brand |
mkt_ | Market of a brand |
loc_ | Establishment of a local brand |
qry_ | Tracked query (prompt) |
smp_ | Sampling — one measurement cycle of the AI models |
csync_ | Catalogue synchronization |
alrt_ | Alert |
task_ | Task of the fixes backlog |
prod_ | Product |
var_ | Product variant |
comp_ | Tracked competitor |
ord_ | Attributed order |
sheet_ | Product identity sheet |
wb_ | Write-back — copy or barcodes written in the store |
evt_ | Event |
we_ | Webhook endpoint |
whd_ | Webhook delivery attempt |
key_ | API key |
req_ | API request (see the Request-Id header) |
Rules
- Treat IDs as opaque strings. Do not parse the suffix; its format may change.
- Store them as strings of up to 255 characters.
- An ID of the wrong type is a missing resource. Passing
alrt_…where a task is expected returns404resource_missing.
Last updated on