Module @sp-api-sdk/catalog-items-api-v0 - v2.3.5

catalog-items-api-v0

The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.

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/catalog-items-api-v0
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {CatalogItemsApiClient} from '@sp-api-sdk/catalog-items-api-v0'

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

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

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

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

CatalogApi
CatalogItemsApiClient

Interfaces

ASINIdentifier
AttributeSetListType
CatalogApiGetCatalogItemRequest
CatalogApiListCatalogCategoriesRequest
CatalogApiListCatalogItemsRequest
Categories
CreatorType
DecimalWithUnits
DimensionType
GetCatalogItemResponse
IdentifierType
Image
Item
LanguageType
ListCatalogCategoriesResponse
ListCatalogItemsResponse
ListMatchingItemsResponse
ModelError
Price
RelationshipType
SalesRankType
SellerSKUIdentifier

Variables

clientRateLimits

Functions

CatalogApiAxiosParamCreator
CatalogApiFactory
CatalogApiFp