Finances API v0 Reference

Retrieve financial information for a selling business.

Overview

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.

Version information

Version : v0

Contact information

Contact : Selling Partner API Developer Support

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

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

application/json

Produces

application/json

Operations

listFinancialEventGroups
listFinancialEventsByGroupId
listFinancialEventsByOrderId
listFinancialEvents

Paths

GET /finances/v0/financialEventGroups

Operation: listFinancialEventGroups

Description

Returns financial event groups for a given date range. 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.

Parameters

Type	Name	Description	Schema	Default
Query	MaxResultsPerPage 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'. Minimum : 1 Maximum : 100	integer (int32)	`100`
Query	FinancialEventGroupStartedBefore optional	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.	string (date-time)	-
Query	FinancialEventGroupStartedAfter optional	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.	string (date-time)	-
Query	NextToken optional	A string token returned in the response of your previous request.	string	-

Responses

HTTP Code	Description	Schema
200	Success.	ListFinancialEventGroupsResponse
400	Request has missing or invalid parameters and cannot be parsed.	ListFinancialEventGroupsResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventGroupsResponse
404	The resource specified does not exist. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventGroupsResponse
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventGroupsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventGroupsResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventGroupsResponse

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

Operation: listFinancialEventsByGroupId

Description

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

Parameters

Type	Name	Description	Schema	Default
Query	MaxResultsPerPage 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'. Minimum : 1 Maximum : 100	integer (int32)	`100`
Query	PostedAfter 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.	string (date-time)	-
Query	PostedBefore 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.	string (date-time)	-
Path	eventGroupId required	The identifier of the financial event group to which the events belong.	string	-
Query	NextToken optional	A string token returned in the response of your previous request.	string	-

Responses

HTTP Code	Description	Schema
200	Success.	ListFinancialEventsResponse
400	Request has missing or invalid parameters and cannot be parsed.	ListFinancialEventsResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
404	The resource specified does not exist. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse

GET /finances/v0/orders/{orderId}/financialEvents

Operation: listFinancialEventsByOrderId

Description

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

Parameters

Type	Name	Description	Schema	Default
Path	orderId required	An Amazon-defined order identifier, in 3-7-7 format.	string	-
Query	MaxResultsPerPage 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'. Minimum : 1 Maximum : 100	integer (int32)	`100`
Query	NextToken optional	A string token returned in the response of your previous request.	string	-

Responses

HTTP Code	Description	Schema
200	Financial Events successfully retrieved.	ListFinancialEventsResponse
400	Request has missing or invalid parameters and cannot be parsed.	ListFinancialEventsResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
404	The resource specified does not exist. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse

GET /finances/v0/financialEvents

Operation: listFinancialEvents

Description

Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. Note: in ListFinancialEvents, deferred events don't show up in responses until in they are released.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

Parameters

Type	Name	Description	Schema	Default
Query	MaxResultsPerPage 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'. Minimum : 1 Maximum : 100	integer (int32)	`100`
Query	PostedAfter optional	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.	string (date-time)	-
Query	PostedBefore 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.	string (date-time)	-
Query	NextToken optional	A string token returned in the response of your previous request.	string	-

Responses

HTTP Code	Description	Schema
200	Success.	ListFinancialEventsResponse
400	Request has missing or invalid parameters and cannot be parsed.	ListFinancialEventsResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
404	The resource specified does not exist. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned. `x-amzn-RequestId` (string) : Unique request reference identifier.	ListFinancialEventsResponse

Definitions

AdhocDisbursementEvent

An event related to an Adhoc Disbursement.

Name	Description	Schema
TransactionType optional	Indicates the type of transaction. Example: "Disbursed to Amazon Gift Card balance"	string
PostedDate optional	The date and time when the financial event was posted.	Date
TransactionId optional	The identifier for the transaction.	string
TransactionAmount optional	The amount of the transaction.	Currency

AdhocDisbursementEventList

A list of AdhocDisbursement events.

Type : < AdhocDisbursementEvent > array

AdjustmentEvent

An adjustment to the seller's account.

Name	Description	Schema
AdjustmentType optional	The type of adjustment. Possible values: FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged. ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back. PostageBilling - The amount paid by a seller for shipping labels. PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded. LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged. CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.	string
PostedDate optional	The date and time when the financial event was posted.	Date
AdjustmentAmount optional	The amount adjusted as part of this event.	Currency
AdjustmentItemList optional	A list of information about adjustments to an account.	AdjustmentItemList

AdjustmentEventList

A list of adjustment event information for the seller's account.

Type : < AdjustmentEvent > array

AdjustmentItem

An item in an adjustment to the seller's account.

Name	Description	Schema
Quantity optional	Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement.	string
PerUnitAmount optional	The per unit value of the item.	Currency
TotalAmount optional	The total value of the item.	Currency
SellerSKU optional	The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API.	string
FnSKU optional	A unique identifier assigned to products stored in and fulfilled from a fulfillment center.	string
ProductDescription optional	A short description of the item.	string
ASIN optional	The Amazon Standard Identification Number (ASIN) of the item.	string

