// request reference
Google Shopping parameters
Send query parameters with GET /api/google/shopping. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
The groups below list every request field, including compatibility restrictions. Read the extended reference for detailed types, defaults, parameter combinations and additional examples.
Product search
Search Google Shopping, or replay a filter token from a previous response.
qProduct search, up to 2,048 characters with no controls.
Example / input hint: coffee maker
shoprsRefinement token from a previous response. An explicit refinement below replaces it.
Example / input hint: CAESBEoCGAEYBioM…
startResult offset from 0 through 1,000.
Example / input hint: 0
num1 through 100. Responses are capped to this count and transparently consume Google’s fixed 40-product pages when needed.
Example / input hint: 60
Refinements
Google Shopping applies one refinement at a time. Sorting can be combined with any one of them.
min_priceLower price bound in the storefront currency.
Example / input hint: 50
max_priceUpper price bound in the storefront currency.
Example / input hint: 100
sort_bySort order. Combines with one refinement.
1 Price: low to high2 Price: high to low3 Rating: high to lowon_saleShow only products Google marks as on sale.
truefalsefree_shippingShow only products with free shipping.
truefalsesmall_businessShow only products from small businesses.
truefalseGeography
Choose a human-readable location or a canonical UULE, never both.
locationNamed search origin, up to 512 characters; conflicts with uule.
Example / input hint: Austin, Texas
uuleCanonical Google location token, up to 2,048 characters; conflicts with location.
Example / input hint: w+CAIQICI…
Localization
Control the first-party Google host, language, country, and device layout.
hlGoogle interface and result language.
Example / input hint: en
glTwo-letter country localization code.
Example / input hint: us
google_domainA Google domain such as google.com or google.co.uk.
Example / input hint: google.com
deviceGoogle returns its real layout for the selected device.
desktoptabletmobile// response
Work with the complete JSON response
Response groups include shopping_results, categorized_shopping_results, filters, carousel_filters, search_information. Groups and fields depend on the upstream result.
The SDK examples use raise_for_error() or raiseForError() so API errors are not mistaken for successful results.