Selling Partner API SDK for JavaScript
    Preparing search index...
    • FinancesApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          listTransactions(
              postedAfter?: string,
              postedBefore?: string,
              marketplaceId?: string,
              transactionStatus?: string,
              relatedIdentifierName?: string,
              relatedIdentifierValue?: string,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ListTransactionsResponse>,
          >;
      }

      • listTransactions: function
        • Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. 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

          • OptionalpostedAfter: string

            The response includes financial events posted on or after this date. This date must be in ISO 8601 date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.

          • OptionalpostedBefore: string

            The response includes financial events posted before (but not on) this date. This date must be in ISO 8601 date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. Default: Two minutes before the time of the request.

          • OptionalmarketplaceId: string

            The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • OptionaltransactionStatus: string

            The status of the transaction. Possible values: * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.

          • OptionalrelatedIdentifierName: string

            The name of the `relatedIdentifier`. Possible values: * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. Note: FINANCIAL_EVENT_GROUP_ID is the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.

          • OptionalrelatedIdentifierValue: string

            The value of the `relatedIdentifier`.

          • OptionalnextToken: string

            The response includes `nextToken` when the number of results exceeds the specified `pageSize` 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. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ListTransactionsResponse>,
          >