Package software.amazon.spapi.api.solicitations.v1

Class SolicitationsApi

  • public class SolicitationsApi
extends java.lang.Object

    • Field Detail

      • createProductReviewAndSellerFeedbackSolicitationBucket

        public final io.github.bucket4j.Bucket createProductReviewAndSellerFeedbackSolicitationBucket

      • getSolicitationActionsForOrderBucket

        public final io.github.bucket4j.Bucket getSolicitationActionsForOrderBucket

    • Constructor Detail

      • SolicitationsApi

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

    • Method Detail

      • createProductReviewAndSellerFeedbackSolicitation

        public CreateProductReviewAndSellerFeedbackSolicitationResponse createProductReviewAndSellerFeedbackSolicitation​(java.lang.String amazonOrderId,
                                                                                                                 java.util.List<java.lang.String> marketplaceIds)
                                                                                                          throws ApiException,
                                                                                                                 LWAException
        Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which a solicitation is sent. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (required)
        Returns:
        CreateProductReviewAndSellerFeedbackSolicitationResponse
        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

      • createProductReviewAndSellerFeedbackSolicitationWithHttpInfo

        public ApiResponse<CreateProductReviewAndSellerFeedbackSolicitationResponse> createProductReviewAndSellerFeedbackSolicitationWithHttpInfo​(java.lang.String amazonOrderId,
                                                                                                                                          java.util.List<java.lang.String> marketplaceIds)
                                                                                                                                   throws ApiException,
                                                                                                                                          LWAException
        Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which a solicitation is sent. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (required)
        Returns:
        ApiResponse<CreateProductReviewAndSellerFeedbackSolicitationResponse>
        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

      • createProductReviewAndSellerFeedbackSolicitationAsync

        public okhttp3.Call createProductReviewAndSellerFeedbackSolicitationAsync​(java.lang.String amazonOrderId,
                                                                          java.util.List<java.lang.String> marketplaceIds,
                                                                          ApiCallback<CreateProductReviewAndSellerFeedbackSolicitationResponse> callback)
                                                                   throws ApiException,
                                                                          LWAException
        (asynchronously) Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which a solicitation is sent. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (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

      • getSolicitationActionsForOrder

        public GetSolicitationActionsForOrderResponse getSolicitationActionsForOrder​(java.lang.String amazonOrderId,
                                                                             java.util.List<java.lang.String> marketplaceIds)
                                                                      throws ApiException,
                                                                             LWAException
        Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (required)
        Returns:
        GetSolicitationActionsForOrderResponse
        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

      • getSolicitationActionsForOrderWithHttpInfo

        public ApiResponse<GetSolicitationActionsForOrderResponse> getSolicitationActionsForOrderWithHttpInfo​(java.lang.String amazonOrderId,
                                                                                                      java.util.List<java.lang.String> marketplaceIds)
                                                                                               throws ApiException,
                                                                                                      LWAException
        Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (required)
        Returns:
        ApiResponse<GetSolicitationActionsForOrderResponse>
        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

      • getSolicitationActionsForOrderAsync

        public okhttp3.Call getSolicitationActionsForOrderAsync​(java.lang.String amazonOrderId,
                                                        java.util.List<java.lang.String> marketplaceIds,
                                                        ApiCallback<GetSolicitationActionsForOrderResponse> callback)
                                                 throws ApiException,
                                                        LWAException
        (asynchronously) Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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:
        amazonOrderId - An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. (required)
        marketplaceIds - A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. (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