AdjustmentItemList

A list of information about items in an adjustment to the seller's account.

Type : < AdjustmentItem > array

AffordabilityExpenseEvent

An expense related to an affordability promotion.

Name	Description	Schema
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
PostedDate optional	The date and time when the financial event was created.	Date
MarketplaceId optional	An encrypted, Amazon-defined marketplace identifier.	string
TransactionType optional	Indicates the type of transaction. Possible values: Charge - For an affordability promotion expense. Refund - For an affordability promotion expense reversal.	string
BaseExpense optional	The amount charged for clicks incurred under the Sponsored Products program.	Currency
TaxTypeCGST required	Central Goods and Service Tax, charged and collected by the central government.	Currency
TaxTypeSGST required	State Goods and Service Tax, charged and collected by the state government.	Currency
TaxTypeIGST required	Integrated Goods and Service Tax, charged and collected by the central government.	Currency
TotalExpense optional	The total amount charged to the seller. TotalExpense = BaseExpense + TaxTypeIGST + TaxTypeCGST + TaxTypeSGST.	Currency

AffordabilityExpenseEventList

A list of expense information related to an affordability promotion.

Type : < AffordabilityExpenseEvent > array

BigDecimal

Type : number

ChargeComponent

A charge on the seller's account.

Possible values:

Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered.
Tax - The tax collected by the seller on the Principal.
MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal.
MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge.
MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge.
MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges.
Discount - The promotional discount for an order item.
TaxDiscount - The tax amount deducted for promotional rebates.
CODItemCharge - The COD charge for an order item.
CODItemTaxCharge - The tax collected by the seller on a CODItemCharge.
CODOrderCharge - The COD charge for an order.
CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge.
CODShippingCharge - Shipping charges for a COD order.
CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge.
ShippingCharge - The shipping charge.
ShippingTax - The tax collected by the seller on a ShippingCharge.
Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience.
Giftwrap - The gift wrap charge.
GiftwrapTax - The tax collected by the seller on a Giftwrap charge.
RestockingFee - The charge applied to the buyer when returning a product in certain categories.
ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault.
PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction.
GenericDeduction - A generic bad debt deduction.
FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item.
PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces.
ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program.
SAFE-TReimbursement - The SAFE-T claim amount for the item.
TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).
TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST).
TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST).
TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).

Name	Description	Schema
ChargeType optional	The type of charge.	string
ChargeAmount optional	The amount of the charge.	Currency

ChargeComponentList

A list of charge information on the seller's account.

Type : < ChargeComponent > array

ChargeInstrument

A payment instrument.

Name	Description	Schema
Description optional	A short description of the charge instrument.	string
Tail optional	The account tail (trailing digits) of the charge instrument.	string
Amount optional	The amount charged to this charge instrument.	Currency

ChargeInstrumentList

A list of payment instruments.

Type : < ChargeInstrument > array

ChargeRefundEvent

An event related to charge refund.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
ReasonCode optional	The reason given for a charge refund. Example: `SubscriptionFeeCorrection`	string
ReasonCodeDescription optional	A description of the Reason Code. Example: `SubscriptionFeeCorrection`	string
ChargeRefundTransactions optional	The amount of the charge refund credit.	ChargeRefundTransactions

ChargeRefundEventList

A list of charge refund events.

Type : < ChargeRefundEvent > array

ChargeRefundTransaction

The charge refund transaction.

Name	Description	Schema
ChargeAmount optional	The amount of the charge refund credit.	Currency
ChargeType optional	The type of charge.	string

ChargeRefundTransactions

A list of ChargeRefund transactions

Type : < ChargeRefundTransaction > array

CouponPaymentEvent

An event related to coupon payments.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
CouponId optional	A coupon identifier.	string
SellerCouponDescription optional	The description provided by the seller when they created the coupon.	string
ClipOrRedemptionCount optional	The number of coupon clips or redemptions.	integer (int64)
PaymentEventId optional	A payment event identifier.	string
FeeComponent optional	A fee associated with the event.	FeeComponent
ChargeComponent optional	A charge on the seller's account. Possible values: Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. Tax - The tax collected by the seller on the Principal. MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. Discount - The promotional discount for an order item. TaxDiscount - The tax amount deducted for promotional rebates. CODItemCharge - The COD charge for an order item. CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. CODOrderCharge - The COD charge for an order. CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. CODShippingCharge - Shipping charges for a COD order. CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. ShippingCharge - The shipping charge. ShippingTax - The tax collected by the seller on a ShippingCharge. Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. Giftwrap - The gift wrap charge. GiftwrapTax - The tax collected by the seller on a Giftwrap charge. RestockingFee - The charge applied to the buyer when returning a product in certain categories. ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. GenericDeduction - A generic bad debt deduction. FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. SAFE-TReimbursement - The SAFE-T claim amount for the item. TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).	ChargeComponent
TotalAmount optional	The FeeComponent value plus the ChargeComponent value.	Currency

