Run Shopping Discovery
AI-generatedSummary
Transforms a natural-language shopping prompt into structured product results via the Periskop API.
Inputs
- prompt (required) — Natural-language shopping intent (e.g., 'best desk chair under 60€').
- responseFormat — Response shape: 'simple' for a compact structure or 'full' for the complete contract. Defaults to 'simple'.
- constraints — Optional constraints in JSON format (e.g., {"max_price": 200, "optimization": "best_quality"}).
- country — ISO country code (defaults to account default).
- currency — ISO currency code (defaults to account default).
- externalUserId — End-user identifier for analytics.
- language — BCP 47 language tag.
- maxResults — Maximum number of products to return (1-50). Defaults to 3.
- mode — Discovery mode (auto, best, browse, bundle, recommend). Defaults to auto.
- previousResultId — Prior result ID for follow-up discovery.
- store — Store ID or natural store hint to scope the search.
Output shape
A list of items, each containing the raw API response JSON for the provided prompt.
The API returns structured product data; no checkout or payment processing occurs.
Examples
Example 1: Find three laptops under 1000€ in EUR currency
Prompt: 'three laptops under 1000€ in EUR currency', Response Format: 'simple', Max Results: 3
Example 2: Get best quality running shoes with JSON constraints
Prompt: 'best quality running shoes', Additional Fields: Constraints (JSON) {"optimization": "best_quality"}
Example 3: Browse products for a specific store and language
Prompt: 'coffee maker', Additional Fields: Store 'Amazon', Language 'de'