marketing APIv1.10.0

getPromotionSummaryReport

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 (production)

GET https://api.ebay.com/sell/marketing/v1/promotion_summary_report?

URI parameters

ParameterTypeDescription
marketplace_idstringThe eBay marketplace ID of the site you for which you want a promotion summary report.

Valid values:

  • EBAY_AU = Australia
  • EBAY_DE = Germany
  • EBAY_ES = Spain
  • EBAY_FR = France
  • EBAY_GB = Great Britain
  • EBAY_IT = Italy
  • EBAY_US = United States

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Output

HTTP response headers

Output container/fieldTypeDescription
baseSaleAmountThe 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.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

baseSale.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

lastUpdatedstringThe date the report was generated.

Occurrence: Always

percentageSalesLiftstringThe percentage of the total dollar amount gained due to promotions. This value is calculated as follows:

precentageSalesLift = promotionSale / (baseSale + promotionSale)

Occurrence: Always

promotionSaleAmountThe 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.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

promotionSale.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

totalSaleAmountTotal dollar sales amount of all the seller's listings, current to the date the report was generated.

Occurrence: Always

totalSale.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

totalSale.valuestringThe monetary amount in the specified currency.

Required in the amount type.

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.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
38201API_MARKETINGAPPLICATIONInternal server error encountered. If this problem persists, contact the eBay Developers Program for support.
38204API_MARKETINGREQUESTThe 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

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.
GET
https://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.