listFinancialEventsByOrderId

get https://sellingpartnerapi-na.amazon.com/finances/v0/orders/{orderId}/financialEvents

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

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.

Responses

Response body

object

payload

object

The payload for the listFinancialEvents operation.

NextToken

string

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

FinancialEvents

object

Contains all information related to a financial event.

errors

array of objects

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

errors

object

code

string

required

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

message

string

required

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/finances/v0/orders/orderId/financialEvents?MaxResultsPerPage=100' \
3
     --header 'accept: application/json'


xxxxxxxxxx
1844
}
1
{
2
  "payload": {
3
    "NextToken": "string",
4
    "FinancialEvents": {
5
      "ShipmentEventList": [
6
        {
7
          "AmazonOrderId": "string",
8
          "SellerOrderId": "string",
9
          "MarketplaceName": "string",
10
          "StoreName": "string",
11
          "OrderChargeList": [
12
            {
13
              "ChargeType": "string",
14
              "ChargeAmount": {
15
                "CurrencyCode": "string",
16
                "CurrencyAmount": 0
17
              }
18
            }
19
          ],
20
          "OrderChargeAdjustmentList": [
21
            {
22
              "ChargeType": "string",
23
              "ChargeAmount": {
24
                "CurrencyCode": "string",
25
                "CurrencyAmount": 0

200Financial Events successfully retrieved.

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.

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.