Package software.amazon.spapi.api.orders.v0

Class ShipmentApi

  • public class ShipmentApi
extends java.lang.Object

    • Constructor Detail

      • ShipmentApi

        public ShipmentApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • updateShipmentStatus

        public void updateShipmentStatus​(UpdateShipmentStatusRequest body,
                                 java.lang.String orderId)
                          throws ApiException,
                                 LWAException
        Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `updateShipmentStatus` operation. (required)
        orderId - An Amazon-defined order identifier, in 3-7-7 format. (required)
        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

      • updateShipmentStatusWithHttpInfo

        public ApiResponse<java.lang.Void> updateShipmentStatusWithHttpInfo​(UpdateShipmentStatusRequest body,
                                                                    java.lang.String orderId)
                                                             throws ApiException,
                                                                    LWAException
        Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `updateShipmentStatus` operation. (required)
        orderId - An Amazon-defined order identifier, in 3-7-7 format. (required)
        Returns:
        ApiResponse<Void>
        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

      • updateShipmentStatusAsync

        public okhttp3.Call updateShipmentStatusAsync​(UpdateShipmentStatusRequest body,
                                              java.lang.String orderId,
                                              ApiCallback<java.lang.Void> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `updateShipmentStatus` operation. (required)
        orderId - An Amazon-defined order identifier, in 3-7-7 format. (required)
        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