SapccApiGetAvailableProductsRequest
Request parameters for getAvailableProducts operation in SapccApi. SapccApiGetAvailableProductsRequest
interface SapccApiGetAvailableProductsRequest {
readonly baseSiteId: string;
readonly cartId: string;
readonly currentPage?: number;
readonly entryGroupNumber: number;
readonly fields?: string;
readonly pageSize?: number;
readonly query?: string;
readonly sort?: string;
readonly userId: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier. {string} SapccApiGetAvailableProducts |
cartId | Required | string | Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart. {string} SapccApiGetAvailableProducts |
currentPage | Optional | number | Current result page. Default value is 0. {number} SapccApiGetAvailableProducts |
entryGroupNumber | Required | number | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order. {number} SapccApiGetAvailableProducts |
fields | Optional | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL. {string} SapccApiGetAvailableProducts |
pageSize | Optional | number | Number of results returned per page. {number} SapccApiGetAvailableProducts |
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} SapccApiGetAvailableProducts |
sort | Optional | string | Sorting method applied to the return results. {string} SapccApiGetAvailableProducts |
userId | Required | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user. {string} SapccApiGetAvailableProducts |