GET/promotion_summary_report
This method generates a report that summarizes the seller's promotions for the specified eBay marketplace. The report returns information on RUNNING, PAUSED, and ENDED promotions (deleted reports are not returned) and summarizes the seller's campaign performance for all promotions on a given site.
For information about summary reports, see Reading the item promotion Summary report.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | string | The eBay marketplace ID of the site you for which you want a promotion summary report. Valid values:
Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.marketing.readonly
https://api.ebay.com/oauth/api_scope/sell.marketing
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| baseSale | Amount | The total revenue from all the purchased items that were part of a promotion but did not trigger a discount during the promotion period. Occurrence: Always |
| baseSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| baseSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| lastUpdated | string | The date the report was generated. Occurrence: Always |
| percentageSalesLift | string | The percentage of the total dollar amount gained due to promotions. This value is calculated as follows: Occurrence: Always |
| promotionSale | Amount | The total revenue from all the purchased items that were part of a promotion and their purchase did trigger a discount during the promotion period. Occurrence: Always |
| promotionSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| promotionSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| totalSale | Amount | Total dollar sales amount of all the seller's listings, current to the date the report was generated. Occurrence: Always |
| totalSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| totalSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 38201 | API_MARKETING | APPLICATION | Internal server error encountered. If this problem persists, contact the eBay Developers Program for support. |
| 38204 | API_MARKETING | REQUEST | The seller is not eligible for promotions because they do not have an eBay Store or they have not accepted the terms and conditions for creating a promotion on this Marketplace, see the documentation for this call. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Generate Promotion Summary Report
This sample returns a summary report for all the seller's promotions for the specified eBay marketplace.
Input
This method does not use a request payload. Specify the marketplace on which you want the summary report run using the marketplace_id query parameter.
GEThttps://api.ebay.com/sell/marketing/v1/promotion_summary_report?marketplace_id=EBAY_US
Output
The reponse body contains the fields of the report, for details see Reading the Promotion Summary Report. You can use the report information to populate a page that summarizes a seller's promotion performance for a given marketplace.