Request Options

Web Data

Send JSON with Content-Type: application/json. Put your key in the X-Api-Key header.

POST /v1/google/shopping/product

You must send exactly one of catalog_id or url. more_stores is optional.

catalog_id

Google's catalog ID for the product.

  • Type: string
  • Pattern: 5 to 25 digits
  • Send as a quoted string so every digit is kept
  • Give this or url, not both
{
  "catalog_id": "11018290803738983204",
  "more_stores": 3
}

One of catalog_id or url

Every Shop Light request needs either catalog_id or a Google Shopping product url.


url

A Google Shopping product link that includes a catalog ID.

  • Type: string
  • Max length: 2048
  • Must contain prds=catalogid:<id> (the colon may appear as %3A in the link)
  • Give this or catalog_id, not both
  • Only the catalog ID is read from the link. The lookup still runs as a US buyer in English.
{
  "url": "https://www.google.com/search?ibp=oshop&q=+&prds=catalogid%3A11018290803738983204"
}

more_stores

How many times to open "More stores", at most.

  • Type: integer
  • Min: 0, Max: 15, Default: 3
  • The product page shows the first stores (about three when there are more). Each ask can add up to ten.
  • Use 0 for the page's stores only.
  • Asking stops on its own when the list ends.
  • The charge does not change with this value.
{
  "catalog_id": "11018290803738983204",
  "more_stores": 0
}

Was this page helpful?

On this page