Module @sp-api-sdk/product-pricing-api-2022-05-01 - v2.7.2

product-pricing-api-2022-05-01

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

For more information, refer to the Product Pricing v2022-05-01 Use Case Guide.

npm version XO code style

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

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

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

Enumerations

CompetitiveSummaryIncludedData
Condition
FulfillmentType
HttpMethod

Classes

ProductPricingApi
ProductPricingApiClient

Interfaces

BatchRequest
BatchResponse
CompetitiveSummaryBatchRequest
CompetitiveSummaryBatchResponse
CompetitiveSummaryRequest
CompetitiveSummaryResponse
CompetitiveSummaryResponseBody
Errors
FeaturedBuyingOption
FeaturedOffer
FeaturedOfferExpectedPrice
FeaturedOfferExpectedPriceRequestParams
FeaturedOfferExpectedPriceResponseAllOf
FeaturedOfferExpectedPriceResponseBody
FeaturedOfferExpectedPriceResult
FeaturedOfferSegment
GetFeaturedOfferExpectedPriceBatchRequest
GetFeaturedOfferExpectedPriceBatchResponse
HttpStatusLine
LowestPricedOffer
LowestPricedOffersInput
ModelError
MoneyType
Offer
OfferIdentifier
Points
Price
PrimeDetails
ProductPricingApiGetCompetitiveSummaryRequest
ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest
ReferencePrice
SegmentDetails
SegmentedFeaturedOfferAllOf
ShippingOption

Type Aliases

FeaturedBuyingOptionBuyingOptionTypeEnum
FeaturedOfferExpectedPriceRequest
FeaturedOfferExpectedPriceResponse
FeaturedOfferSegmentCustomerMembershipEnum
LowestPricedOffersInputOfferTypeEnum
OfferSubConditionEnum
PrimeDetailsEligibilityEnum
SegmentedFeaturedOffer
ShippingOptionShippingOptionTypeEnum

Variables

clientRateLimits
FeaturedBuyingOptionBuyingOptionTypeEnum
FeaturedOfferSegmentCustomerMembershipEnum
LowestPricedOffersInputOfferTypeEnum
OfferSubConditionEnum
PrimeDetailsEligibilityEnum
ShippingOptionShippingOptionTypeEnum

Functions

ProductPricingApiAxiosParamCreator
ProductPricingApiFactory
ProductPricingApiFp