Module @sp-api-sdk/solicitations-api-v1 - v2.3.5

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 JSON Hypertext Application Language (HAL) standard.

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/solicitations-api-v1
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {SolicitationsApiClient} from '@sp-api-sdk/solicitations-api-v1'

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

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

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

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

SolicitationsApi
SolicitationsApiClient

Interfaces

CreateProductReviewAndSellerFeedbackSolicitationResponse
GetSchemaResponse
GetSchemaResponseLinks
GetSolicitationActionResponse
GetSolicitationActionResponseEmbedded
GetSolicitationActionResponseLinks
GetSolicitationActionsForOrderResponse
GetSolicitationActionsForOrderResponseEmbedded
GetSolicitationActionsForOrderResponseLinks
LinkObject
ModelError
SolicitationsAction
SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest
SolicitationsApiGetSolicitationActionsForOrderRequest

Variables

clientRateLimits

Functions

SolicitationsApiAxiosParamCreator
SolicitationsApiFactory
SolicitationsApiFp