v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

SuggestedSearchTerm

Retrieve suggested search terms

This endpoint retrieves suggested search terms with options to filter by catalog, product code, and search term type. Results are shown in pages to make them easier to view and manage.

get/v3/suggested-search-terms

Query parameters

pageTokenstring

Use this token to paginate through the list of suggested terms. Pass it in subsequent requests to continue from where the previous call left off.

pageSizestring int64

Specify the number of suggested search terms to be returned per page.

catalogIdstring required

Filter the suggested search terms by the specified catalog ID.

productCodestring

Filter the suggested search terms by the specified product code.

searchTermTypesstring[]

Filter suggested search terms by selecting a specific search term type. You can choose from the following search term types: SEARCH_TERM_TYPE_ORGANIC, SEARCH_TERM_TYPE_CROSS_SELL, or SEARCH_TERM_TYPE_SUBSTITUTE.

Response

A list of suggested search terms and a pagination token.

nextPageTokenstring

The page token to request the next page in pagination. Include it as "pageToken" in the request.

totalCountstring int64

The total number of suggested search terms matching the provided criteria.