CouponPaymentEventList

A list of coupon payment event information.

Type : < CouponPaymentEvent > array

Currency

A currency type and amount.

Name	Description	Schema
CurrencyCode optional	The three-digit currency code in ISO 4217 format.	string
CurrencyAmount optional	The monetary value.	BigDecimal

Date

Type : string (date-time)

DebtRecoveryEvent

A debt payment or debt adjustment.

Name	Description	Schema
DebtRecoveryType optional	The debt recovery type. Possible values: DebtPayment DebtPaymentFailure DebtAdjustment	string
RecoveryAmount optional	The amount applied for recovery.	Currency
OverPaymentCredit optional	The amount returned for overpayment.	Currency
DebtRecoveryItemList optional	A list of debt recovery item information.	DebtRecoveryItemList
ChargeInstrumentList optional	A list of payment instruments.	ChargeInstrumentList

DebtRecoveryEventList

A list of debt recovery event information.

Type : < DebtRecoveryEvent > array

DebtRecoveryItem

An item of a debt payment or debt adjustment.

Name	Description	Schema
RecoveryAmount optional	The amount applied for the recovery item.	Currency
OriginalAmount optional	The original debt amount.	Currency
GroupBeginDate optional	The beginning date and time of the financial event group that contains the debt. In ISO 8601 date time format.	Date
GroupEndDate optional	The ending date and time of the financial event group that contains the debt. In ISO 8601 date time format.	Date

DebtRecoveryItemList

A list of debt recovery item information.

Type : < DebtRecoveryItem > array

DirectPayment

A payment made directly to a seller.

Name	Description	Schema
DirectPaymentType optional	The type of payment. Possible values: StoredValueCardRevenue - The amount that is deducted from the seller's account because the seller received money through a stored value card. StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded. PrivateLabelCreditCardRevenue - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon. PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded. CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer. CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded.	string
DirectPaymentAmount optional	The amount of the direct payment.	Currency

DirectPaymentList

A list of direct payment information.

Type : < DirectPayment > array

FailedAdhocDisbursementEventList

A list of FailedAdhocDisbursementEvents.

Type : < FailedAdhocDisbursementEvent > array

FailedAdhocDisbursementEvent

Failed ad hoc disbursement event list.

Name	Description	Schema
FundsTransfersType optional	The type of fund transfer. Example "Refund"	string
TransferId optional	The transfer identifier.	string
DisbursementId optional	The disbursement identifier.	string
PaymentDisbursementType optional	The type of payment for disbursement. Example `CREDIT_CARD`	string
Status optional	The status of the failed `AdhocDisbursement`. Example `HARD_DECLINED`	string
TransferAmount optional	The amount of the Adhoc Disbursement.	Currency
PostedDate optional	The date and time when the financial event was posted.	Date

FBALiquidationEvent

A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
OriginalRemovalOrderId optional	The identifier for the original removal order.	string
LiquidationProceedsAmount optional	The amount paid by the liquidator for the seller's inventory. The seller receives this amount minus LiquidationFeeAmount.	Currency
LiquidationFeeAmount optional	The fee charged to the seller by Amazon for liquidating the seller's FBA inventory.	Currency

FBALiquidationEventList

A list of FBA inventory liquidation payment events.

Type : < FBALiquidationEvent > array

FeeComponent

A fee associated with the event.

Name	Description	Schema
FeeType optional	The type of fee. For more information about Selling on Amazon fees, see Selling on Amazon Fee Schedule on Seller Central. For more information about Fulfillment by Amazon fees, see FBA features, services and fees on Seller Central.	string
FeeAmount optional	The amount of the fee.	Currency

FeeComponentList

A list of fee component information.

Type : < FeeComponent > array

FinancialEventGroup

Information related to a financial event group.

Name	Description	Schema
FinancialEventGroupId optional	A unique identifier for the financial event group.	string
ProcessingStatus optional	The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: Open Closed	string
FundTransferStatus optional	The status of the fund transfer.	string
OriginalTotal optional	The total amount in the currency of the marketplace in which the transactions occurred. For a closed financial group, this is the total amount of a disbursement or a charge amount. For an open financial event group, this is the current balance.	Currency
ConvertedTotal optional	The total amount in the currency of the marketplace in which the funds were disbursed.	Currency
FundTransferDate optional	The date and time when the disbursement or charge was initiated. Only present for closed settlements. In ISO 8601 date time format.	Date
TraceId optional	The trace identifier used by sellers to look up transactions externally.	string
AccountTail optional	The account tail of the payment instrument.	string
BeginningBalance optional	The balance at the beginning of the settlement period.	Currency
FinancialEventGroupStart optional	The date and time at which the financial event group is opened. In ISO 8601 date time format.	Date
FinancialEventGroupEnd optional	The date and time at which the financial event group is closed. In ISO 8601 date time format.	Date

