Package Exports

@sp-api-sdk/notifications-api-v1
@sp-api-sdk/notifications-api-v1/dist/cjs/index.js
@sp-api-sdk/notifications-api-v1/dist/es/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sp-api-sdk/notifications-api-v1) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`notifications-api-v1`

The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more.

For more information, see the Notifications Use Case Guide

Installing

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

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

Getting Started

With grantless API

import {SellingPartnerApiAuth, AuthorizationScope} from '@sp-api-sdk/auth'
import {NotificationsApiClient} from '@sp-api-sdk/notifications-api-v1'

const auth = new SellingPartnerApiAuth({
  clientId: '',
  clientSecret: '',
  scopes: [AuthorizationScope.NOTIFICATIONS],
  secretAccessKey: '',
  accessKeyId: '',
  region: '',
  role: {
    arn: '',
  }
})


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

With access token

import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {NotificationsApiClient} from '@sp-api-sdk/notifications-api-v1'

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

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