Google Shopping API
PreviewGoogle Shopping results in structured JSON, including product listings, prices, merchants, ratings, and available filters.
Endpoint not configuredJSON responsePlayground
Google Shopping
GOOGLE_SHOPPING_ENDPOINT and YOUR_API_KEY are placeholders.Static Office Chair example from the US market. Prices and availability are historical sample data and stay fixed when parameters change.
Quickstart
- Create an API key. Manage credentials in API Keys.
- Prepare a Shopping search. Set
engine=google_shoppingand a product queryq, or ashoprstoken. Add localization, price limits, and filters as needed. - Use the published endpoint once available. The request examples above are templates. The Google Shopping endpoint is currently unconfigured.
Authentication
QueryPilot uses the X-API-Key request header. Use your QueryPilot key, not an upstream provider key. Full keys are shown only when created or rotated.
X-API-Key: YOUR_API_KEY
Keep API keys in server-side environment variables. The examples here contain no account credentials.
Request parameters
Planned parameters for Google Shopping. Availability will be confirmed when the endpoint is connected.
| Parameter | Type / default | Description |
|---|
Pagination
The current Google Shopping layout ignores start and returns a fixed page size, so num does not change the number of results. This preview omits both controls and does not promise a next page.
Filters and price ranges
Prices use the currency of the selected market. Unchecked filters are omitted; a shoprs token may still contain those filters. Explicit price, sort, and boolean parameters override their corresponding token filters. Sorting and filtering will apply to live requests once available.
Response reference
Field names, nesting, and JSON types follow the SerpApi Google Shopping format. Result modules and product attributes are conditional and may be absent for a query.
| Field | Type | Content |
|---|
Shopping result
Each item can include position (number), title, product_id, product_link, source, and price (strings). Keep product IDs as strings to avoid precision loss. A product_link opens Google product details; a link, when present, can point to a merchant.
extracted_price, rating, and reviews are numbers. Optional fields include old_price, extracted_old_price, delivery, thumbnail, thumbnails, extensions, and multiple_sources. Preserve the display price: it may describe an installment, such as a monthly amount, rather than the full product price.
Request metadata and links
search_metadata.id will identify the QueryPilot request. Timestamps follow YYYY-MM-DD HH:mm:ss UTC; total_time_taken is measured in seconds. Archive URLs and provider-specific product-detail API links are not available in this preview. A product token does not imply that a QueryPilot product-detail endpoint is available. QueryPilot URLs will be documented when those capabilities are implemented.
Errors & billing
This playground does not send search requests and uses no credits. Pricing, billable outcomes, rate limits, and the final error contract will be published with live access.
A response with search_metadata.status = "Success" in the static example is sample data, not a live request status. Clients should eventually check both the HTTP status and the response error fields.