FinancialEventGroupList

A list of financial event group information.

Type : < FinancialEventGroup > array

FinancialEvents

Contains all information related to a financial event.

Name	Description	Schema
ShipmentEventList optional	A list of shipment events.	ShipmentEventList
ShipmentSettleEventList optional	A list of Shipment Settle events.	ShipmentSettleEventList
RefundEventList optional	A list of refund events.	ShipmentEventList
GuaranteeClaimEventList optional	A list of guarantee claim events.	ShipmentEventList
ChargebackEventList optional	A list of chargeback events.	ShipmentEventList
PayWithAmazonEventList optional	A list of events related to the seller's Pay with Amazon account.	PayWithAmazonEventList
ServiceProviderCreditEventList optional	A list of information about solution provider credits.	SolutionProviderCreditEventList
RetrochargeEventList optional	A list of information about Retrocharge or RetrochargeReversal events.	RetrochargeEventList
RentalTransactionEventList optional	A list of rental transaction event information.	RentalTransactionEventList
ProductAdsPaymentEventList optional	A list of sponsored products payment events.	ProductAdsPaymentEventList
ServiceFeeEventList optional	A list of information about service fee events.	ServiceFeeEventList
SellerDealPaymentEventList optional	A list of payment events for deal-related fees.	SellerDealPaymentEventList
DebtRecoveryEventList optional	A list of debt recovery event information.	DebtRecoveryEventList
LoanServicingEventList optional	A list of loan servicing events.	LoanServicingEventList
AdjustmentEventList optional	A list of adjustment event information for the seller's account.	AdjustmentEventList
SAFETReimbursementEventList optional	A list of SAFETReimbursementEvents.	SAFETReimbursementEventList
SellerReviewEnrollmentPaymentEventList optional	A list of information about fee events for the Early Reviewer Program.	SellerReviewEnrollmentPaymentEventList
FBALiquidationEventList optional	A list of FBA inventory liquidation payment events.	FBALiquidationEventList
CouponPaymentEventList optional	A list of coupon payment event information.	CouponPaymentEventList
ImagingServicesFeeEventList optional	A list of fee events related to Amazon Imaging services.	ImagingServicesFeeEventList
NetworkComminglingTransactionEventList optional	A list of network commingling transaction events.	NetworkComminglingTransactionEventList
AffordabilityExpenseEventList optional	A list of expense information related to an affordability promotion.	AffordabilityExpenseEventList
AffordabilityExpenseReversalEventList optional	A list of expense information related to an affordability promotion.	AffordabilityExpenseEventList
RemovalShipmentEventList optional	A list of removal shipment event information.	RemovalShipmentEventList
RemovalShipmentAdjustmentEventList optional	A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.	RemovalShipmentAdjustmentEventList
TrialShipmentEventList optional	A list of information about trial shipment financial events.	TrialShipmentEventList
TDSReimbursementEventList optional	A list of `TDSReimbursementEvent` items.	TDSReimbursementEventList
AdhocDisbursementEventList optional	A list of `AdhocDisbursement` events.	AdhocDisbursementEventList
TaxWithholdingEventList optional	A list of `TaxWithholding` events.	TaxWithholdingEventList
ChargeRefundEventList optional	A list of charge refund events.	ChargeRefundEventList
FailedAdhocDisbursementEventList optional	A list of `FailedAdhocDisbursementEvent`s.	FailedAdhocDisbursementEventList
ValueAddedServiceChargeEventList optional	A list of `ValueAddedServiceCharge` events.	ValueAddedServiceChargeEventList
CapacityReservationBillingEventList optional	A list of `CapacityReservationBillingEvent` events.	CapacityReservationBillingEventList

ImagingServicesFeeEvent

A fee event related to Amazon Imaging services.

Name	Description	Schema
ImagingRequestBillingItemID optional	The identifier for the imaging services request.	string
ASIN optional	The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested.	string
PostedDate optional	The date and time when the financial event was posted.	Date
FeeList optional	A list of fees associated with the event.	FeeComponentList

ImagingServicesFeeEventList

A list of fee events related to Amazon Imaging services.

Type : < ImagingServicesFeeEvent > array

ListFinancialEventGroupsPayload

The payload for the listFinancialEventGroups operation.

Name	Description	Schema
NextToken optional	When present and not empty, pass this string token in the next request to return the next response page.	string
FinancialEventGroupList optional	A list of financial event group information.	FinancialEventGroupList

ListFinancialEventGroupsResponse

The response schema for the listFinancialEventGroups operation.

Name	Description	Schema
payload optional	The payload for the listFinancialEventGroups operation.	ListFinancialEventGroupsPayload
errors optional	One or more unexpected errors occurred during the listFinancialEventGroups operation.	ErrorList

