listFinancialEventsByGroupId

Tested

GET

/finances/v0/financialEventGroups/{eventGroupId}/financialEvents

Last modified:2024-12-04 04:43:21

Maintainer:Sarath S

Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events.

Note: This operation will only retrieve group's data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

eventGroupId

string

required

The identifier of the financial event group to which the events belong.

Example:

485734534857

Query Params

MaxResultsPerPage

integer <int32>

optional

The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.

>= 1<= 100

Default:

100

Example:

PostedAfter

string <date-time>

optional

A date used for selecting financial events posted after (or at) a specified time. The date-time must be more than two minutes before the time of the request, in ISO 8601 date time format.

PostedBefore

string <date-time>

optional

A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.

NextToken

string

optional

A string token returned in the response of your previous request.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/finances/v0/financialEventGroups/485734534857/financialEvents?MaxResultsPerPage=10&PostedAfter&PostedBefore&NextToken'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the listFinancialEvents operation.

payload

object (ListFinancialEventsPayload)

optional

The payload for the listFinancialEvents operation.

NextToken

string

optional

When present and not empty, pass this string token in the next request to return the next response page.

FinancialEvents

object (FinancialEvents)

optional

Contains all information related to a financial event.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

listFinancialEventGroups

listFinancialEventsByOrderId