Skip to content

store

Version: v1 Scope: per-tenant (one per store) Owning service: link-registry

A store represents a physical retail location within a tenant. It is the top-level organizational unit under which all ESLs, links, and item data are grouped. The store DTO carries the internal system identifier, an optional external identifier used by the retailer's back-office systems, and a flag indicating whether the store acts as a reference store (typically used for template or master data).

ID pattern

t/{tenantid}/s/{storeid}

  • t/{tenantid} — tenant namespace; all store records are scoped to a single tenant
  • s/{storeid} — the internal store identifier assigned by the platform

Schema

Field Type Description
id string Primary ID following the pattern t/{tenantid}/s/{storeid}
external_id string External identifier for this store as assigned by the retailer's back-office or ERP system
is_reference_store bool When true, this store is a reference/master store used as a source for template data rather than a live retail location

Aliases

by_externalid

t/{tenantid}/s/{externalid}

Alias expression: t/{tenantid}/s/{.external_id}

Allows looking up a store by the retailer's own external identifier rather than the platform's internal storeid. This is the primary lookup path for integrations that receive data keyed by the retailer's store codes.

Consumed by

Service Why
link-registry Maintains the store record; validates tenant/store scope for all link and ESL operations
studio-link-evaluator Resolves store context when evaluating communication packs against item data
pricer-server Uses store scope to route ESL image transmissions to the correct on-premise gateway
  • storeesl — ESL devices assigned to this store; keyed under t/{tenantid}/s/{storeid}/esls/{barcode}
  • link — links between items and ESLs; keyed under t/{tenantid}/s/{storeid}/links/{linkid}
  • storeeslstatus — runtime operational status for each ESL in this store