ShippingApi - object-oriented interface

ShippingApi

Hierarchy (View Summary)

Constructors

  • Parameters

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

    Returns ShippingApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Create a new shipment. 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<CreateShipmentResponse, any>>

    ShippingApi

  • Verify if the current account is valid. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<GetAccountResponse, any>>

    ShippingApi

  • Get service rates. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • requestParameters: ShippingApiGetRatesRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<GetRatesResponse, any>>

    ShippingApi

  • Return the entire shipment object for the shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    Returns Promise<AxiosResponse<GetShipmentResponse, any>>

    ShippingApi