@sp-api-sdk/reports-api-2020-09-04

reports-api-2020-09-04

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

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/reports-api-2020-09-04

Getting Started

import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {ReportsApiClient} from '@sp-api-sdk/reports-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 ReportsApiClient({
  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 ReportsApiClient({
  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 ReportsApiClient({
  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

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