Neatly Planned Meal

    @sp-api-sdk/messaging-api-v1
    TypeScript icon, indicating that this package has built-in type declarations

    1.10.6 • Public • Published

    messaging-api-v1

    With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.

    npm version XO code style

    Documentation

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

    Also, see the generated documentation for this API client.

    Installing

    yarn add @sp-api-sdk/messaging-api-v1
    npm install @sp-api-sdk/messaging-api-v1

    Getting Started

    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {MessagingApiClient} from '@sp-api-sdk/messaging-api-v1'
    
    const auth = new SellingPartnerApiAuth({
      clientId: process.env.LWA_CLIENT_ID,
      clientSecret: process.env.LWA_CLIENT_SECRET,
      refreshToken: 'Atzr|…',
      accessKeyId: '',
      secretAccessKey: '',
      role: {
        arn: 'arn:aws:iam::…',
      },
    })
    
    const client = new MessagingApiClient({
      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 MessagingApiClient({
      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 MessagingApiClient({
      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

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

    Install

    npm i @sp-api-sdk/messaging-api-v1

    DownloadsWeekly Downloads

    95

    Version

    1.10.6

    License

    MIT

    Unpacked Size

    356 kB

    Total Files

    135

    Last publish

    Collaborators

    • tusbar
    • vmqt