API docs by Redocly

Selling Partner API for Finances (v0)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.

listFinancialEventGroups

Returns financial event groups for a given date range.

Usage Plan:

Rate (requests per second) Burst
0.5 30

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
MaxResultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of results to return per page.

FinancialEventGroupStartedBefore
string <date-time>

A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.

FinancialEventGroupStartedAfter
string <date-time>

A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.

NextToken
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

listFinancialEventsByGroupId

Returns all financial events for the specified financial event group.

Usage Plan:

Rate (requests per second) Burst
0.5 30

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
eventGroupId
required
string

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

query Parameters
MaxResultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of results to return per page.

NextToken
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

listFinancialEventsByOrderId

Returns all financial events for the specified order.

Usage Plan:

Rate (requests per second) Burst
0.5 30

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
orderId
required
string

An Amazon-defined order identifier, in 3-7-7 format.

query Parameters
MaxResultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of results to return per page.

NextToken
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

listFinancialEvents

Returns financial events for the specified data range.

Usage Plan:

Rate (requests per second) Burst
0.5 30

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
MaxResultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of results to return per page.

PostedAfter
string <date-time>

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

PostedBefore
string <date-time>

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

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}