Product Search API
BetaPOST /products/search
The Product Search API takes a shopping query, such as “wireless mouse”, and returns up to 40 products ranked by relevance to it, each with a title, a link to the store and, where known, a price and a picture. Unlike the Web Search API, the request and the response are Elo’s own shape, the same for every query.
Base URL
Section titled “Base URL”https://api.elo.ad/v1Create your publisher API key on the Integration page of the
Elo dashboard. Rotating it there revokes the previous key
immediately. Send it in Authorization: Bearer or in X-API-Key.
Request
Section titled “Request”curl -X POST "https://api.elo.ad/v1/products/search" \ -H "Authorization: Bearer elo_pub_..." \ -H "Content-Type: application/json" \ -d '{ "q": "wireless mouse", "country": "us", "language": "en", "num": 5 }'| Field | Description |
|---|---|
q | The shopping query. Required, up to 2048 characters. |
country | Two-letter country code, lower case, for example us. Defaults to the US. |
language | Language code, lower case, for example en or pt-br. |
num | Most products to return, 1 to 40. Defaults to 5. |
Response
Section titled “Response”{ "products": [ { "title": "Logitech M170 Wireless Mouse", "url": "https://api.elo.ad/v1/products/go/q3vT9kLm2Pwx", "merchant": "Best Buy", "price": "$14.99", "image_url": "https://images.example.com/logitech-m170.jpg", "position": 1 } ]}| Field | Description |
|---|---|
title | Product name. |
url | Elo’s link to the product. See Links. |
merchant | The store Google Shopping lists it from, when known. |
price | The price Google Shopping lists, currency included, when known. |
image_url | Product picture, when known. |
position | Rank by relevance, from 1. |
The X-Request-ID response header identifies the call in Elo’s logs. Quote it when
reporting a problem.
Each product’s url is Elo’s link. When opened, it redirects to the product’s page at the
store, or to Google Shopping’s page when Elo finds no store page. Open it in a new tab or
the system browser. A link opens the store page for 7 days after the search, and Google
Shopping’s page after that. After 90 days it stops working.
Elo monetizes links on a best-effort basis: where it can, the redirect goes through a tracked link to the same page. Monetization never changes which products are returned or their order.
Errors
Section titled “Errors”| Status | Meaning |
|---|---|
401 | The publisher API key is missing or not valid. |
422 | The request does not match the schema. The body says which field. |
502, 503, 504 | Internal server error. Retry later. |