Retail API
googleapis · Analytics
Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
Authentication
Sample Requests
Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery?alt=json&key=YOUR_API_KEY&query=test&entity=example&fields=example&$.xgafv=1&dataset=example&callback=example"aUser=example&visitorId=example&deviceType=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&languageCodes=example&maxSuggestions=1&upload_protocol=example&enableAttributeSuggestions=true"import requests
params = {
"alt": "json",
"key": "YOUR_API_KEY",
"query": "test",
"entity": "example",
"fields": "example",
"$.xgafv": "1",
"dataset": "example",
"callback": "example",
"quotaUser": "example",
"visitorId": "example",
"deviceType": "example",
"uploadType": "example",
"oauth_token": "example",
"prettyPrint": "true",
"access_token": "example",
"languageCodes": "example",
"maxSuggestions": "1",
"upload_protocol": "example",
"enableAttributeSuggestions": "true"
}
response = requests.get(
"https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('query', 'test');
url.searchParams.set('entity', 'example');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('dataset', 'example');
url.searchParams.set('callback', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('visitorId', 'example');
url.searchParams.set('deviceType', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('languageCodes', 'example');
url.searchParams.set('maxSuggestions', '1');
url.searchParams.set('upload_protocol', 'example');
url.searchParams.set('enableAttributeSuggestions', 'true');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery")
q := baseURL.Query()
q.Set("alt", "json")
q.Set("key", "YOUR_API_KEY")
q.Set("query", "test")
q.Set("entity", "example")
q.Set("fields", "example")
q.Set("$.xgafv", "1")
q.Set("dataset", "example")
q.Set("callback", "example")
q.Set("quotaUser", "example")
q.Set("visitorId", "example")
q.Set("deviceType", "example")
q.Set("uploadType", "example")
q.Set("oauth_token", "example")
q.Set("prettyPrint", "true")
q.Set("access_token", "example")
q.Set("languageCodes", "example")
q.Set("maxSuggestions", "1")
q.Set("upload_protocol", "example")
q.Set("enableAttributeSuggestions", "true")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery")
uri.query = URI.encode_www_form({
"alt" => "json",
"key" => "YOUR_API_KEY",
"query" => "test",
"entity" => "example",
"fields" => "example",
"$.xgafv" => "1",
"dataset" => "example",
"callback" => "example",
"quotaUser" => "example",
"visitorId" => "example",
"deviceType" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"languageCodes" => "example",
"maxSuggestions" => "1",
"upload_protocol" => "example",
"enableAttributeSuggestions" => "true"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{catalog}:completeQuery?" . http_build_query([
"alt" => "json",
"key" => "YOUR_API_KEY",
"query" => "test",
"entity" => "example",
"fields" => "example",
"$.xgafv" => "1",
"dataset" => "example",
"callback" => "example",
"quotaUser" => "example",
"visitorId" => "example",
"deviceType" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"languageCodes" => "example",
"maxSuggestions" => "1",
"upload_protocol" => "example",
"enableAttributeSuggestions" => "true"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example"aUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"import requests
params = {
"alt": "json",
"key": "YOUR_API_KEY",
"fields": "example",
"filter": "example",
"$.xgafv": "1",
"callback": "example",
"pageSize": "1",
"pageToken": "example",
"quotaUser": "example",
"uploadType": "example",
"oauth_token": "example",
"prettyPrint": "true",
"access_token": "example",
"upload_protocol": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('filter', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations")
q := baseURL.Query()
q.Set("alt", "json")
q.Set("key", "YOUR_API_KEY")
q.Set("fields", "example")
q.Set("filter", "example")
q.Set("$.xgafv", "1")
q.Set("callback", "example")
q.Set("pageSize", "1")
q.Set("pageToken", "example")
q.Set("quotaUser", "example")
q.Set("uploadType", "example")
q.Set("oauth_token", "example")
q.Set("prettyPrint", "true")
q.Set("access_token", "example")
q.Set("upload_protocol", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations")
uri.query = URI.encode_www_form({
"alt" => "json",
"key" => "YOUR_API_KEY",
"fields" => "example",
"filter" => "example",
"$.xgafv" => "1",
"callback" => "example",
"pageSize" => "1",
"pageToken" => "example",
"quotaUser" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"upload_protocol" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{name}/operations?" . http_build_query([
"alt" => "json",
"key" => "YOUR_API_KEY",
"fields" => "example",
"filter" => "example",
"$.xgafv" => "1",
"callback" => "example",
"pageSize" => "1",
"pageToken" => "example",
"quotaUser" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"upload_protocol" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Lists all the Catalogs associated with the project.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs?alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example"aUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"import requests
params = {
"alt": "json",
"key": "YOUR_API_KEY",
"fields": "example",
"$.xgafv": "1",
"callback": "example",
"pageSize": "1",
"pageToken": "example",
"quotaUser": "example",
"uploadType": "example",
"oauth_token": "example",
"prettyPrint": "true",
"access_token": "example",
"upload_protocol": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs")
q := baseURL.Query()
q.Set("alt", "json")
q.Set("key", "YOUR_API_KEY")
q.Set("fields", "example")
q.Set("$.xgafv", "1")
q.Set("callback", "example")
q.Set("pageSize", "1")
q.Set("pageToken", "example")
q.Set("quotaUser", "example")
q.Set("uploadType", "example")
q.Set("oauth_token", "example")
q.Set("prettyPrint", "true")
q.Set("access_token", "example")
q.Set("upload_protocol", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs")
uri.query = URI.encode_www_form({
"alt" => "json",
"key" => "YOUR_API_KEY",
"fields" => "example",
"$.xgafv" => "1",
"callback" => "example",
"pageSize" => "1",
"pageToken" => "example",
"quotaUser" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"upload_protocol" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/retail/v2alpha/v2alpha/{parent}/catalogs?" . http_build_query([
"alt" => "json",
"key" => "YOUR_API_KEY",
"fields" => "example",
"$.xgafv" => "1",
"callback" => "example",
"pageSize" => "1",
"pageToken" => "example",
"quotaUser" => "example",
"uploadType" => "example",
"oauth_token" => "example",
"prettyPrint" => "true",
"access_token" => "example",
"upload_protocol" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Retail API?
Retail API is a Analytics API. Developers commonly use analytics APIs for:
- tracking product usage and user behaviour
- building custom reporting and BI dashboards
- measuring marketing and campaign performance
- running funnel, retention, and cohort analysis
- aggregating metrics from multiple data sources
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Retail API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide