Commerce Webstore Product Search

Searching products respects buyer View Product entitlements and only users entitled to view product data can access this resource.

Resource

Available version

49.0

Requires Chatter

No

HTTP methods

POST

POST methods typically create an item, but for this resource POST is used to retrieve information.

Request body for POST

JSON example

Properties

Name	Type	Description	Required or Optional	Available Version
categoryId	String	Category ID returns results for products in this category or its subcategories.	Required if searchTerm isn’t specified	49.0
fields	String[]	Product fields to return in search results. Search results include fields you have access to. If unspecified, all accessible fields are returned.	Optional	49.0
grouping (pilot)	Product Search Grouping Input (Pilot)	Specifies whether to group products in search results and how to group them. If unspecified, the default is the value specified in Search | Results Display Settings | Results Grouping.	Optional	51.0
includePrices	Boolean	Specifies whether to include prices for products in search results (true) or not (false). If unspecified, defaults to false.	Optional	49.0
page	Integer	Specifies the number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.	Optional	49.0
pageSize	Integer	Specifies the number of items per page. Valid values are from 1 through 200. If unspecified, the default is the value specified in Results per Page in Search | Results Display Settings | Results Display Limits.	Optional	49.0
refinements	Distinct Value Refinement Input[]	Refinements for search results.	Optional	49.0
searchTerm	String	A list of up to 32 space-separated search terms.	Required if categoryId isn’t specified	49.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
effective​AccountId	String	ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. effectiveAccountId isn’t supported for internal users.	Optional	49.0

Response body for POST

Product Search Results