@sp-api-sdk/product-type-definitions-api-2020-09-01

product-type-definitions-api-2020-09-01

The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).

For more information, see the Product Type Definitions API Use Case Guide.

Documentation

Learn more about this Selling Partner API by visiting the official documentation.

Also, see the generated documentation for this API client.

Installing

npm install @sp-api-sdk/product-type-definitions-api-2020-09-01

Getting Started

import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {ProductTypeDefinitionsApiClient} from '@sp-api-sdk/product-type-definitions-api-2020-09-01'

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

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

Rate Limiting

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

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

Logging

You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

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

License

MIT

Miscellaneous

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