Class CatalogApi

CatalogApi - object-oriented interface

Export

CatalogApi

Hierarchy (View Summary)

BaseAPI
- CatalogApi
  - CatalogItemsApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getCatalogItem searchCatalogItems

Constructors

constructor

new CatalogApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): CatalogApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CatalogApi
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

getCatalogItem

getCatalogItem(
requestParameters: CatalogApiGetCatalogItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Item, any>>
Retrieves details for an item in the Amazon catalog. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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: CatalogApiGetCatalogItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Item, any>>
Throws
Memberof
CatalogApi
- Defined in api-model/api/catalog-api.ts:359

searchCatalogItems

searchCatalogItems(
requestParameters: CatalogApiSearchCatalogItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ItemSearchResults, any>>
Search for and return a list of Amazon catalog items and associated information. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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: CatalogApiSearchCatalogItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemSearchResults, any>>
Throws
Memberof
CatalogApi
- Defined in api-model/api/catalog-api.ts:370