ListFinancialEventsPayload

The payload for the listFinancialEvents operation.

Name	Description	Schema
NextToken optional	When present and not empty, pass this string token in the next request to return the next response page.	string
FinancialEvents optional	Contains all information related to a financial event.	FinancialEvents

ListFinancialEventsResponse

The response schema for the listFinancialEvents operation.

Name	Description	Schema
payload optional	The payload for the listFinancialEvents operation.	ListFinancialEventsPayload
errors optional	One or more unexpected errors occurred during the listFinancialEvents operation.	ErrorList

LoanServicingEvent

A loan advance, loan payment, or loan refund.

Name	Description	Schema
LoanAmount optional	The amount of the loan.	Currency
SourceBusinessEventType optional	The type of event. Possible values: LoanAdvance LoanPayment LoanRefund	string

LoanServicingEventList

A list of loan servicing events.

Type : < LoanServicingEvent > array

NetworkComminglingTransactionEvent

A network commingling transaction event.

Name	Description	Schema
TransactionType optional	The type of network item swap. Possible values: NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces.	string
PostedDate optional	The date and time when the financial event was posted.	Date
NetCoTransactionID optional	The identifier for the network item swap.	string
SwapReason optional	The reason for the network item swap.	string
ASIN optional	The Amazon Standard Identification Number (ASIN) of the swapped item.	string
MarketplaceId optional	The marketplace in which the event took place.	string
TaxExclusiveAmount optional	The price of the swapped item minus TaxAmount.	Currency
TaxAmount optional	The tax on the network item swap paid by the seller.	Currency

NetworkComminglingTransactionEventList

A list of network commingling transaction events.

Type : < NetworkComminglingTransactionEvent > array

PayWithAmazonEvent

An event related to the seller's Pay with Amazon account.

Name	Description	Schema
SellerOrderId optional	An order identifier that is specified by the seller.	string
TransactionPostedDate optional	The date and time when the payment transaction is posted. In ISO 8601 date time format.	Date
BusinessObjectType optional	The type of business object.	string
SalesChannel optional	The sales channel for the transaction.	string
Charge optional	The charge associated with the event.	ChargeComponent
FeeList optional	A list of fees associated with the event.	FeeComponentList
PaymentAmountType optional	The type of payment. Possible values: Sales	string
AmountDescription optional	A short description of this payment event.	string
FulfillmentChannel optional	The fulfillment channel. Possible values: AFN - Amazon Fulfillment Network (Fulfillment by Amazon) MFN - Merchant Fulfillment Network (self-fulfilled)	string
StoreName optional	The store name where the event occurred.	string

PayWithAmazonEventList

A list of events related to the seller's Pay with Amazon account.

Type : < PayWithAmazonEvent > array

ProductAdsPaymentEvent

A Sponsored Products payment event.

Name	Description	Schema
postedDate optional	The date and time when the financial event was posted.	Date
transactionType optional	Indicates if the transaction is for a charge or a refund. Possible values: charge - Charge refund - Refund	string
invoiceId optional	Identifier for the invoice that the transaction appears in.	string
baseValue optional	Base amount of the transaction, before tax.	Currency
taxValue optional	Tax amount of the transaction.	Currency
transactionValue optional	The total amount of the transaction. Equal to baseValue + taxValue.	Currency

ProductAdsPaymentEventList

A list of sponsored products payment events.

Type : < ProductAdsPaymentEvent > array

Promotion

A promotion applied to an item.

Name	Description	Schema
PromotionType optional	The type of promotion.	string
PromotionId optional	The seller-specified identifier for the promotion.	string
PromotionAmount optional	The amount of promotional discount applied to the item.	Currency

PromotionList

A list of promotions.

Type : < Promotion > array

RemovalShipmentEvent

A removal shipment event for a removal order.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
MerchantOrderId optional	The merchant removal orderId.	string
OrderId optional	The identifier for the removal shipment order.	string
TransactionType optional	The type of removal order. Possible values: WHOLESALE_LIQUIDATION	string
RemovalShipmentItemList optional	A list of removal shipment items.	RemovalShipmentItemList

RemovalShipmentEventList

A list of removal shipment event information.

Type : < RemovalShipmentEvent > array

RemovalShipmentItem

Item-level information for a removal shipment.

Name	Description	Schema
RemovalShipmentItemId optional	An identifier for an item in a removal shipment.	string
TaxCollectionModel optional	The tax collection model applied to the item. Possible values: MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.	string
FulfillmentNetworkSKU optional	The Amazon fulfillment network SKU for the item.	string
Quantity optional	The quantity of the item.	integer (int32)
Revenue optional	The total amount paid to the seller for the removed item.	Currency
FeeAmount optional	The fee that Amazon charged to the seller for the removal of the item. The amount is a negative number.	Currency
TaxAmount optional	Tax collected on the revenue.	Currency
TaxWithheld optional	The tax withheld and remitted to the taxing authority by Amazon on behalf of the seller. If TaxCollectionModel=MarketplaceFacilitator, then TaxWithheld=TaxAmount (except the TaxWithheld amount is a negative number). Otherwise TaxWithheld=0.	Currency

