Skip to Content
Object IDs

Object IDs

Every object exposed by the API has an id made of a type prefix and a 22-character opaque suffix:

br_2xKq8Fh3LmN9pQrT4vWy6Z

The 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.

PrefixObject
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 returns 404 resource_missing.
Last updated on