Skip to main content

The base response type for the getOrderEarningsSummary method, which includes aggregate order earnings, expenses, gross amount, and order count for orders created within the date range and included in the summary.

Types that use OrderEarningsSummary

Not used by any types.

Call that uses OrderEarningsSummary

GET
/order_earnings_summary

Fields

Field
Type
Description
expenses
Amount
The aggregate amount of expenses for all orders included in the summary.

Note: Expenses are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.

grossAmount
Amount
The aggregate gross amount for all orders included in the order earnings summary. This amount equals the item subtotal plus shipping and handling, and any seller-collected taxes paid by the buyer, minus any seller-offered discount.

Note: Gross amount is always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.

orderCount
ainteger
The total number of orders included in the summary.
orderEarnings
Amount
The aggregate earnings amount for all orders included in the summary, which includes the amount of order earnings after deducting expenses and any refunds from the gross amount.

Note: Order earnings are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.

refunds
Amount
The aggregate amount of all refunds issued for the orders included in the summary.

Note: Refunds include gross refunds, gross claims, and gross payment disputes.

Note: Refunds are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.