RemovalShipmentItemList

A list of information about removal shipment items.

Type : < RemovalShipmentItem > array

RemovalShipmentAdjustmentEvent

A financial adjustment event for FBA liquidated inventory. A positive value indicates money owed to Amazon by the buyer (for example, when the charge was incorrectly calculated as less than it should be). A negative value indicates a full or partial refund owed to the buyer (for example, when the buyer receives damaged items or fewer items than ordered).

Name	Description	Schema
PostedDate optional	The date when the financial event was posted.	Date
AdjustmentEventId optional	The unique identifier for the adjustment event.	string
MerchantOrderId optional	The merchant removal orderId.	string
OrderId optional	The orderId for shipping inventory.	string
TransactionType optional	The type of removal order. Possible values: WHOLESALE_LIQUIDATION.	string
RemovalShipmentItemAdjustmentList optional	A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.	< RemovalShipmentItemAdjustment > array

RemovalShipmentAdjustmentEventList

A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.

Type : < RemovalShipmentAdjustmentEvent > array

RemovalShipmentItemAdjustment

Item-level information for a removal shipment item adjustment.

Name	Description	Schema
RemovalShipmentItemId optional	An identifier for an item in a removal shipment.	string
TaxCollectionModel optional	The tax collection model applied to the item. Possible values: MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.	string
FulfillmentNetworkSKU optional	The Amazon fulfillment network SKU for the item.	string
AdjustedQuantity optional	Adjusted quantity of removal shipmentItemAdjustment items.	integer (int32)
RevenueAdjustment optional	The total amount adjusted for disputed items.	Currency
TaxAmountAdjustment optional	Adjustment on the Tax collected amount on the adjusted revenue.	Currency
TaxWithheldAdjustment optional	Adjustment the tax withheld and remitted to the taxing authority by Amazon on behalf of the seller. If TaxCollectionModel=MarketplaceFacilitator, then TaxWithheld=TaxAmount (except the TaxWithheld amount is a negative number). Otherwise TaxWithheld=0.	Currency

RentalTransactionEvent

An event related to a rental transaction.

Name	Description	Schema
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
RentalEventType optional	The type of rental event. Possible values: RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item. RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period. RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item. RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item. RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon. RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item.	string
ExtensionLength optional	The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.	integer (int32)
PostedDate optional	The date and time when the financial event was posted.	Date
RentalChargeList optional	A list of charges associated with the rental event.	ChargeComponentList
RentalFeeList optional	A list of fees associated with the rental event.	FeeComponentList
MarketplaceName optional	The name of the marketplace.	string
RentalInitialValue optional	The amount of money the customer originally paid to rent the item. This value is only returned for RentalChargeFailureReimbursement and RentalLostItemReimbursement events.	Currency
RentalReimbursement optional	The amount of money Amazon sends the seller to compensate for a lost item or a failed charge. This value is only returned for RentalChargeFailureReimbursement and RentalLostItemReimbursement events.	Currency
RentalTaxWithheldList optional	A list of taxes withheld information for a rental item.	TaxWithheldComponentList

RentalTransactionEventList

A list of rental transaction event information.

Type : < RentalTransactionEvent > array

RetrochargeEvent

A retrocharge or retrocharge reversal.

Name	Description	Schema
RetrochargeEventType optional	The type of event. Possible values: Retrocharge RetrochargeReversal	string
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
PostedDate optional	The date and time when the financial event was posted.	Date
BaseTax optional	The base tax associated with the retrocharge event.	Currency
ShippingTax optional	The shipping tax associated with the retrocharge event.	Currency
MarketplaceName optional	The name of the marketplace where the retrocharge event occurred.	string
RetrochargeTaxWithheldList optional	A list of information about taxes withheld.	TaxWithheldComponentList

RetrochargeEventList

A list of information about Retrocharge or RetrochargeReversal events.

Type : < RetrochargeEvent > array

SAFETReimbursementEvent

A SAFE-T claim reimbursement on the seller's account.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
SAFETClaimId optional	A SAFE-T claim identifier.	string
ReimbursedAmount optional	The amount of the reimbursement.	Currency
ReasonCode optional	Indicates why the seller was reimbursed.	string
SAFETReimbursementItemList optional	A list of SAFETReimbursementItems.	SAFETReimbursementItemList

SAFETReimbursementEventList

A list of SAFETReimbursementEvents.

Type : < SAFETReimbursementEvent > array

SAFETReimbursementItem

An item from a SAFE-T claim reimbursement.

Name	Description	Schema
itemChargeList optional	A list of charges associated with the item.	ChargeComponentList
productDescription optional	The description of the item as shown on the product detail page on the retail website.	string
quantity optional	The number of units of the item being reimbursed.	string

