listPayouts

Retrieve a list of payouts for the selling partner's account. You can filter results by marketplaceIds, accountType, date range (createdAfter and createdBefore), or a specific payoutId. By default, the response includes payouts for all available marketplaces and account types. Results are grouped by the seller's account groups. Within each account group results are sorted by their creation date, with the most recent appearing first.

Usage Plan:

Rate (requests per second)Burst
0.510

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Query Params
marketplaceIds
array of strings

The Amazon stores from which to retrieve payouts. The Amazon store ID is a globally unique identifier assigned to each Amazon store. If omitted, the response includes payouts from all applicable stores. To find the Amazon store ID for your region, refer to Store Identifiers.

marketplaceIds
date-time

The response only includes payouts created on or after this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no start date filter is applied.

date-time

The response only includes payouts created before this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no end date filter is applied.

string

The response only includes the payout matching the specified identifier.

string

The response only includes payouts associated with the specified account type.

string

The response includes nextToken when the number of results exceeds the page size. 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.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json