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

    Module @sp-api-sdk/product-pricing-api-v0 - v3.1.9

    product-pricing-api-v0

    npm version XO code style

    The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products.

    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/product-pricing-api-v0
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {ProductPricingApiClient} from '@sp-api-sdk/product-pricing-api-v0'

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

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

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

    const client = new ProductPricingApiClient({
    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 ProductPricingApiClient({
    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

    ProductPricingApi
    ProductPricingApiClient

    Interfaces

    ASINIdentifier
    BatchOffersRequestParams
    BatchOffersResponse
    BatchRequest
    BuyBoxPriceType
    CompetitivePriceType
    CompetitivePricingType
    DetailedShippingTimeType
    Errors
    GetItemOffersBatchRequest
    GetItemOffersBatchResponse
    GetListingOffersBatchRequest
    GetListingOffersBatchResponse
    GetOffersHttpStatusLine
    GetOffersResponse
    GetOffersResult
    GetPricingResponse
    HttpResponseHeaders
    IdentifierType
    ItemIdentifier
    ItemOffersRequestParamsAllOf
    ItemOffersResponseAllOf
    ListingOffersRequestParamsAllOf
    ListingOffersResponseAllOf
    LowestPriceType
    ModelError
    MoneyType
    OfferCountType
    OfferDetail
    OfferListingCountType
    OfferType
    Points
    Price
    PriceType
    PrimeInformationType
    Product
    ProductPricingApiGetCompetitivePricingRequest
    ProductPricingApiGetItemOffersBatchRequest
    ProductPricingApiGetItemOffersRequest
    ProductPricingApiGetListingOffersBatchRequest
    ProductPricingApiGetListingOffersRequest
    ProductPricingApiGetPricingRequest
    QuantityDiscountPriceType
    SalesRankType
    SellerFeedbackType
    SellerSKUIdentifier
    ShipsFromType
    Summary

    Type Aliases

    ConditionType
    CustomerType
    DetailedShippingTimeTypeAvailabilityTypeEnum
    FulfillmentChannelType
    GetCompetitivePricingCustomerTypeEnum
    GetCompetitivePricingItemTypeEnum
    GetItemOffersCustomerTypeEnum
    GetItemOffersItemConditionEnum
    GetListingOffersCustomerTypeEnum
    GetListingOffersItemConditionEnum
    GetPricingItemConditionEnum
    GetPricingItemTypeEnum
    GetPricingOfferTypeEnum
    HttpMethod
    ItemCondition
    ItemOffersRequest
    ItemOffersRequestParams
    ItemOffersResponse
    ListingOffersRequest
    ListingOffersRequestParams
    ListingOffersResponse
    OfferCustomerType
    QuantityDiscountType

    Variables

    clientRateLimits
    ConditionType
    CustomerType
    DetailedShippingTimeTypeAvailabilityTypeEnum
    FulfillmentChannelType
    GetCompetitivePricingCustomerTypeEnum
    GetCompetitivePricingItemTypeEnum
    GetItemOffersCustomerTypeEnum
    GetItemOffersItemConditionEnum
    GetListingOffersCustomerTypeEnum
    GetListingOffersItemConditionEnum
    GetPricingItemConditionEnum
    GetPricingItemTypeEnum
    GetPricingOfferTypeEnum
    HttpMethod
    ItemCondition
    OfferCustomerType
    QuantityDiscountType

    Functions

    ProductPricingApiAxiosParamCreator
    ProductPricingApiFactory
    ProductPricingApiFp