Naan and Paneer Makhani

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

    1.10.5 • Public • Published

    finances-api-v0

    The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.

    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/finances-api-v0
    npm install @sp-api-sdk/finances-api-v0

    Getting Started

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

    DownloadsWeekly Downloads

    104

    Version

    1.10.5

    License

    MIT

    Unpacked Size

    261 kB

    Total Files

    159

    Last publish

    Collaborators

    • tusbar
    • vmqt