SAFETReimbursementItemList

A list of SAFETReimbursementItems.

Type : < SAFETReimbursementItem > array

SellerDealPaymentEvent

An event linked to the payment of a fee related to the specified deal.

Name	Description	Schema
postedDate optional	The date and time when the financial event was posted.	Date
dealId optional	The unique identifier of the deal.	string
dealDescription optional	The internal description of the deal.	string
eventType optional	The type of event: SellerDealComplete.	string
feeType optional	The type of fee: RunLightningDealFee.	string
feeAmount optional	The monetary amount of the fee.	Currency
taxAmount optional	The monetary amount of the tax applied.	Currency
totalAmount optional	The total monetary amount paid.	Currency

SellerDealPaymentEventList

A list of payment events for deal-related fees.

Type : < SellerDealPaymentEvent > array

SellerReviewEnrollmentPaymentEvent

A fee payment event for the Early Reviewer Program.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
EnrollmentId optional	An enrollment identifier.	string
ParentASIN optional	The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program.	string
FeeComponent optional	A fee associated with the event.	FeeComponent
ChargeComponent optional	A charge on the seller's account. Possible values: Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. Tax - The tax collected by the seller on the Principal. MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. Discount - The promotional discount for an order item. TaxDiscount - The tax amount deducted for promotional rebates. CODItemCharge - The COD charge for an order item. CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. CODOrderCharge - The COD charge for an order. CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. CODShippingCharge - Shipping charges for a COD order. CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. ShippingCharge - The shipping charge. ShippingTax - The tax collected by the seller on a ShippingCharge. Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. Giftwrap - The gift wrap charge. GiftwrapTax - The tax collected by the seller on a Giftwrap charge. RestockingFee - The charge applied to the buyer when returning a product in certain categories. ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. GenericDeduction - A generic bad debt deduction. FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. SAFE-TReimbursement - The SAFE-T claim amount for the item. TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).	ChargeComponent
TotalAmount optional	The FeeComponent value plus the ChargeComponent value.	Currency

SellerReviewEnrollmentPaymentEventList

A list of information about fee events for the Early Reviewer Program.

Type : < SellerReviewEnrollmentPaymentEvent > array

ServiceFeeEvent

A service fee on the seller's account.

Name	Description	Schema
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
FeeReason optional	A short description of the service fee reason.	string
FeeList optional	A list of fee components associated with the service fee.	FeeComponentList
SellerSKU optional	The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API.	string
FnSKU optional	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.	string
FeeDescription optional	A short description of the service fee event.	string
ASIN optional	The Amazon Standard Identification Number (ASIN) of the item.	string

ServiceFeeEventList

A list of information about service fee events.

Type : < ServiceFeeEvent > array

ShipmentEvent

A shipment, refund, guarantee claim, or chargeback.

Name	Description	Schema
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
SellerOrderId optional	A seller-defined identifier for an order.	string
MarketplaceName optional	The name of the marketplace where the event occurred.	string
OrderChargeList optional	A list of order-level charges. These charges are applicable to Multi-Channel Fulfillment COD orders.	ChargeComponentList
OrderChargeAdjustmentList optional	A list of order-level charge adjustments. These adjustments are applicable to Multi-Channel Fulfillment COD orders.	ChargeComponentList
ShipmentFeeList optional	A list of shipment-level fees.	FeeComponentList
ShipmentFeeAdjustmentList optional	A list of shipment-level fee adjustments.	FeeComponentList
OrderFeeList optional	A list of order-level fees. These charges are applicable to Multi-Channel Fulfillment orders.	FeeComponentList
OrderFeeAdjustmentList optional	A list of order-level fee adjustments. These adjustments are applicable to Multi-Channel Fulfillment orders.	FeeComponentList
DirectPaymentList optional	A list of transactions where buyers pay Amazon through one of the credit cards offered by Amazon or where buyers pay a seller directly through COD.	DirectPaymentList
PostedDate optional	The date and time when the financial event was posted.	Date
ShipmentItemList optional	A list of shipment items.	ShipmentItemList
ShipmentItemAdjustmentList optional	A list of shipment item adjustments.	ShipmentItemList

ShipmentEventList

A list of shipment event information.

Type : < ShipmentEvent > array

ShipmentSettleEventList

A list of ShipmentEvent items.

Type : < ShipmentEvent > array

ShipmentItem

An item of a shipment, refund, guarantee claim, or chargeback.

