Class PromotionsApi

PromotionsApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- PromotionsApi
  - PromotionsApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getPromotion getSelection searchPromotions

Constructors

constructor

new PromotionsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): PromotionsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PromotionsApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getPromotion

getPromotion(
requestParameters: PromotionsApiGetPromotionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetPromotionResponse, any, {}, any>>
Retrieve details of a specified promotion.
Parameters
- requestParameters: PromotionsApiGetPromotionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetPromotionResponse, any, {}, any>>

Throws
- Defined in api-model/api/promotions-api.ts:529

getSelection

getSelection(
requestParameters: PromotionsApiGetSelectionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetSelectionResponse, any, {}, any>>
Retrieve up to 100 product items that are associated with a specified promotion. This operation only supports items found in SelectionType.ITEMS. Items found in SelectionType.CATALOG are not supported. Selection objects always include selectionDetails with item information.
Parameters
- requestParameters: PromotionsApiGetSelectionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetSelectionResponse, any, {}, any>>

Throws
- Defined in api-model/api/promotions-api.ts:539

searchPromotions

searchPromotions(
requestParameters: PromotionsApiSearchPromotionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SearchPromotionsResponse, any, {}, any>>
Search and filter promotions based on various criteria. Returns a paginated list of promotion summaries.
Parameters
- requestParameters: PromotionsApiSearchPromotionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SearchPromotionsResponse, any, {}, any>>

Throws
- Defined in api-model/api/promotions-api.ts:549