Function ShippingApiFactory

Returns {
    cancelShipment(
        requestParameters: ShippingApiCancelShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelShipmentResponse>;
    createShipment(
        requestParameters: ShippingApiCreateShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateShipmentResponse>;
    getAccount(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAccountResponse>;
    getRates(
        requestParameters: ShippingApiGetRatesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetRatesResponse>;
    getShipment(
        requestParameters: ShippingApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentResponse>;
    getTrackingInformation(
        requestParameters: ShippingApiGetTrackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetTrackingInformationResponse>;
    purchaseLabels(
        requestParameters: ShippingApiPurchaseLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PurchaseLabelsResponse>;
    purchaseShipment(
        requestParameters: ShippingApiPurchaseShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PurchaseShipmentResponse>;
    retrieveShippingLabel(
        requestParameters: ShippingApiRetrieveShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RetrieveShippingLabelResponse>;
}

• cancelShipment:function

  • cancelShipment(
        requestParameters: ShippingApiCancelShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelShipmentResponse>

    Cancel a shipment by the given 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

    • requestParameters: ShippingApiCancelShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelShipmentResponse>

    Throws

• createShipment:function

  • createShipment(
        requestParameters: ShippingApiCreateShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateShipmentResponse>

    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

    • requestParameters: ShippingApiCreateShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateShipmentResponse>

    Throws

• getAccount:function

  • getAccount(options?: RawAxiosRequestConfig): AxiosPromise<GetAccountResponse>

    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 AxiosPromise<GetAccountResponse>

    Throws

• getRates:function

  • getRates(
        requestParameters: ShippingApiGetRatesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetRatesResponse>

    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 AxiosPromise<GetRatesResponse>

    Throws

• getShipment:function

  • getShipment(
        requestParameters: ShippingApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentResponse>

    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

    • requestParameters: ShippingApiGetShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentResponse>

    Throws

• getTrackingInformation:function

  • getTrackingInformation(
        requestParameters: ShippingApiGetTrackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetTrackingInformationResponse>

    Return the tracking information of a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • requestParameters: ShippingApiGetTrackingInformationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetTrackingInformationResponse>

    Throws

• purchaseLabels:function

  • purchaseLabels(
        requestParameters: ShippingApiPurchaseLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PurchaseLabelsResponse>

    Purchase shipping labels based on a given rate. 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: ShippingApiPurchaseLabelsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PurchaseLabelsResponse>

    Throws

• purchaseShipment:function

  • purchaseShipment(
        requestParameters: ShippingApiPurchaseShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PurchaseShipmentResponse>

    Purchase shipping labels. 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: ShippingApiPurchaseShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PurchaseShipmentResponse>

    Throws

• retrieveShippingLabel:function

  • retrieveShippingLabel(
        requestParameters: ShippingApiRetrieveShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RetrieveShippingLabelResponse>

    Retrieve shipping label based on the shipment id and tracking id. 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: ShippingApiRetrieveShippingLabelRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RetrieveShippingLabelResponse>

    Throws