Module @sp-api-sdk/listings-items-api-2021-08-01 - v2.8.1

listings-items-api-2021-08-01

The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.

For more information, see the Listings Items API 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/listings-items-api-2021-08-01
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {ListingsItemsApiClient} from '@sp-api-sdk/listings-items-api-2021-08-01'

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

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

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

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

ListingsItemsApi
ListingsItemsApiClient

Interfaces

Audience
ErrorList
FulfillmentAvailability
Issue
IssueEnforcementAction
IssueEnforcements
IssueExemption
Item
ItemIdentifiersByMarketplace
ItemImage
ItemOfferByMarketplace
ItemProcurement
ItemSearchResults
ItemSummaryByMarketplace
ListingsItemPatchRequest
ListingsItemPutRequest
ListingsItemsApiDeleteListingsItemRequest
ListingsItemsApiGetListingsItemRequest
ListingsItemsApiPatchListingsItemRequest
ListingsItemsApiPutListingsItemRequest
ListingsItemSubmissionResponse
ModelError
Money
Pagination
PatchOperation
Points

Type Aliases

GetListingsItemIncludedDataEnum
IssueExemptionStatusEnum
IssueSeverityEnum
ItemOfferByMarketplaceOfferTypeEnum
ItemSummaryByMarketplaceConditionTypeEnum
ItemSummaryByMarketplaceStatusEnum
ListingsItemPutRequestRequirementsEnum
ListingsItemSubmissionResponseStatusEnum
PatchListingsItemIncludedDataEnum
PatchListingsItemModeEnum
PatchOperationOpEnum
PutListingsItemIncludedDataEnum
PutListingsItemModeEnum

Variables

clientRateLimits
GetListingsItemIncludedDataEnum
IssueExemptionStatusEnum
IssueSeverityEnum
ItemOfferByMarketplaceOfferTypeEnum
ItemSummaryByMarketplaceConditionTypeEnum
ItemSummaryByMarketplaceStatusEnum
ListingsItemPutRequestRequirementsEnum
ListingsItemSubmissionResponseStatusEnum
PatchListingsItemIncludedDataEnum
PatchListingsItemModeEnum
PatchOperationOpEnum
PutListingsItemIncludedDataEnum
PutListingsItemModeEnum

Functions

ListingsItemsApiAxiosParamCreator
ListingsItemsApiFactory
ListingsItemsApiFp