Class SalesApi

SalesApi - object-oriented interface

Export

SalesApi

Hierarchy (View Summary)

Constructors

constructor

Properties

axios basePath configuration

Methods

getOrderMetrics

Constructors

constructor

  • new SalesApi(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): SalesApi

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns SalesApi

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

getOrderMetrics

  • getOrderMetrics(
        requestParameters: SalesApiGetOrderMetricsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetOrderMetricsResponse, any>>

  • Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 15 | 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

    Returns Promise<AxiosResponse<GetOrderMetricsResponse, any>>

    Throws

    Memberof

    SalesApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods