Package software.amazon.spapi.api.shipping.v2

Class ShippingApi

  • public class ShippingApi
extends java.lang.Object

    • Constructor Detail

      • ShippingApi

        public ShippingApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • cancelShipmentCall

        public okhttp3.Call cancelShipmentCall​(java.lang.String shipmentId,
                                       java.lang.String xAmznShippingBusinessId,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException,
                                       LWAException
        Build call for cancelShipment
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • cancelShipment

        public CancelShipmentResponse cancelShipment​(java.lang.String shipmentId,
                                             java.lang.String xAmznShippingBusinessId)
                                      throws ApiException,
                                             LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        CancelShipmentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • cancelShipmentWithHttpInfo

        public ApiResponse<CancelShipmentResponse> cancelShipmentWithHttpInfo​(java.lang.String shipmentId,
                                                                      java.lang.String xAmznShippingBusinessId)
                                                               throws ApiException,
                                                                      LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<CancelShipmentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • cancelShipmentAsync

        public okhttp3.Call cancelShipmentAsync​(java.lang.String shipmentId,
                                        java.lang.String xAmznShippingBusinessId,
                                        ApiCallback<CancelShipmentResponse> callback)
                                 throws ApiException,
                                        LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • directPurchaseShipmentCall

        public okhttp3.Call directPurchaseShipmentCall​(DirectPurchaseRequest body,
                                               java.lang.String xAmznIdempotencyKey,
                                               java.lang.String locale,
                                               java.lang.String xAmznShippingBusinessId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException,
                                               LWAException
        Build call for directPurchaseShipment
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        locale - The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • directPurchaseShipment

        public DirectPurchaseResponse directPurchaseShipment​(DirectPurchaseRequest body,
                                                     java.lang.String xAmznIdempotencyKey,
                                                     java.lang.String locale,
                                                     java.lang.String xAmznShippingBusinessId)
                                              throws ApiException,
                                                     LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        locale - The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        DirectPurchaseResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • directPurchaseShipmentWithHttpInfo

        public ApiResponse<DirectPurchaseResponse> directPurchaseShipmentWithHttpInfo​(DirectPurchaseRequest body,
                                                                              java.lang.String xAmznIdempotencyKey,
                                                                              java.lang.String locale,
                                                                              java.lang.String xAmznShippingBusinessId)
                                                                       throws ApiException,
                                                                              LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        locale - The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<DirectPurchaseResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • directPurchaseShipmentAsync

        public okhttp3.Call directPurchaseShipmentAsync​(DirectPurchaseRequest body,
                                                java.lang.String xAmznIdempotencyKey,
                                                java.lang.String locale,
                                                java.lang.String xAmznShippingBusinessId,
                                                ApiCallback<DirectPurchaseResponse> callback)
                                         throws ApiException,
                                                LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        locale - The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • generateCollectionFormCall

        public okhttp3.Call generateCollectionFormCall​(GenerateCollectionFormRequest body,
                                               java.lang.String xAmznIdempotencyKey,
                                               java.lang.String xAmznShippingBusinessId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException,
                                               LWAException
        Build call for generateCollectionForm
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • generateCollectionForm

        public GenerateCollectionFormResponse generateCollectionForm​(GenerateCollectionFormRequest body,
                                                             java.lang.String xAmznIdempotencyKey,
                                                             java.lang.String xAmznShippingBusinessId)
                                                      throws ApiException,
                                                             LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GenerateCollectionFormResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • generateCollectionFormWithHttpInfo

        public ApiResponse<GenerateCollectionFormResponse> generateCollectionFormWithHttpInfo​(GenerateCollectionFormRequest body,
                                                                                      java.lang.String xAmznIdempotencyKey,
                                                                                      java.lang.String xAmznShippingBusinessId)
                                                                               throws ApiException,
                                                                                      LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GenerateCollectionFormResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • generateCollectionFormAsync

        public okhttp3.Call generateCollectionFormAsync​(GenerateCollectionFormRequest body,
                                                java.lang.String xAmznIdempotencyKey,
                                                java.lang.String xAmznShippingBusinessId,
                                                ApiCallback<GenerateCollectionFormResponse> callback)
                                         throws ApiException,
                                                LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getAccessPointsCall

        public okhttp3.Call getAccessPointsCall​(java.util.List<java.lang.String> accessPointTypes,
                                        java.lang.String countryCode,
                                        java.lang.String postalCode,
                                        java.lang.String xAmznShippingBusinessId,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException,
                                        LWAException
        Build call for getAccessPoints
        Parameters:
        accessPointTypes - (required)
        countryCode - (required)
        postalCode - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getAccessPoints

        public GetAccessPointsResponse getAccessPoints​(java.util.List<java.lang.String> accessPointTypes,
                                               java.lang.String countryCode,
                                               java.lang.String postalCode,
                                               java.lang.String xAmznShippingBusinessId)
                                        throws ApiException,
                                               LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        accessPointTypes - (required)
        countryCode - (required)
        postalCode - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetAccessPointsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getAccessPointsWithHttpInfo

        public ApiResponse<GetAccessPointsResponse> getAccessPointsWithHttpInfo​(java.util.List<java.lang.String> accessPointTypes,
                                                                        java.lang.String countryCode,
                                                                        java.lang.String postalCode,
                                                                        java.lang.String xAmznShippingBusinessId)
                                                                 throws ApiException,
                                                                        LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        accessPointTypes - (required)
        countryCode - (required)
        postalCode - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetAccessPointsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getAccessPointsAsync

        public okhttp3.Call getAccessPointsAsync​(java.util.List<java.lang.String> accessPointTypes,
                                         java.lang.String countryCode,
                                         java.lang.String postalCode,
                                         java.lang.String xAmznShippingBusinessId,
                                         ApiCallback<GetAccessPointsResponse> callback)
                                  throws ApiException,
                                         LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        accessPointTypes - (required)
        countryCode - (required)
        postalCode - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getAdditionalInputsCall

        public okhttp3.Call getAdditionalInputsCall​(java.lang.String requestToken,
                                            java.lang.String rateId,
                                            java.lang.String xAmznShippingBusinessId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException,
                                            LWAException
        Build call for getAdditionalInputs
        Parameters:
        requestToken - The request token returned in the response to the getRates operation. (required)
        rateId - The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getAdditionalInputs

        public GetAdditionalInputsResponse getAdditionalInputs​(java.lang.String requestToken,
                                                       java.lang.String rateId,
                                                       java.lang.String xAmznShippingBusinessId)
                                                throws ApiException,
                                                       LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        requestToken - The request token returned in the response to the getRates operation. (required)
        rateId - The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetAdditionalInputsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getAdditionalInputsWithHttpInfo

        public ApiResponse<GetAdditionalInputsResponse> getAdditionalInputsWithHttpInfo​(java.lang.String requestToken,
                                                                                java.lang.String rateId,
                                                                                java.lang.String xAmznShippingBusinessId)
                                                                         throws ApiException,
                                                                                LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        requestToken - The request token returned in the response to the getRates operation. (required)
        rateId - The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetAdditionalInputsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getAdditionalInputsAsync

        public okhttp3.Call getAdditionalInputsAsync​(java.lang.String requestToken,
                                             java.lang.String rateId,
                                             java.lang.String xAmznShippingBusinessId,
                                             ApiCallback<GetAdditionalInputsResponse> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        requestToken - The request token returned in the response to the getRates operation. (required)
        rateId - The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountFormInputsCall

        public okhttp3.Call getCarrierAccountFormInputsCall​(java.lang.String xAmznShippingBusinessId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException,
                                                    LWAException
        Build call for getCarrierAccountFormInputs
        Parameters:
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountFormInputs

        public GetCarrierAccountFormInputsResponse getCarrierAccountFormInputs​(java.lang.String xAmznShippingBusinessId)
                                                                throws ApiException,
                                                                       LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetCarrierAccountFormInputsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountFormInputsWithHttpInfo

        public ApiResponse<GetCarrierAccountFormInputsResponse> getCarrierAccountFormInputsWithHttpInfo​(java.lang.String xAmznShippingBusinessId)
                                                                                         throws ApiException,
                                                                                                LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetCarrierAccountFormInputsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountFormInputsAsync

        public okhttp3.Call getCarrierAccountFormInputsAsync​(java.lang.String xAmznShippingBusinessId,
                                                     ApiCallback<GetCarrierAccountFormInputsResponse> callback)
                                              throws ApiException,
                                                     LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccounts

        public GetCarrierAccountsResponse getCarrierAccounts​(GetCarrierAccountsRequest body,
                                                     java.lang.String xAmznShippingBusinessId)
                                              throws ApiException,
                                                     LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetCarrierAccountsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountsWithHttpInfo

        public ApiResponse<GetCarrierAccountsResponse> getCarrierAccountsWithHttpInfo​(GetCarrierAccountsRequest body,
                                                                              java.lang.String xAmznShippingBusinessId)
                                                                       throws ApiException,
                                                                              LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetCarrierAccountsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCarrierAccountsAsync

        public okhttp3.Call getCarrierAccountsAsync​(GetCarrierAccountsRequest body,
                                            java.lang.String xAmznShippingBusinessId,
                                            ApiCallback<GetCarrierAccountsResponse> callback)
                                     throws ApiException,
                                            LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormCall

        public okhttp3.Call getCollectionFormCall​(java.lang.String collectionFormId,
                                          java.lang.String xAmznShippingBusinessId,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException,
                                          LWAException
        Build call for getCollectionForm
        Parameters:
        collectionFormId - collection form Id to reprint a collection. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCollectionForm

        public GetCollectionFormResponse getCollectionForm​(java.lang.String collectionFormId,
                                                   java.lang.String xAmznShippingBusinessId)
                                            throws ApiException,
                                                   LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        collectionFormId - collection form Id to reprint a collection. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetCollectionFormResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormWithHttpInfo

        public ApiResponse<GetCollectionFormResponse> getCollectionFormWithHttpInfo​(java.lang.String collectionFormId,
                                                                            java.lang.String xAmznShippingBusinessId)
                                                                     throws ApiException,
                                                                            LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        collectionFormId - collection form Id to reprint a collection. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetCollectionFormResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormAsync

        public okhttp3.Call getCollectionFormAsync​(java.lang.String collectionFormId,
                                           java.lang.String xAmznShippingBusinessId,
                                           ApiCallback<GetCollectionFormResponse> callback)
                                    throws ApiException,
                                           LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        collectionFormId - collection form Id to reprint a collection. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormHistory

        public GetCollectionFormHistoryResponse getCollectionFormHistory​(GetCollectionFormHistoryRequest body,
                                                                 java.lang.String xAmznShippingBusinessId)
                                                          throws ApiException,
                                                                 LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetCollectionFormHistoryResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormHistoryWithHttpInfo

        public ApiResponse<GetCollectionFormHistoryResponse> getCollectionFormHistoryWithHttpInfo​(GetCollectionFormHistoryRequest body,
                                                                                          java.lang.String xAmznShippingBusinessId)
                                                                                   throws ApiException,
                                                                                          LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetCollectionFormHistoryResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getCollectionFormHistoryAsync

        public okhttp3.Call getCollectionFormHistoryAsync​(GetCollectionFormHistoryRequest body,
                                                  java.lang.String xAmznShippingBusinessId,
                                                  ApiCallback<GetCollectionFormHistoryResponse> callback)
                                           throws ApiException,
                                                  LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getRates

        public GetRatesResponse getRates​(GetRatesRequest body,
                                 java.lang.String xAmznShippingBusinessId)
                          throws ApiException,
                                 LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetRatesResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getRatesWithHttpInfo

        public ApiResponse<GetRatesResponse> getRatesWithHttpInfo​(GetRatesRequest body,
                                                          java.lang.String xAmznShippingBusinessId)
                                                   throws ApiException,
                                                          LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetRatesResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getRatesAsync

        public okhttp3.Call getRatesAsync​(GetRatesRequest body,
                                  java.lang.String xAmznShippingBusinessId,
                                  ApiCallback<GetRatesResponse> callback)
                           throws ApiException,
                                  LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDocumentsCall

        public okhttp3.Call getShipmentDocumentsCall​(java.lang.String shipmentId,
                                             java.lang.String packageClientReferenceId,
                                             java.lang.String format,
                                             java.math.BigDecimal dpi,
                                             java.lang.String xAmznShippingBusinessId,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException,
                                             LWAException
        Build call for getShipmentDocuments
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        packageClientReferenceId - The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)
        format - The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)
        dpi - The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDocuments

        public GetShipmentDocumentsResponse getShipmentDocuments​(java.lang.String shipmentId,
                                                         java.lang.String packageClientReferenceId,
                                                         java.lang.String format,
                                                         java.math.BigDecimal dpi,
                                                         java.lang.String xAmznShippingBusinessId)
                                                  throws ApiException,
                                                         LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        packageClientReferenceId - The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)
        format - The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)
        dpi - The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetShipmentDocumentsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDocumentsWithHttpInfo

        public ApiResponse<GetShipmentDocumentsResponse> getShipmentDocumentsWithHttpInfo​(java.lang.String shipmentId,
                                                                                  java.lang.String packageClientReferenceId,
                                                                                  java.lang.String format,
                                                                                  java.math.BigDecimal dpi,
                                                                                  java.lang.String xAmznShippingBusinessId)
                                                                           throws ApiException,
                                                                                  LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        packageClientReferenceId - The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)
        format - The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)
        dpi - The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetShipmentDocumentsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDocumentsAsync

        public okhttp3.Call getShipmentDocumentsAsync​(java.lang.String shipmentId,
                                              java.lang.String packageClientReferenceId,
                                              java.lang.String format,
                                              java.math.BigDecimal dpi,
                                              java.lang.String xAmznShippingBusinessId,
                                              ApiCallback<GetShipmentDocumentsResponse> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - The shipment identifier originally returned by the purchaseShipment operation. (required)
        packageClientReferenceId - The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)
        format - The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)
        dpi - The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getTrackingCall

        public okhttp3.Call getTrackingCall​(java.lang.String trackingId,
                                    java.lang.String carrierId,
                                    java.lang.String xAmznShippingBusinessId,
                                    ProgressResponseBody.ProgressListener progressListener,
                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                             throws ApiException,
                                    LWAException
        Build call for getTracking
        Parameters:
        trackingId - A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)
        carrierId - A carrier identifier originally returned by the getRates operation for the selected rate. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getTracking

        public GetTrackingResponse getTracking​(java.lang.String trackingId,
                                       java.lang.String carrierId,
                                       java.lang.String xAmznShippingBusinessId)
                                throws ApiException,
                                       LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        trackingId - A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)
        carrierId - A carrier identifier originally returned by the getRates operation for the selected rate. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetTrackingResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getTrackingWithHttpInfo

        public ApiResponse<GetTrackingResponse> getTrackingWithHttpInfo​(java.lang.String trackingId,
                                                                java.lang.String carrierId,
                                                                java.lang.String xAmznShippingBusinessId)
                                                         throws ApiException,
                                                                LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        trackingId - A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)
        carrierId - A carrier identifier originally returned by the getRates operation for the selected rate. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetTrackingResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getTrackingAsync

        public okhttp3.Call getTrackingAsync​(java.lang.String trackingId,
                                     java.lang.String carrierId,
                                     java.lang.String xAmznShippingBusinessId,
                                     ApiCallback<GetTrackingResponse> callback)
                              throws ApiException,
                                     LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        trackingId - A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)
        carrierId - A carrier identifier originally returned by the getRates operation for the selected rate. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getUnmanifestedShipments

        public GetUnmanifestedShipmentsResponse getUnmanifestedShipments​(GetUnmanifestedShipmentsRequest body,
                                                                 java.lang.String xAmznShippingBusinessId)
                                                          throws ApiException,
                                                                 LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        GetUnmanifestedShipmentsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getUnmanifestedShipmentsWithHttpInfo

        public ApiResponse<GetUnmanifestedShipmentsResponse> getUnmanifestedShipmentsWithHttpInfo​(GetUnmanifestedShipmentsRequest body,
                                                                                          java.lang.String xAmznShippingBusinessId)
                                                                                   throws ApiException,
                                                                                          LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<GetUnmanifestedShipmentsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getUnmanifestedShipmentsAsync

        public okhttp3.Call getUnmanifestedShipmentsAsync​(GetUnmanifestedShipmentsRequest body,
                                                  java.lang.String xAmznShippingBusinessId,
                                                  ApiCallback<GetUnmanifestedShipmentsResponse> callback)
                                           throws ApiException,
                                                  LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • linkCarrierAccountCall

        public okhttp3.Call linkCarrierAccountCall​(LinkCarrierAccountRequest body,
                                           java.lang.String carrierId,
                                           java.lang.String xAmznShippingBusinessId,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException,
                                           LWAException
        Build call for linkCarrierAccount
        Parameters:
        body - (required)
        carrierId - The unique identifier associated with the carrier account. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • linkCarrierAccount

        public LinkCarrierAccountResponse linkCarrierAccount​(LinkCarrierAccountRequest body,
                                                     java.lang.String carrierId,
                                                     java.lang.String xAmznShippingBusinessId)
                                              throws ApiException,
                                                     LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - The unique identifier associated with the carrier account. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        LinkCarrierAccountResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • linkCarrierAccountWithHttpInfo

        public ApiResponse<LinkCarrierAccountResponse> linkCarrierAccountWithHttpInfo​(LinkCarrierAccountRequest body,
                                                                              java.lang.String carrierId,
                                                                              java.lang.String xAmznShippingBusinessId)
                                                                       throws ApiException,
                                                                              LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - The unique identifier associated with the carrier account. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<LinkCarrierAccountResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • linkCarrierAccountAsync

        public okhttp3.Call linkCarrierAccountAsync​(LinkCarrierAccountRequest body,
                                            java.lang.String carrierId,
                                            java.lang.String xAmznShippingBusinessId,
                                            ApiCallback<LinkCarrierAccountResponse> callback)
                                     throws ApiException,
                                            LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - The unique identifier associated with the carrier account. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • oneClickShipment

        public OneClickShipmentResponse oneClickShipment​(OneClickShipmentRequest body,
                                                 java.lang.String xAmznShippingBusinessId)
                                          throws ApiException,
                                                 LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        OneClickShipmentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • oneClickShipmentWithHttpInfo

        public ApiResponse<OneClickShipmentResponse> oneClickShipmentWithHttpInfo​(OneClickShipmentRequest body,
                                                                          java.lang.String xAmznShippingBusinessId)
                                                                   throws ApiException,
                                                                          LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<OneClickShipmentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • oneClickShipmentAsync

        public okhttp3.Call oneClickShipmentAsync​(OneClickShipmentRequest body,
                                          java.lang.String xAmznShippingBusinessId,
                                          ApiCallback<OneClickShipmentResponse> callback)
                                   throws ApiException,
                                          LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • purchaseShipmentCall

        public okhttp3.Call purchaseShipmentCall​(PurchaseShipmentRequest body,
                                         java.lang.String xAmznIdempotencyKey,
                                         java.lang.String xAmznShippingBusinessId,
                                         ProgressResponseBody.ProgressListener progressListener,
                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                  throws ApiException,
                                         LWAException
        Build call for purchaseShipment
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • purchaseShipment

        public PurchaseShipmentResponse purchaseShipment​(PurchaseShipmentRequest body,
                                                 java.lang.String xAmznIdempotencyKey,
                                                 java.lang.String xAmznShippingBusinessId)
                                          throws ApiException,
                                                 LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        PurchaseShipmentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • purchaseShipmentWithHttpInfo

        public ApiResponse<PurchaseShipmentResponse> purchaseShipmentWithHttpInfo​(PurchaseShipmentRequest body,
                                                                          java.lang.String xAmznIdempotencyKey,
                                                                          java.lang.String xAmznShippingBusinessId)
                                                                   throws ApiException,
                                                                          LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<PurchaseShipmentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • purchaseShipmentAsync

        public okhttp3.Call purchaseShipmentAsync​(PurchaseShipmentRequest body,
                                          java.lang.String xAmznIdempotencyKey,
                                          java.lang.String xAmznShippingBusinessId,
                                          ApiCallback<PurchaseShipmentResponse> callback)
                                   throws ApiException,
                                          LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        xAmznIdempotencyKey - A unique value which the server uses to recognize subsequent retries of the same request. (optional)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • unlinkCarrierAccountCall

        public okhttp3.Call unlinkCarrierAccountCall​(UnlinkCarrierAccountRequest body,
                                             java.lang.String carrierId,
                                             java.lang.String xAmznShippingBusinessId,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException,
                                             LWAException
        Build call for unlinkCarrierAccount
        Parameters:
        body - (required)
        carrierId - carrier Id to unlink with merchant. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • unlinkCarrierAccount

        public UnlinkCarrierAccountResponse unlinkCarrierAccount​(UnlinkCarrierAccountRequest body,
                                                         java.lang.String carrierId,
                                                         java.lang.String xAmznShippingBusinessId)
                                                  throws ApiException,
                                                         LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - carrier Id to unlink with merchant. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        UnlinkCarrierAccountResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • unlinkCarrierAccountWithHttpInfo

        public ApiResponse<UnlinkCarrierAccountResponse> unlinkCarrierAccountWithHttpInfo​(UnlinkCarrierAccountRequest body,
                                                                                  java.lang.String carrierId,
                                                                                  java.lang.String xAmznShippingBusinessId)
                                                                           throws ApiException,
                                                                                  LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - carrier Id to unlink with merchant. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        Returns:
        ApiResponse<UnlinkCarrierAccountResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • unlinkCarrierAccountAsync

        public okhttp3.Call unlinkCarrierAccountAsync​(UnlinkCarrierAccountRequest body,
                                              java.lang.String carrierId,
                                              java.lang.String xAmznShippingBusinessId,
                                              ApiCallback<UnlinkCarrierAccountResponse> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - (required)
        carrierId - carrier Id to unlink with merchant. (required)
        xAmznShippingBusinessId - Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails