Class OrdersApi

OrdersApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- OrdersApi
  - OrdersApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getOrder searchOrders

Constructors

constructor

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

getOrder

getOrder(
requestParameters: OrdersApiGetOrderRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetOrderResponse, any, {}>>
Returns the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API documentation.
Parameters
- requestParameters: OrdersApiGetOrderRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetOrderResponse, any, {}>>
Throws
- Defined in api-model/api/orders-api.ts:313

searchOrders

searchOrders(
requestParameters?: OrdersApiSearchOrdersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SearchOrdersResponse, any, {}>>
Returns orders created or updated during the time period that you specify. You can filter the response for specific types of orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0056 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API documentation.
Parameters
- requestParameters: OrdersApiSearchOrdersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SearchOrdersResponse, any, {}>>
Throws
- Defined in api-model/api/orders-api.ts:323