Class OffersApi

OffersApi - object-oriented interface

Export

OffersApi

Hierarchy (View Summary)

BaseAPI
- OffersApi
  - ReplenishmentApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getSellingPartnerMetrics listOfferMetrics listOffers

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getSellingPartnerMetrics

getSellingPartnerMetrics(
requestParameters?: OffersApiGetSellingPartnerMetricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetSellingPartnerMetricsResponse, any>>
Returns aggregated replenishment program metrics for a selling partner. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
- requestParameters: OffersApiGetSellingPartnerMetricsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetSellingPartnerMetricsResponse, any>>
Throws
Memberof
OffersApi
- Defined in api-model/api/offers-api.ts:285

listOfferMetrics

listOfferMetrics(
requestParameters?: OffersApiListOfferMetricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListOfferMetricsResponse, any>>
Returns aggregated replenishment program metrics for a selling partner's offers. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
- requestParameters: OffersApiListOfferMetricsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListOfferMetricsResponse, any>>
Throws
Memberof
OffersApi
- Defined in api-model/api/offers-api.ts:296

listOffers

listOffers(
requestParameters?: OffersApiListOffersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListOffersResponse, any>>
Returns the details of a selling partner's replenishment program offers. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
- requestParameters: OffersApiListOffersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListOffersResponse, any>>
Throws
Memberof
OffersApi
- Defined in api-model/api/offers-api.ts:307