Package software.amazon.spapi.api.replenishment.v2022_11_07

Class OffersApi

  • public class OffersApi
extends java.lang.Object

    • Field Detail

      • listOfferMetricsBucket

        public final io.github.bucket4j.Bucket listOfferMetricsBucket

      • listOffersBucket

        public final io.github.bucket4j.Bucket listOffersBucket

    • Constructor Detail

      • OffersApi

        public OffersApi​(ApiClient apiClient,
                 java.lang.Boolean disableRateLimiting)

    • Method Detail

      • listOfferMetrics

        public ListOfferMetricsResponse listOfferMetrics​(ListOfferMetricsRequest body)
                                          throws ApiException,
                                                 LWAException
        Returns aggregated replenishment program metrics for a selling partner's offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOfferMetrics` operation. (optional)
        Returns:
        ListOfferMetricsResponse
        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

      • listOfferMetricsWithHttpInfo

        public ApiResponse<ListOfferMetricsResponse> listOfferMetricsWithHttpInfo​(ListOfferMetricsRequest body)
                                                                   throws ApiException,
                                                                          LWAException
        Returns aggregated replenishment program metrics for a selling partner's offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOfferMetrics` operation. (optional)
        Returns:
        ApiResponse<ListOfferMetricsResponse>
        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

      • listOfferMetricsAsync

        public okhttp3.Call listOfferMetricsAsync​(ListOfferMetricsRequest body,
                                          ApiCallback<ListOfferMetricsResponse> callback)
                                   throws ApiException,
                                          LWAException
        (asynchronously) Returns aggregated replenishment program metrics for a selling partner's offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOfferMetrics` operation. (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

      • listOffers

        public ListOffersResponse listOffers​(ListOffersRequest body)
                              throws ApiException,
                                     LWAException
        Returns the details of a selling partner's replenishment program offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOffers` operation. (optional)
        Returns:
        ListOffersResponse
        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

      • listOffersWithHttpInfo

        public ApiResponse<ListOffersResponse> listOffersWithHttpInfo​(ListOffersRequest body)
                                                       throws ApiException,
                                                              LWAException
        Returns the details of a selling partner's replenishment program offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOffers` operation. (optional)
        Returns:
        ApiResponse<ListOffersResponse>
        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

      • listOffersAsync

        public okhttp3.Call listOffersAsync​(ListOffersRequest body,
                                    ApiCallback<ListOffersResponse> callback)
                             throws ApiException,
                                    LWAException
        (asynchronously) Returns the details of a selling partner's replenishment program offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `listOffers` operation. (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