shelfatlas-com · Schema
ObservationRequest
Exactly one of `ean` or `offer_id` is required — the other is omitted.
CompanyGroceryDenmarkRetail
Properties
| Name | Type | Description |
|---|---|---|
| ean | string | EAN/GTIN of a curated product. Required if offer_id is omitted. |
| offer_id | string | A CatalogOffer id. Required if ean is omitted. |
| store_id | string | |
| stock_status | string | |
| price_cents | integer | The observed price, in cents. |
| currency | string | |
| consent_tier | string | |
| reporter_clerk_id | string | Attributes the observation to an end-user your surface has already verified server-side. Honoured only for API-key auth. |
| device_token | string | Vouches for an anonymous end-user's device id instead of a Clerk id. Honoured only for API-key auth, and mutually exclusive with reporter_clerk_id. |
| observed_at | string | When the shelf was actually seen, for a report submitted after the fact (e.g. a next-day follow-up) instead of the request's own "now". Must not be more than 5 minutes in the future (clock-skew allowa |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/shelfatlas-com/json-schema/shelfatlas-com-observation-request-schema.json",
"title": "ObservationRequest",
"description": "Exactly one of `ean` or `offer_id` is required — the other is omitted.",
"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/ObservationRequest",
"type": "object",
"additionalProperties": false,
"required": [
"store_id",
"stock_status"
],
"oneOf": [
{
"required": [
"ean"
]
},
{
"required": [
"offer_id"
]
}
],
"properties": {
"ean": {
"type": "string",
"minLength": 1,
"description": "EAN/GTIN of a curated product. Required if offer_id is omitted."
},
"offer_id": {
"type": "string",
"format": "uuid",
"description": "A CatalogOffer id. Required if ean is omitted."
},
"store_id": {
"type": "string",
"format": "uuid"
},
"stock_status": {
"type": "string",
"enum": [
"in_stock",
"low_stock",
"out_of_stock"
]
},
"price_cents": {
"type": "integer",
"minimum": 1,
"description": "The observed price, in cents."
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"default": "DKK"
},
"consent_tier": {
"type": "string",
"enum": [
"anonymous_aggregate",
"identifiable"
],
"default": "anonymous_aggregate"
},
"reporter_clerk_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Attributes the observation to an end-user your surface has already verified server-side. Honoured only for API-key auth."
},
"device_token": {
"type": "string",
"format": "uuid",
"description": "Vouches for an anonymous end-user's device id instead of a Clerk id. Honoured only for API-key auth, and mutually exclusive with reporter_clerk_id."
},
"observed_at": {
"type": "string",
"format": "date-time",
"description": "When the shelf was actually seen, for a report submitted after the fact (e.g. a next-day follow-up) instead of the request's own \"now\". Must not be more than 5 minutes in the future (clock-skew allowance) or more than 48 hours in the past; omit to stamp the current time, unchanged from before this field existed."
}
}
}
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-observation-request"
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.