List Products
retail_search.list_products
ActionGoogle Cloudconnection required
Calls AI Commerce Search GET /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products.
Gets a list of Products.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google AI Commerce Search
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- location, project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_id GCP project id (overrides connection). | string | No | — | — | — |
location Location / region (overrides connection). | string | No | — | — | — |
catalog Id of the catalog to act on, from retail_search.list_catalogs — not its name. | string | Yes | — | — | — |
branch Id of the branch to act on, from its Retail Search URL or console — not its name. | string | Yes | — | — | — |
filter A filter to apply on the list results. | string | No | — | — | — |
page_size Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Valu | number | No | 50 | ≥ 1 | — |
page_token A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"page_size": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
nextPageToken | string | — |
products | array | — |
{
"nextPageToken": "",
"ok": false,
"products": []
}Related Google AI Commerce Search nodes
See List Products run in a workflow.
In a technical demo we add the Google AI Commerce Search connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.