This endpoint accomplishes 3 tasks in 1 simple POST:

  • Performs a CP search with an RP performed automatically (for example: request a search for “random product string” and also get prices for that product in the response body). This eliminates the need for separate /product_search and /prices API requests.
  • Returns a ValueChecker recommended solution whether indexed price, clustered shopping price or ValueChecker curated price. This eliminates any confusion when you require just one price for a searched query.
  • Can accept an image as the query (instead of a query text string) that is analyzed for price result(s).
payload example
{
    "query": "string",
    "image_urls": ["string"],
    "images": ["string"],
}

Only one of the parameters query, image_urls and images is required. The images parameter expects a list of base64 encoded images. While the image_urls parameter expects a list of URLs where the images are stored.

​
Optional configuration

You can provide a claimed_amount parameter which will be used as a benchmark price when finding offers.

If a claimed_amount is provided, price limits will be applied based on the category (a setting defined per client). E.g. if a claimed_amount of 1000 is given and the category is Mobile Phones and the price_limits for said category are:

price_min = 20% * claimed_amount
price_max = 150% * claimed_amount

ValueChecker will search for offers within that range.

payload example
{
    "query": "string",
    "image_urls": ["string"],
    "images": ["string"],
    "claimed_amount": <number>,
}

You can also provide a price_min and price_max parameters which, when provided, will take precedence over the claimed_amount benchmark logic for calculating the price ranges.

payload example
{
    "query": "string",
    "image_urls": ["string"],
    "images": ["string"],
    "price_min": <number>,
    "price_max": <number>,
}

​
Standardized response body

The response JSON formatting is updated so that all types of RPs (Replacement Products) have the same field structure which simplifies your parsing requirements.

​
Core products

Products from our curated inventory. (phones, laptops, TVs, white goods, etc.)

​
Non-Core products

Almost anything that can be found (with a price) on the internet.

​
Clustered products

Prices for products in non-core categories aggregated into price buckets.

​
Indexed products

Prices statistically set or adjusted by ValueChecker for generic products.

Every response comes with a ValueChecker recommended price and type. This can be used for STP or in cases where you want to return exactly 1 price for a searched CP.

​
Image analysis vs query string

If both a query and an image are provided, we will do the following:

  • Use the image to find a product description.
  • Check said product description against the query that was provided.
  • If the predicted product description is a more detailed description of the claimed product, it will be used to find offers.
  • If the user provides a query together with an image that does not match the query, the query will take precedence and will be used to find offers.
Offer Search Endpoint➜