shopping-search

Search

Search shopping products and get ranked recommendations. Each result's affiliate_url is already a ready-to-use trackable buy link (minted + redirect-wrapped inline) — there is no separate resolve-link step.

post/api/v1/shopping/search

Request

  • Base URL: https://api.intentlink.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.intentlink.io/api/v1/shopping/search
  • Auth: none declared

Request body

querystring required

Natural-language intent (semantic).

keywordsstring[]

Exact product terms — brand / model / SPECIFIC product type. Prefer a fully qualified noun phrase (e.g. 'women running shoes', 'stainless steel knife set') over a bare generic noun ('shoes', 'knife'): a generic keyword matches the whole category lexically and can surface the wrong audience (e.g. mens shoes for a girlfriend gift). Audience/occasion context belongs in query. Non-empty keywords signal an exact lookup (BM25-leaning ranking).

commerce_l1sstring[]

Optional category L1s.

commerce_l2sstring[]

Optional full 'l1.l2' L2s.

max_pricenumber nullable
min_pricenumber nullable
in_stockboolean
platformsstring[]

Source platforms e.g. amazon/walmart (empty = all).

require_commissionboolean nullable

Only return products that carry a commission (positive commission_rate). Omit to use the server default.

countrystring
currencystring nullable
intent'cheapest' | 'best_discount' | 'top_rated' | 'best_value'

Shopping-specific simplified ranking presets (independent of the legacy ShoppingIntent / INTENT_PRESETS used by the old recommender). Each maps to a lean important/secondary profile in app.services.shopping_search.ranking. Given a ranking object instead, intent is ignored.

limitinteger

Response

Successful Response

request_idstring required
status'ok' | 'needs_clarification' | 'no_results' | 'partial_results' | 'error' required
normalized_requestobject
agent_messagestring required
errorsobject[]
from_cacheboolean

Changes

No recorded changes to this operation across all 1 revision of this API.