SapccApiGetProductsByCategoryRequest
Request parameters for getProductsByCategory operation in SapccApi. SapccApiGetProductsByCategoryRequest
interface SapccApiGetProductsByCategoryRequest {
readonly baseSiteId: string;
readonly categoryId: string;
readonly currentPage?: number;
readonly fields?: string;
readonly pageSize?: number;
readonly query?: string;
readonly sort?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier {string} SapccApiGetProductsByCategory |
categoryId | Required | string | Category identifier. {string} SapccApiGetProductsByCategory |
currentPage | Optional | number | Current result page. Default value is 0. {number} SapccApiGetProductsByCategory |
fields | Optional | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL {string} SapccApiGetProductsByCategory |
pageSize | Optional | number | Number of results returned per page. {number} SapccApiGetProductsByCategory |
query | Optional | string | Formatted query string. It contains query criteria like free text search, facet. The format is <freeTextSearch>:<sort>:<facetKey1>:<facetValue1>:...:<facetKeyN>:<facetValueN>. {string} SapccApiGetProductsByCategory |
sort | Optional | string | Sorting method applied to the return results. {string} SapccApiGetProductsByCategory |