Search raw offer titles, grouped by product or item key
Danish full-text + typo-tolerant (trigram) search over raw catalog-offer titles, grouped by the curated product when one is known and otherwise by a stable item key. key is OPAQUE — p:<product_id> or k:<item_key> — compare it, never parse it. item_key is the group's persisted item identity and is what you pass to GET /offers/history. Supplying lat+lng adds the nearest store per chain and its shelf-status, and orders offers by a worth-the-trip score.
Request
- Base URL: https://api.shelfatlas.com
- URL: https://api.shelfatlas.com/api/v1/public/catalog/offers/search
- Auth: HTTP bearer
Query parameters
Search text, e.g. "pepsi max".
Latitude. Must be given together with lng.
Longitude. Must be given together with lat.
Search radius around lat/lng in km.
Offers per page (groups may be fewer).
Opaque keyset cursor from a previous page's next_cursor.
How groups (and offers within a group) are ordered. score (default): worth-the-trip deal order — savings, price, nearby stock. relevance: search rank, so an ingredient query lands on the item itself rather than on the best deal that merely mentions it; use this when matching a shopping list or recipe.
Response
Groups of offers matching the query.
Changes
No recorded changes to this operation across all 1 revision of this API.