Selling Partner API SDK for JavaScript
    Preparing search index...

    Module @sp-api-sdk/customer-feedback-api-2024-06-01 - v1.1.5

    customer-feedback-api-2024-06-01

    npm version XO code style

    The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.

    Bizon

    Learn more about this Selling Partner API by visiting the official documentation.

    Also, see the generated documentation for this API client.

    npm install @sp-api-sdk/customer-feedback-api-2024-06-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {CustomerFeedbackApiClient} from '@sp-api-sdk/customer-feedback-api-2024-06-01'

    const auth = new SellingPartnerApiAuth({
    clientId: process.env.LWA_CLIENT_ID,
    clientSecret: process.env.LWA_CLIENT_SECRET,
    refreshToken: 'Atzr|…',
    })

    const client = new CustomerFeedbackApiClient({
    auth,
    region: 'eu',
    })

    In order to retry rate limited requests (HTTP 429), you can configure the API client as such:

    const client = new CustomerFeedbackApiClient({
    auth,
    region: 'eu',
    rateLimiting: {
    retry: true,
    // Optionally specify a callback that will be called on every retry.
    onRetry: (retryInfo) => {
    console.log(retryInfo)
    },
    },
    })

    The rate limits used for each route are specified in the API documentation.

    You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

    const client = new CustomerFeedbackApiClient({
    auth,
    region: 'eu',
    logging: {
    request: {
    logger: console.debug
    },
    response: {
    logger: console.debug
    },
    error: true,
    },
    })

    Specifying true will use the default options, specifying an object will allow you to override the default options.
    This uses axios-logger under the hood.
    By default, if enabled, the request and response loggers will use console.info and the error logger will use console.error.

    MIT

        ╚⊙ ⊙╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝

    Classes

    CustomerFeedbackApi
    CustomerFeedbackApiClient

    Interfaces

    BrowseNodeAllOccurrence
    BrowseNodeAllStarRatingImpact
    BrowseNodeOccurrence
    BrowseNodeResponse
    BrowseNodeReturnTopics
    BrowseNodeReturnTopicsResponse
    BrowseNodeReturnTrend
    BrowseNodeReturnTrendPoint
    BrowseNodeReturnTrendsResponse
    BrowseNodeReviewSubtopicMetrics
    BrowseNodeReviewTopic
    BrowseNodeReviewTopicMetrics
    BrowseNodeReviewTopics
    BrowseNodeReviewTopicsResponse
    BrowseNodeReviewTrend
    BrowseNodeReviewTrendMetrics
    BrowseNodeReviewTrendPoint
    BrowseNodeReviewTrends
    BrowseNodeReviewTrendsResponse
    BrowseNodeStarRatingImpact
    BrowseNodeSubtopic
    BrowseNodeTrendMetrics
    ChildAsinMentionMetrics
    ChildAsinMetrics
    CustomerFeedbackApiGetBrowseNodeReturnTopicsRequest
    CustomerFeedbackApiGetBrowseNodeReturnTrendsRequest
    CustomerFeedbackApiGetBrowseNodeReviewTopicsRequest
    CustomerFeedbackApiGetBrowseNodeReviewTrendsRequest
    CustomerFeedbackApiGetItemBrowseNodeRequest
    CustomerFeedbackApiGetItemReviewTopicsRequest
    CustomerFeedbackApiGetItemReviewTrendsRequest
    DateRange
    ErrorList
    ItemReviewBrowseNodeMetrics
    ItemReviewSubtopic
    ItemReviewSubtopicMetrics
    ItemReviewTopic
    ItemReviewTopicMetrics
    ItemReviewTopics
    ItemReviewTopicsResponse
    ItemReviewTrend
    ItemReviewTrendPoint
    ItemReviewTrends
    ItemReviewTrendsResponse
    ModelError
    ReviewTrendMetrics

    Variables

    clientRateLimits

    Functions

    CustomerFeedbackApiAxiosParamCreator
    CustomerFeedbackApiFactory
    CustomerFeedbackApiFp