Skip to main content
GET
/
v1
/
search
Product Search
curl --request GET \
  --url https://api.zinc.io/v1/search \
  --header 'Authorization: Basic <encoded-value>'
{
  "timestamp": 123,
  "retailer": "<string>",
  "results": [
    {
      "product_id": "<string>",
      "title": "<string>",
      "image": "<string>",
      "num_reviews": 123,
      "stars": "<string>",
      "fresh": true,
      "price": 123
    }
  ]
}
Get search results from a retailer based on a query term. Results include product id, title, image url, number of reviews, star rating, and price.

Authorizations

​
Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Query Parameters

​
query
string
required

The search query

​
page
integer

The page number for pagination

​
retailer
string
required

The retailer for the product. See Supported Retailers for a list of supported retailers.

Response

200 - application/json

Search results retrieved successfully

Response for product search

​
status
enum<string>

Status of the request. You will only see processing if async: true was set on the request

Available options:
processing,
failed,
completed
​
timestamp
number

Timestamp of the search

​
retailer
string

The retailer searched

​
results
object[]

Array of search results