// request reference
Google Shopping Product parameters
Send query parameters with GET /api/google/shopping/product. 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
Name one product with the identifiers a shopping result supplied, or replay a prds token Google built.
gpcidThe gpcid of a shopping result. Required unless a prds token is supplied.
Example / input hint: 16418087637395758399
headline_offer_docidOptional headline merchant offer document ID from the same shopping result.
Example / input hint: 8780992468355455962
image_docidOptional image document ID from the same shopping result.
Example / input hint: 9437029998757085507
prdsGoogle product selector from a previous response. Conflicts with the identifiers above.
Example / input hint: gpcid:16418087637395758399,pvt:hg,pvo:3
qRequired. The search term this product was found with; Google resolves the viewer against it too.
Example / input hint: coffee maker
Geography
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 product_result, offers, related_products, product_reviews. 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.