Skip to content

storeesl

Version: v1 Scope: per-tenant+store (one per physical ESL assigned to a store) Owning service: link-registry

A storeesl record represents a physical electronic shelf label that has been assigned to a specific store within a tenant. It is the logical registration of a device in a store: it records which ESL type (and therefore which screen dimensions and rendering capabilities) this barcode corresponds to, and which department it belongs to. The storeesl record is created when a device is onboarded and deleted when the device reaches the LOST or OFFBOARDED lifecycle state (as determined by the associated storeeslstatus).

ID pattern

t/{tenantid}/s/{storeid}/esls/{barcode}

  • t/{tenantid} — tenant namespace
  • s/{storeid} — store within the tenant; an ESL barcode is unique per store, not globally
  • esls/{barcode} — the ESL's barcode, typically the MAC address or hardware serial number used to identify the physical device

Schema

Field Type Description
id string Primary ID following the pattern t/{tenantid}/s/{storeid}/esls/{barcode}
esltype_id string Reference to the ESL type record. Format: esltypes/<id>. Determines screen resolution, color palette, and physical dimensions used during rendering
link_department string Department this ESL is assigned to. Used for organizational grouping and access control within the store

Consumed by

Service Why
link-registry Creates and deletes storeesl records as part of the ESL lifecycle; the presence of a storeesl record is the primary signal that an ESL is active in a store
studio-renderer Subscribes to storeesl.v1; uses esltype_id to determine the canvas size and color palette for rendering the design
pricer-server Subscribes to storeesl.v1; uses the record to register/unregister ESLs and route image transmissions to the correct physical device
  • store — the store this ESL belongs to
  • storeeslstatus — operational and lifecycle state of this ESL (owned by pricer-server; singleton at …/esls/{barcode}/status)
  • esltype — the ESL type referenced by esltype_id; defines resolution, palette, and physical dimensions
  • link — the link connecting this ESL to item(s) and a design; looked up via the by_storeesl alias