commerce/catalog/admin/search

Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules.

Operations

Operation Name Request URI Description
AddSearchTuningRule POST searchtuningrules%3fresponseFields%3d%7bresponseFields%7d

Creates a search tuning rule for your site. You can use search tuning rules to fine tune the product search results that appear when a shopper searches for a specific keyword, or navigates to a category page.

For more information on search tuning rules, refer to Search Tuning Rules.

AddSynonymDefinition POST synonyms%3fresponseFields%3d%7bresponseFields%7d

Creates a new synonym definition.

Refer to Search Synonyms for more information about search synonyms.

DeleteSearchTuningRule DELETE searchtuningrules%2f%7bsearchTuningRuleCode%7d

Deletes the specified search tuning rule from the site.

DeleteSynonymDefinition DELETE synonyms%2f%7bsynonymId%7d

Deletes the specified synonym definition.

Refer to Search Synonyms for more information about search synonyms.

GetSearchTuningRule GET searchtuningrules%2f%7bsearchTuningRuleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified search tuning rule.

GetSearchTuningRules GET searchtuningrules%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of search tuning rules and their properties.

GetSearchTuningRuleSortFields GET searchtuningrulesortfields%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to Search Tuning Rules and Sorting.

GetSettings GET settings%3fresponseFields%3d%7bresponseFields%7d

Retrieves the search settings for the specified site.

Refer to Search Settings API Overview for more information about Kibo eCommerce's search settings.

GetSynonymDefinition GET synonyms%2f%7bsynonymId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified synonym defintion.

Refer to Search Synonyms for more information about search synonyms.

GetSynonymDefinitionCollection GET synonym-definitions%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a collection of synonyms definitions for product searches.

Refer to Search Synonyms for more information about search synonyms.

GetSynonymDefinitions GET synonyms%2f%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of synonym definitions according to any specified filter criteria and sort options.

Refer to Search Synonyms for more information about search synonyms.

UpdateSearchTuningRule PUT searchtuningrules%2f%7bsearchTuningRuleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the specified search tuning rule.

UpdateSearchTuningRuleSortFields POST searchtuningrulesortfields%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the search tuning rule sort fields.

UpdateSettings PUT settings%3fresponseFields%3d%7bresponseFields%7d

Updates the search setting properties for a specific site.

Refer to Search Settings API Overview for more information about Kibo eCommerce's search settings.

UpdateSynonymDefinition PUT synonyms%2f%7bsynonymId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of a synonym definition.

Note:  This operation merges your updates with the existing synonym definition. It does not completely delete the existing synonym definition and replace it with what you pass in. Therefore, any existing properties on your site that are not included in the request will continue to exist in the definition. If you want to delete properties, use the corresponding Delete operation before using this operation, or use the corresponding UpdateCollection operation, which completely replaces all synonym definitions with the new request.

Refer to Search Synonyms for more information about search synonyms.

UpdateSynonymDefinitionCollection POST synonym-definitions%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates a collection of synonym definitions.

Note:  This operation updates the entire collection of synonyms, and as such, any synonyms not included in the update are deleted. For example, if you have synonyms A, B, and C on your site, and you then use this operation to update the synonyms with a collection of C, D, E, then synonyms A and B are deleted.

Refer to Search Synonyms for more information about search synonyms.