Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    FinancesApi - object-oriented interface

    Hierarchy (View Summary)

    Index
    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: Configuration | undefined
    • Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Parameters

      Returns Promise<AxiosResponse<ListBalancesResponse, any, {}, any>>

    • Retrieve the financial summary for the specified time period or settlement period. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Parameters

      Returns Promise<AxiosResponse<SummaryResponse, any, {}, any>>

    • Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. Note: If you want to retrieve MFN orders in the US store, do not supply the marketplaceId parameter. Usage plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

      Parameters

      Returns Promise<AxiosResponse<ListTransactionsResponse, any, {}, any>>