Suggestion Document (Shop API 17.3)

(supports custom properties)

Document representing a suggestion.

Property Type Constraints Description
brands [String]   The sorted list of suggested brands. This list can be empty.
categories [SuggestedCategory]   The sorted list of suggested categories. This list can be empty.
content [SuggestedContent]   The sorted list of suggested content. This list can be empty.
custom_suggestions [String]   The sorted list of suggested custom suggestions. This list can be empty.
products [SuggestedProduct]   The sorted list of suggested products. This list can be empty.
suggested_phrases [SuggestedPhrase]   A list of suggested phrases. This list can be empty.
suggested_terms [SuggestedTerms]   A list of suggested terms. This list can be empty.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.