This API is used to retrieve seller payouts and monetary transaction details related to those payouts.
order_earnings
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getOrderEarnings | GET | /order_earnings | Returns detailed earnings information for one or more orders associated with a seller account. | View getOrderEarnings - /order_earnings |
| getOrderEarningsById | GET | /order_earnings/{order_id} | Retrieves detailed earnings information for a specified order. | View getOrderEarningsById - /order_earnings/{order_id} |
| getOrderEarningsSummary | GET | /order_earnings_summary | Returns a summary of earnings information for orders created during the last 12 months or within a specified date range. | View getOrderEarningsSummary - /order_earnings_summary |
payout
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPayout | GET | /payout/{payout_Id} | Retrieves the details of a specific seller payout. | View getPayout - /payout/{payout_Id} |
| getPayouts | GET | /payout | Retrieves the details of seller payouts matching search criteria. | View getPayouts - /payout |
| getPayoutSummary | GET | /payout_summary | Retrieves the total count and values of a seller's payouts, and the number of monetary transactions associated with those payouts. | View getPayoutSummary - /payout_summary |
seller_funds_summary
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getSellerFundsSummary | GET | /seller_funds_summary | Retrieves all pending funds that have not yet been distributed through a seller payout. | View getSellerFundsSummary - /seller_funds_summary |
transaction
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getTransactions | GET | /transaction | Retrieves the details of monetary transactions matching search criteria. | View getTransactions - /transaction |
| getTransactionSummary | GET | /transaction_summary | Retrieves the total counts and values for various monetary transactions occurring with the seller's account. | View getTransactionSummary - /transaction_summary |
transfer
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getTransfer | GET | /transfer/{transfer_Id} | Retrieves detailed information on a monetary transaction where the seller is reimbursing eBay for one or more changes, such as a buyer refund. | View getTransfer - /transfer/{transfer_Id} |
billing_activity
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getBillingActivities | GET | /billing_activity | Retrieves billing activities of the seller. | View getBillingActivities - /billing_activity |