Observations

Read a shelf label's price/name/EAN from a photo (SA-0165)

One vision call: uploads the given photo and reads the shelf-edge label's name, price, EAN and stock hint, then returns catalog products matching what was read (the EAN if legible, otherwise a name search) as candidates. image_key is the uploaded photo's Blob pathname — not yet accepted by POST /api/v1/observations (which has no image field), kept for a future observation-with-photo write. An unreadable label is still a 200: reading.reason is unreadable and candidates is empty — it consumed the vision call same as a readable one, it just has nothing to offer. Only an infra failure (Blob or the vision deployment unavailable) is a 503.

post/api/v1/public/catalog/shelf-label/read

Request

  • Base URL: https://api.shelfatlas.com
  • URL: https://api.shelfatlas.com/api/v1/public/catalog/shelf-label/read
  • Auth: HTTP bearer

Request body

image_base64string required

Base64-encoded image bytes (no data: URL prefix). Decoded size over 512 KB is a 413 — downscale client-side first.

content_type'image/jpeg' | 'image/png' | 'image/webp' required
store_idstring uuid

Optional (SA-0179): the store the photo was taken in. Lets an item with no product be matched to that store's chain's current campaign offer (matched_by: offer).

Response

The reading, any matching catalog candidates, and the uploaded photo key.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.