get_shopper_prefs
Get a shopper's ad preferences — whether they allow sponsored results and their brand/ingredient preferences.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"shopper_id": "<shopper_id>",
"tenant_id": "<tenant_id>"
},
"name": "get_shopper_prefs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tenant_id | Yes | Unique identifier for the merchant/tenant account | |
| shopper_id | Yes | Unique identifier for the shopper |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| shopper_id | No | ||
| brand_blocklist | No | Brands to exclude from results | |
| preferred_tiers | No | Preferred product tier categories | |
| organic_only_mode | No | Whether shopper prefers organic-only results | |
| sponsored_allowed | No | Whether shopper has opted into sponsored results | |
| max_sponsored_ratio | No | Maximum ratio of sponsored to organic results | |
| ingredient_avoidances | No | Ingredients to avoid |