Sample: your items × your chains as /offers rows
For each search term (items) and each chain, the top 3 current offers in search-relevance order, as the same rows GET /offers returns. Item × chain pairs with nothing on offer are listed explicitly in not_on_offer — an empty per_chain array is not an error. Counts as one request against the key's quota. Cached for 5 minutes (Cache-Control public, s-maxage=300, stale-while-revalidate=600).
Request
- Base URL: https://api.shelfatlas.com
- URL: https://api.shelfatlas.com/api/v1/public/catalog/offers/sample
- Auth: HTTP bearer
Query parameters
Comma-separated search terms, 1–12, each 2–64 chars, e.g. mælk,æg,ris. Duplicate terms are collapsed to one.
Comma-separated chain slugs, 1–3, e.g. netto,rema. Duplicate chains are collapsed to one; an unknown or inactive slug returns 404 chain_not_found.
Response
Offers per item and chain, plus the pairs with nothing on offer.
Changes
No recorded changes to this operation across all 1 revision of this API.