The retail feed · Ateliq docs

The retail feed is how head office tells a store's screens what to show: the store, its range, prices, stock, offers, initiatives, trends, concepts, sets, staff, services, sales settings, size charts and privacy contacts. Every screen in a store reads the same feed.

Endpoint and authentication

GET /api/launch/v1/retail/feed
Authorization: Bearer <kiosk key>

The screens send their store's kiosk key. The key alone identifies the store and workspace; nothing else is needed.

Response	Meaning
`200`	The feed.
`304`	Not changed since the version the screen holds.
`401`	The key is unknown or revoked.
`403` `store-paused` / `store-closed`	The store is paused or closed.
`403` `workspace_inactive`	The workspace is suspended, on a billing hold, or without Retail.

Shape

{
  "object": "retail_feed",
  "version": "…",
  "generatedAt": "…",
  "store":       { code, name, city, country, currency, timezone, languages, settings },
  "items":       [ … ],
  "offers":      [ … ],
  "initiatives": [ … ],
  "avatar":      { … },
  "trends":      [ … ],
  "concepts":    [ … ],
  "sets":        [ … ],
  "associates":  [ … ],
  "services":    [ … ],
  "sales":       { modes, holdHours, optIn },
  "sizeCharts":  [ … ],
  "privacy":     { contact, policyUrl, accessibilityContact, kept }
}

Part	What it carries
`items`	Each product the store shows: SKU, name, brand, category, type, colour, metal, audience, sizes, occasions, tags, images, try-on asset, price and currency, stock by size and in total, location, attributes, real size in millimetres, barcodes and size chart. Fit counts once a product has enough outcomes. For jewellery: metal, fineness, karat, purity label, weights, stones, hallmark, pricing, and for metal-rate pieces a price breakdown. When an offer applies: the offer price and the offers behind it.
`offers`	Live offers: id, name, kind and amounts, products, start and end, and stacking.
`initiatives`	Live initiatives: id, name, kind, dates, featured products, offers, stylist brief and banner.
`trends`	The latest approved trend board for the store's city.
`concepts`	Up to six approved design concepts.
`sets`	Up to 20 sets.
`associates`	Floor staff codes and first names.
`services`	Appointment services.
`sales`	Which hand-off ways the store offers, hold hours, and the opt-in channels, text and version.
`sizeCharts`	Verified charts used by the store's products.
`privacy`	Contacts, policy link, and what is kept and for how long.

What is never sent

Products that are hidden, not carried, invisible in the store, or not priced in the store's currency.
Metal-rate pieces whose rate is missing, older than 48 hours, or for another market.
Making charges and the stones value as separate figures.
Offer codes, and offers that need a code.
Draft or unapproved trend boards, concepts, offers and initiatives.
Draft size charts.

Versioning

version is a fingerprint of everything the screens show. It changes whenever anything the screens show changes, and not otherwise.
It is returned as the ETag. A screen sends If-None-Match with the version it holds, and gets 304 Not Modified when nothing has changed.
object: "retail_feed" marks the document type. There is no separate schema version; new fields are added without removing old ones.
Screens report the feed version they hold, and its age, in their heartbeat. A copy older than six hours raises an alert in Devices.

On the screens

Ateliq's screens read the feed every two minutes. When nothing has changed, the check costs almost nothing. The screens keep the last good copy and use it if head office can't be reached, and an empty feed never wipes the catalogue.

Other kiosk endpoints

The same kiosk key is used for the screens' other calls to head office: sending kiosk events, appointment slots and bookings, hand-offs (create, mark paid, cancel), and shoppers' opt-ins. Each group is limited to 30 calls a minute per key, with bodies up to 32 KB.

Something missing or unclear? Write to pb@ateliq.co and we will answer and fix this page. Last reviewed 12 November 2026.