Properties
| Name | Type | Description |
|---|---|---|
| reading | object | |
| candidates | array | |
| items | array | SA-0179 slice 2 — every item the photo read, alongside the (first-priced-item) `reading`/`candidates` above kept for older clients. |
| image_key | string | The uploaded photo's Blob pathname — not yet accepted by `POST /api/v1/observations` (no image field there today); kept for a future observation-with-photo write. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/shelfatlas-com/json-schema/shelfatlas-com-shelf-label-read-result-schema.json",
"title": "ShelfLabelReadResult",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/shelfatlas-com-observations-api-openapi.yml#/components/schemas/ShelfLabelReadResult",
"type": "object",
"additionalProperties": false,
"required": [
"reading",
"candidates",
"items",
"image_key"
],
"properties": {
"reading": {
"$ref": "#/$defs/ShelfLabelReading"
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/$defs/ShelfLabelCandidate"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/ShelfPhotoReadItem"
},
"description": "SA-0179 slice 2 — every item the photo read, alongside the (first-priced-item) `reading`/`candidates` above kept for older clients."
},
"image_key": {
"type": "string",
"description": "The uploaded photo's Blob pathname — not yet accepted by `POST /api/v1/observations` (no image field there today); kept for a future observation-with-photo write."
}
},
"$defs": {
"ShelfLabelCandidate": {
"type": "object",
"additionalProperties": false,
"required": [
"ean",
"name"
],
"properties": {
"ean": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
}
}
},
"ShelfLabelReading": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"price_cents",
"ean",
"confidence",
"reason"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"price_cents": {
"type": [
"integer",
"null"
],
"description": "DKK×100."
},
"ean": {
"type": [
"string",
"null"
]
},
"confidence": {
"type": "number",
"description": "0.0–1.0 as judged by the vision model."
},
"reason": {
"type": [
"string",
"null"
],
"enum": [
"unreadable",
null
],
"description": "`unreadable` when the label was read but not usable; null on a good read."
}
}
},
"ShelfPhotoPrintedUnitPrice": {
"type": "object",
"additionalProperties": false,
"required": [
"value",
"per"
],
"properties": {
"value": {
"type": "number",
"description": "The label's own printed unit price, e.g. 10.73 for \"1 L = 10,73\"."
},
"per": {
"type": "string",
"enum": [
"l",
"kg"
]
}
}
},
"ShelfPhotoReadItem": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"brand",
"size_text",
"quantity_unit",
"volume_ml",
"unit_count",
"price_cents",
"spot",
"printed_unit_price",
"max_per_customer",
"ean",
"confidence",
"tier",
"known_product",
"candidates"
],
"description": "One item read from a shelf photo (SA-0179) — \"same action as reading a leaflet page\": ONE photo can return MANY items, each independently matched to the catalog.",
"properties": {
"name": {
"type": "string"
},
"brand": {
"type": [
"string",
"null"
]
},
"size_text": {
"type": [
"string",
"null"
]
},
"quantity_unit": {
"type": [
"string",
"null"
],
"enum": [
"ml",
"g",
"pcs",
null
]
},
"volume_ml": {
"type": [
"number",
"null"
],
"description": "ONE unit size, never the pack total."
},
"unit_count": {
"type": [
"integer",
"null"
]
},
"price_cents": {
"type": [
"integer",
"null"
],
"description": "DKK×100. Null when no shelf-edge price label was legible for this item — never invented."
},
"spot": {
"type": "boolean",
"description": "True when the shelf label is marked as a spot/campaign price."
},
"printed_unit_price": {
"anyOf": [
{
"$ref": "#/$defs/ShelfPhotoPrintedUnitPrice"
},
{
"type": "null"
}
]
},
"max_per_customer": {
"type": [
"integer",
"null"
],
"description": "A printed purchase cap (\"Maks. N stk.\"), never a pack count."
},
"ean": {
"type": [
"string",
"null"
]
},
"confidence": {
"type": "number",
"description": "0.0–1.0 as judged by the vision model."
},
"tier": {
"type": "string",
"enum": [
"sure",
"check"
],
"description": "`sure` when ≥2 independent vision calls agreed on this item (pre-selected); `check` otherwise."
},
"known_product": {
"anyOf": [
{
"$ref": "#/$defs/ShelfLabelCandidate"
},
{
"type": "null"
}
]
},
"matched_by": {
"type": [
"string",
"null"
],
"enum": [
"ean",
"auto",
"offer",
null
],
"description": "How the item was matched (SA-0179): its own EAN, the size-aware product auto-match, or the store's chain's current campaign offer (then `offer` is set and `known_product` is null)."
},
"offer": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"raw_name",
"price_cents"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"raw_name": {
"type": "string"
},
"price_cents": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/$defs/ShelfLabelCandidate"
}
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/shelfatlas-com-shelf-label-read-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.