SapccApiGetCustomerCouponsRequest
Request parameters for getCustomerCoupons operation in SapccApi. SapccApiGetCustomerCouponsRequest
interface SapccApiGetCustomerCouponsRequest {
readonly baseSiteId: string;
readonly currentPage?: number;
readonly fields?: string;
readonly needsTotal?: GetCustomerCouponsNeedsTotalEnum;
readonly pageSize?: number;
readonly sort?: string;
readonly userId: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier {string} SapccApiGetCustomerCoupons |
currentPage | Optional | number | Current result page. Default value is 0. {number} SapccApiGetCustomerCoupons |
fields | Optional | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL {string} SapccApiGetCustomerCoupons |
needsTotal | Optional | GetCustomerCouponsNeedsTotalEnum | Flag to indicate if the total number of results is needed or not. {'true' | 'false'} SapccApiGetCustomerCoupons |
pageSize | Optional | number | The number of results returned per page. {number} SapccApiGetCustomerCoupons |
sort | Optional | string | Sorting method applied to the return results. {string} SapccApiGetCustomerCoupons |
userId | Required | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user {string} SapccApiGetCustomerCoupons |