Selling Partner API SDK for JavaScript
    Preparing search index...

    Module @sp-api-sdk/seller-wallet-api-2024-03-01 - v1.3.3

    seller-wallet-api-2024-03-01

    npm version XO code style

    The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller Wallet accounts. You can also schedule and initiate transactions.

    Bizon

    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/seller-wallet-api-2024-03-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {SellerWalletApiClient} from '@sp-api-sdk/seller-wallet-api-2024-03-01'

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

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

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

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

    SellerWalletApi
    SellerWalletApiClient

    Interfaces

    Balance
    BalanceListing
    BankAccount
    BankAccountListing
    CreateTransactionResponse
    Currency
    DeleteTransferSchedule
    ErrorList
    Fee
    FxRateDetails
    ModelError
    PayeeContactInformation
    PaymentPreference
    ScheduleExpression
    SellerWalletApiCreateTransactionRequest
    SellerWalletApiCreateTransferScheduleRequest
    SellerWalletApiDeleteScheduleTransactionRequest
    SellerWalletApiGetAccountRequest
    SellerWalletApiGetTransactionRequest
    SellerWalletApiGetTransferPreviewRequest
    SellerWalletApiGetTransferScheduleRequest
    SellerWalletApiListAccountBalancesRequest
    SellerWalletApiListAccountsRequest
    SellerWalletApiListAccountTransactionsRequest
    SellerWalletApiListTransferSchedulesRequest
    SellerWalletApiUpdateTransferScheduleRequest
    Transaction
    TransactionAccount
    TransactionInitiationRequest
    TransactionInstrumentDetails
    TransactionListing
    TransferRatePreview
    TransferSchedule
    TransferScheduleFailures
    TransferScheduleInformation
    TransferScheduleListing
    TransferScheduleRequest

    Type Aliases

    BalanceType
    BankAccountHolderStatus
    BankAccountNumberFormat
    BankAccountOwnershipType
    BankNumberFormat
    FeeType
    PayeeEntityType
    PaymentPreferencePaymentType
    RateDirection
    RecurringFrequency
    ScheduleExpressionType
    ScheduleTransferType
    TransactionStatus
    TransactionType
    TransferScheduleStatus

    Variables

    BalanceType
    BankAccountHolderStatus
    BankAccountNumberFormat
    BankAccountOwnershipType
    BankNumberFormat
    clientRateLimits
    FeeType
    PayeeEntityType
    PaymentPreferencePaymentType
    RateDirection
    RecurringFrequency
    ScheduleExpressionType
    ScheduleTransferType
    TransactionStatus
    TransactionType
    TransferScheduleStatus

    Functions

    SellerWalletApiAxiosParamCreator
    SellerWalletApiFactory
    SellerWalletApiFp