Function SolicitationsApiFp

SolicitationsApi - functional programming interface

Export

  • SolicitationsApiFp(
        configuration?: Configuration,
    ): {
        createProductReviewAndSellerFeedbackSolicitation(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<
                CreateProductReviewAndSellerFeedbackSolicitationResponse,
            >,
        >;
        getSolicitationActionsForOrder(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetSolicitationActionsForOrderResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        createProductReviewAndSellerFeedbackSolicitation(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<
                CreateProductReviewAndSellerFeedbackSolicitationResponse,
            >,
        >;
        getSolicitationActionsForOrder(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetSolicitationActionsForOrderResponse>,
        >;
    }

    • createProductReviewAndSellerFeedbackSolicitation:function
      • createProductReviewAndSellerFeedbackSolicitation(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateProductReviewAndSellerFeedbackSolicitationResponse>,
        >

      • 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.

        Parameters

        • amazonOrderId: string

          An Amazon order identifier. This specifies the order for which a solicitation is sent.

        • marketplaceIds: string[]

          A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateProductReviewAndSellerFeedbackSolicitationResponse>,
        >

        Throws

    • getSolicitationActionsForOrder:function
      • getSolicitationActionsForOrder(
            amazonOrderId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetSolicitationActionsForOrderResponse>,
        >

      • 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.

        Parameters

        • amazonOrderId: string

          An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.

        • marketplaceIds: string[]

          A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetSolicitationActionsForOrderResponse>,
        >

        Throws

Settings

Member Visibility