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

  • Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<CancelShipmentResponse, any>>

    ShippingApi

  • Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<DirectPurchaseResponse, any>>

    ShippingApi

  • Returns a list of access points in proximity of input postal code. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<GetAccessPointsResponse, any>>

    ShippingApi

  • Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<GetAdditionalInputsResponse, any>>

    ShippingApi

  • Returns the available shipping service offerings. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ShippingApiGetRatesRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<GetRatesResponse, any>>

    ShippingApi

  • Returns tracking information for a purchased shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<GetTrackingResponse, any>>

    ShippingApi

  • Purchases a shipping service identifier and returns purchase-related details and documents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<OneClickShipmentResponse, any>>

    ShippingApi

  • Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    Returns Promise<AxiosResponse<PurchaseShipmentResponse, any>>

    ShippingApi