Class DefinitionsApi

DefinitionsApi - object-oriented interface

Export

DefinitionsApi

Hierarchy (View Summary)

BaseAPI
- DefinitionsApi
  - ProductTypeDefinitionsApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getDefinitionsProductType searchDefinitionsProductTypes

Constructors

constructor

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

getDefinitionsProductType

getDefinitionsProductType(
requestParameters: DefinitionsApiGetDefinitionsProductTypeRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ProductTypeDefinition, any>>
Retrieve an Amazon product type definition. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
- requestParameters: DefinitionsApiGetDefinitionsProductTypeRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ProductTypeDefinition, any>>
Throws
Memberof
DefinitionsApi
- Defined in api-model/api/definitions-api.ts:344

searchDefinitionsProductTypes

searchDefinitionsProductTypes(
requestParameters: DefinitionsApiSearchDefinitionsProductTypesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ProductTypeList, any>>
Search for and return a list of Amazon product types that have definitions available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
- requestParameters: DefinitionsApiSearchDefinitionsProductTypesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ProductTypeList, any>>
Throws
Memberof
DefinitionsApi
- Defined in api-model/api/definitions-api.ts:355