Skip to main content
POST
/
api
/
v1
/
shopping
/
sessions
/
{session_id}
/
search
Search Products
curl --request POST \
  --url https://api.example.com/api/v1/shopping/sessions/{session_id}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "max_results": 10,
  "price_min_cents": 1,
  "price_max_cents": 1
}
'
{
  "query": "<string>",
  "results": [
    {
      "title": "<string>",
      "product_url": "<string>",
      "price_cents": 123,
      "currency": "USD",
      "image_url": "<string>",
      "affiliate_url": "<string>",
      "merchant_domain": "<string>",
      "merchant_type": "affiliate",
      "rating": 123,
      "source": "brave_search"
    }
  ],
  "total_count": 123,
  "source": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
session_id
string<uuid>
required

Body

application/json
​
query
string
required
Required string length: 1 - 500
​
merchant_type
enum<string> | null
Available options:
affiliate,
ucp,
acp
​
max_results
integer
default:10
Required range: 1 <= x <= 20
​
price_min_cents
integer | null
Required range: x >= 0
​
price_max_cents
integer | null
Required range: x >= 0

Response

Successful Response

​
query
string
required
​
results
ProductSearchResult · object[]
required
​
total_count
integer
required
​
source
string
required