Name	Description	Schema
SellerSKU optional	The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API.	string
OrderItemId optional	An Amazon-defined order item identifier.	string
OrderAdjustmentItemId optional	An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events.	string
QuantityShipped optional	The number of items shipped.	integer (int32)
ItemChargeList optional	A list of charges associated with the shipment item.	ChargeComponentList
ItemChargeAdjustmentList optional	A list of charge adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events.	ChargeComponentList
ItemFeeList optional	A list of fees associated with the shipment item.	FeeComponentList
ItemFeeAdjustmentList optional	A list of fee adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events.	FeeComponentList
ItemTaxWithheldList optional	A list of taxes withheld information for a shipment item.	TaxWithheldComponentList
PromotionList optional	A list of promotions.	PromotionList
PromotionAdjustmentList optional	A list of promotion adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events.	PromotionList
CostOfPointsGranted optional	The cost of Amazon Points granted for a shipment item.	Currency
CostOfPointsReturned optional	The cost of Amazon Points returned for a shipment item. This value is only returned for refunds, guarantee claims, and chargeback events.	Currency

ShipmentItemList

A list of shipment items.

Type : < ShipmentItem > array

SolutionProviderCreditEvent

A credit given to a solution provider.

Name	Description	Schema
ProviderTransactionType optional	The transaction type.	string
SellerOrderId optional	A seller-defined identifier for an order.	string
MarketplaceId optional	The identifier of the marketplace where the order was placed.	string
MarketplaceCountryCode optional	The two-letter country code of the country associated with the marketplace where the order was placed.	string
SellerId optional	The Amazon-defined identifier of the seller.	string
SellerStoreName optional	The store name where the payment event occurred.	string
ProviderId optional	The Amazon-defined identifier of the solution provider.	string
ProviderStoreName optional	The store name where the payment event occurred.	string
TransactionAmount optional	The amount of the credit.	Currency
TransactionCreationDate optional	The date and time that the credit transaction was created, in ISO 8601 date time format.	Date

SolutionProviderCreditEventList

A list of information about solution provider credits.

Type : < SolutionProviderCreditEvent > array

TaxWithholdingPeriod

Period which taxwithholding on seller's account is calculated.

Name	Description	Schema
StartDate optional	Start of the time range.	Date
EndDate optional	End of the time range.	Date

TaxWithholdingEvent

A TaxWithholding event on seller's account.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
BaseAmount optional	The amount which tax was withheld against.	Currency
WithheldAmount optional	The amount of the tax withholding deducted from seller's account.	Currency
TaxWithholdingPeriod optional	Time period for which tax is withheld.	TaxWithholdingPeriod

TaxWithholdingEventList

A list of TaxWithholding events.

Type : < TaxWithholdingEvent > array

TaxWithheldComponent

Information about the taxes withheld.

Name	Description	Schema
TaxCollectionModel optional	The tax collection model applied to the item. Possible values: MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.	string
TaxesWithheld optional	A list of charges that represent the types and amounts of taxes withheld.	ChargeComponentList

TaxWithheldComponentList

A list of information about taxes withheld.

Type : < TaxWithheldComponent > array

TDSReimbursementEvent

An event related to a Tax-Deducted-at-Source (TDS) reimbursement.

Name	Description	Schema
PostedDate optional	The date and time when the financial event was posted.	Date
TDSOrderId optional	The Tax-Deducted-at-Source (TDS) identifier.	string
ReimbursedAmount optional	The amount reimbursed.	Currency

TDSReimbursementEventList

A list of TDSReimbursementEvent items.

Type : < TDSReimbursementEvent > array

TrialShipmentEvent

An event related to a trial shipment.

Name	Description	Schema
AmazonOrderId optional	An Amazon-defined identifier for an order.	string
FinancialEventGroupId optional	The identifier of the financial event group.	string
PostedDate optional	The date and time when the financial event was posted.	Date
SKU optional	The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API.	string
FeeList optional	A list of fees charged by Amazon for trial shipments.	FeeComponentList

TrialShipmentEventList

A list of information about trial shipment financial events.

Type : < TrialShipmentEvent > array

ValueAddedServiceChargeEventList

A list of ValueAddedServiceCharge events.

Type : < ValueAddedServiceChargeEvent > array

ValueAddedServiceChargeEvent

An event related to a value added service charge.

Name	Description	Schema
TransactionType optional	Indicates the type of transaction. Example: 'Other Support Service fees'	string
PostedDate optional	The date and time when the financial event was posted.	Date
Description optional	A short description of the service charge event.	string
TransactionAmount optional	The amount of the service charge event.	Currency

CapacityReservationBillingEvent

An event related to a capacity reservation billing charge.

Name	Description	Schema
TransactionType optional	Indicates the type of transaction. For example, FBA Inventory Fee	string
PostedDate optional	The date and time when the financial event was posted.	Date
Description optional	A short description of the capacity reservation billing event.	string
TransactionAmount optional	The amount of the capacity reservation billing event.	Currency

CapacityReservationBillingEventList

A list of CapacityReservationBillingEvent events.

Type : < CapacityReservationBillingEvent > array

ErrorList

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

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred.	string
message required	A message that describes the error condition in a human-readable form.	string
details optional	Additional details that can help the caller understand or fix the issue.	string

Updated about 1 month ago