Module @sp-api-sdk/feeds-api-2020-09-04 - v2.3.5

feeds-api-2020-09-04

Effective June 27, 2024, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to Feeds v2021-06-30 to avoid service disruption.

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/feeds-api-2020-09-04
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {FeedsApiClient} from '@sp-api-sdk/feeds-api-2020-09-04'

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

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

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

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

FeedsApi
FeedsApiClient

Interfaces

CancelFeedResponse
CreateFeedDocumentResponse
CreateFeedDocumentResult
CreateFeedDocumentSpecification
CreateFeedResponse
CreateFeedResult
CreateFeedSpecification
Feed
FeedDocument
FeedDocumentEncryptionDetails
FeedsApiCancelFeedRequest
FeedsApiCreateFeedDocumentRequest
FeedsApiCreateFeedRequest
FeedsApiGetFeedDocumentRequest
FeedsApiGetFeedRequest
FeedsApiGetFeedsRequest
GetFeedDocumentResponse
GetFeedResponse
GetFeedsResponse
ModelError

Type Aliases

FeedDocumentCompressionAlgorithmEnum
FeedDocumentEncryptionDetailsStandardEnum
FeedProcessingStatusEnum
GetFeedsProcessingStatusesEnum

Variables

clientRateLimits
FeedDocumentCompressionAlgorithmEnum
FeedDocumentEncryptionDetailsStandardEnum
FeedProcessingStatusEnum
GetFeedsProcessingStatusesEnum

Functions

FeedsApiAxiosParamCreator
FeedsApiFactory
FeedsApiFp