@sp-api-sdk/solicitations-api-v1

solicitations-api-v1

With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language (HAL) standard.

Installing

yarn add @sp-api-sdk/solicitations-api-v1

npm install @sp-api-sdk/solicitations-api-v1

Getting Started

import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {SolicitationsApiClient} from '@sp-api-sdk/solicitations-api-v1'

const auth = new SellingPartnerApiAuth({
  clientId: '',
  clientSecret: '',
  refreshToken: '',
  secretAccessKey: '',
  accessKeyId: '',
  region: '',
  role: {
    arn: '',
  }
})

const client = new SolicitationsApiClient({
  auth,
  region: 'eu' // or 'eu-west-1'
})

Handle Rate Limiting

If you want to let the SDK retry after each 429 responses, instanciate the client like this:

const client = new SolicitationsApiClient({
  auth,
  region: 'eu',
  rateLimiting: {
    retry: true,
    onRetry: (retryInfo) => console.log(retryInfo) // Optional
  }
})

The SDK gets the rate limits for each routes from the API documentation

API documentation

See here