Skip to main content
GET
/
v1
/
shopper
/
deal-finder
Find discounted products in a category
curl --request GET \
  --url https://api.syntalic.com/v1/shopper/deal-finder \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "electronics",
  "country": "us",
  "retailer": "amazon",
  "min_discount_pct": 10,
  "limit": 20
}
'
{
  "category": "<string>",
  "deals": [
    {}
  ]
}

Query Parameters

category
string
required

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
retailer
enum<string>

Filter to a specific retailer

Available options:
amazon,
walmart,
costco,
homedepot,
nordstrom,
ikea
min_discount_pct
integer
default:10

Minimum discount percentage (default 10)

limit
integer
default:20

Max results to return (default 20, max 50)

Required range: x <= 50

Body

application/json

Query parameters as JSON (alternative to URL query string for agents that prefer body-based invocation).

category
string
required

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
Example:

"electronics"

country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
Example:

"us"

retailer
enum<string>

Filter to a specific retailer

Available options:
amazon,
walmart,
costco,
homedepot,
nordstrom,
ikea
Example:

"amazon"

min_discount_pct
integer
default:10

Minimum discount percentage (default 10)

Example:

10

limit
integer
default:20

Max results to return (default 20, max 50)

Required range: x <= 50
Example:

20

Response

Deals found

category
string
deals
object[]