Function ShippingApiFactory

Returns {
    cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelShipmentResponse>;
    directPurchaseShipment(requestParameters: ShippingApiDirectPurchaseShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DirectPurchaseResponse>;
    generateCollectionForm(requestParameters: ShippingApiGenerateCollectionFormRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionFormResponse>;
    getAccessPoints(requestParameters: ShippingApiGetAccessPointsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccessPointsResponse>;
    getAdditionalInputs(requestParameters: ShippingApiGetAdditionalInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAdditionalInputsResponse>;
    getCarrierAccountFormInputs(requestParameters?: ShippingApiGetCarrierAccountFormInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCarrierAccountFormInputsResponse>;
    getCarrierAccounts(requestParameters: ShippingApiGetCarrierAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCarrierAccountsResponse>;
    getCollectionForm(requestParameters: ShippingApiGetCollectionFormRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCollectionFormResponse>;
    getCollectionFormHistory(requestParameters: ShippingApiGetCollectionFormHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCollectionFormHistoryResponse>;
    getRates(requestParameters: ShippingApiGetRatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetRatesResponse>;
    getShipmentDocuments(requestParameters: ShippingApiGetShipmentDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDocumentsResponse>;
    getTracking(requestParameters: ShippingApiGetTrackingRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetTrackingResponse>;
    getUnmanifestedShipments(requestParameters: ShippingApiGetUnmanifestedShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUnmanifestedShipmentsResponse>;
    linkCarrierAccount(requestParameters: ShippingApiLinkCarrierAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<LinkCarrierAccountResponse>;
    oneClickShipment(requestParameters: ShippingApiOneClickShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<OneClickShipmentResponse>;
    purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PurchaseShipmentResponse>;
    unlinkCarrierAccount(requestParameters: ShippingApiUnlinkCarrierAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnlinkCarrierAccountResponse>;
}

• cancelShipment:function

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

  • 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

    • requestParameters: ShippingApiCancelShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelShipmentResponse>

    Throws

• directPurchaseShipment:function

  • directPurchaseShipment(requestParameters, options?): AxiosPromise<DirectPurchaseResponse>

  • 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

    • requestParameters: ShippingApiDirectPurchaseShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DirectPurchaseResponse>

    Throws

• generateCollectionForm:function

  • generateCollectionForm(requestParameters, options?): AxiosPromise<GenerateCollectionFormResponse>

  • This API Call to generate the collection form. 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: ShippingApiGenerateCollectionFormRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GenerateCollectionFormResponse>

    Throws

• getAccessPoints:function

  • getAccessPoints(requestParameters, options?): AxiosPromise<GetAccessPointsResponse>

  • 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

    • requestParameters: ShippingApiGetAccessPointsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAccessPointsResponse>

    Throws

• getAdditionalInputs:function

  • getAdditionalInputs(requestParameters, options?): AxiosPromise<GetAdditionalInputsResponse>

  • 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

    • requestParameters: ShippingApiGetAdditionalInputsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAdditionalInputsResponse>

    Throws

• getCarrierAccountFormInputs:function

  • getCarrierAccountFormInputs(requestParameters?, options?): AxiosPromise<GetCarrierAccountFormInputsResponse>

  • This API will return a list of input schema required to register a shipper account with the carrier. 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: ShippingApiGetCarrierAccountFormInputsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCarrierAccountFormInputsResponse>

    Throws

• getCarrierAccounts:function

  • getCarrierAccounts(requestParameters, options?): AxiosPromise<GetCarrierAccountsResponse>

  • This API will return Get all carrier accounts for a merchant. 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: ShippingApiGetCarrierAccountsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCarrierAccountsResponse>

    Throws

• getCollectionForm:function

  • getCollectionForm(requestParameters, options?): AxiosPromise<GetCollectionFormResponse>

  • This API reprint a collection form. 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: ShippingApiGetCollectionFormRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCollectionFormResponse>

    Throws

• getCollectionFormHistory:function

  • getCollectionFormHistory(requestParameters, options?): AxiosPromise<GetCollectionFormHistoryResponse>

  • This API Call to get the history of the previously generated collection forms. 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: ShippingApiGetCollectionFormHistoryRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCollectionFormHistoryResponse>

    Throws

• getRates:function

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

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

    Throws

• getShipmentDocuments:function

  • getShipmentDocuments(requestParameters, options?): AxiosPromise<GetShipmentDocumentsResponse>

  • Returns the shipping documents associated with a package in a 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

    • requestParameters: ShippingApiGetShipmentDocumentsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentDocumentsResponse>

    Throws

• getTracking:function

  • getTracking(requestParameters, options?): AxiosPromise<GetTrackingResponse>

  • 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

    • requestParameters: ShippingApiGetTrackingRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetTrackingResponse>

    Throws

• getUnmanifestedShipments:function

  • getUnmanifestedShipments(requestParameters, options?): AxiosPromise<GetUnmanifestedShipmentsResponse>

  • This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. 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: ShippingApiGetUnmanifestedShipmentsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetUnmanifestedShipmentsResponse>

    Throws

• linkCarrierAccount:function

  • linkCarrierAccount(requestParameters, options?): AxiosPromise<LinkCarrierAccountResponse>

  • This API associates/links the specified carrier account with the merchant. 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: ShippingApiLinkCarrierAccountRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LinkCarrierAccountResponse>

    Throws

• oneClickShipment:function

  • oneClickShipment(requestParameters, options?): AxiosPromise<OneClickShipmentResponse>

  • 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

    • requestParameters: ShippingApiOneClickShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<OneClickShipmentResponse>

    Throws

• purchaseShipment:function

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

  • 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

    • requestParameters: ShippingApiPurchaseShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PurchaseShipmentResponse>

    Throws

• unlinkCarrierAccount:function

  • unlinkCarrierAccount(requestParameters, options?): AxiosPromise<UnlinkCarrierAccountResponse>

  • This API Unlink the specified carrier account with the merchant. 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: ShippingApiUnlinkCarrierAccountRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UnlinkCarrierAccountResponse>

    Throws