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

    Interface FinancesApiListSummaryRequest

    Request parameters for listSummary operation in FinancesApi.

    interface FinancesApiListSummaryRequest {
        accountType?: string;
        marketplaceIds?: string[];
        nextToken?: string;
        periodEnd?: string;
        periodStart?: string;
        relatedIdentifierName?: string;
        relatedIdentifierValue?: string;
    }
    Index
    accountType? marketplaceIds? nextToken? periodEnd? periodStart? relatedIdentifierName? relatedIdentifierValue?
    accountType?: string

    The type of account to include in the response.

    marketplaceIds?: string[]

    The marketplaces from which to retrieve summaries. If omitted, summaries from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to Marketplace IDs.

    nextToken?: string

    A token that you use to retrieve subsequent pages of results. When there are more results available, the response will include a `nextToken` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. Repeat this process until the `nextToken` value is null to retrieve all results.

    periodEnd?: string

    The end of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or before the specified date. The value must be formatted in ISO 8601 date format.

    periodStart?: string

    The start of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or after the specified date. The value must be formatted in ISO 8601 date format.

    relatedIdentifierName?: string

    The name of the `relatedIdentifier`. The only possible value is `SETTLEMENT_ID`, the settlement ID associated with the summary.

    relatedIdentifierValue?: string

    The value of the `relatedIdentifier`.

    Settings
    Member Visibility

    On This Page
    Properties