Skip to main content
POST
/
search
/
offers
Offer Search
curl --request POST \
  --url https://api.valuechecker.net/search/offers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "image_urls": [
    "<string>"
  ],
  "images": [
    "<string>"
  ],
  "claimed_amount": 123,
  "price_min": 123,
  "price_max": 123
}
'
{}

Authorizations

​
Authorization
string
header
required

Note! Prefix your with apiKey. Note the space after "apiKey ".

Query Parameters

​
client_id
integer

The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional.

​
session-id
string

Optional session identifier of the user.

Body

application/json
​
query
string

The product name, model number, or other identifier the customer is claiming.

​
image_urls
string[]

One or more publicly reachable URLs that point to images supporting the claim.

​
images
string[]

One or more base‑64‑encoded image strings (use when direct URLs aren't available).

​
claimed_amount
number

The monetary amount (in the currency of record) that the customer is requesting to be reimbursed.

Must be a multiple of 0.01
​
price_min
number

Lower price threshold: offers priced below this value are filtered out and not returned.

Must be a multiple of 0.01
​
price_max
number

Upper price threshold: offers priced above this value are filtered out and not returned.

Must be a multiple of 0.01

Response

OK - Returns offer search results with claimed product, recommended offer, and replacement options

Curated response containing claimed product, recommended offer, indexed products, clustered products, replacement offers, and metadata