listSummary

get

https://sellingpartnerapi-na.amazon.com/finances/2024-06-19/summary

Retrieve the financial summary for the specified time period or settlement period.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

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.

Query Params

marketplaceIds

array of strings

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.

marketplaceIds

accountType

string

The type of account to include in the response.

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.

periodStart

date

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.

periodEnd

date

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.

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.

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.