GET/promotion_report
This method generates a report that lists the seller's running, paused, and ended promotions for the specified eBay marketplace. The result set can be filtered by the promotion status and the number of results to return. You can also supply keywords to limit the report to promotions that contain the specified keywords.
Specify the eBay marketplace for which you want the report run using the marketplace_id query parameter. Supply additional query parameters to control the report as needed.
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 |
---|---|---|
q | string | A string consisting of one or more keywords. eBay filters the response by returning only the promotions that contain the supplied keywords in the promotion title. Example: "iPhone" or "Harry Potter." Commas that separate keywords are ignored. For example, a keyword string of "iPhone, iPad" equals "iPhone iPad", and each results in a response that contains promotions with both "iPhone" and "iPad" in the title. Occurrence: Optional |
limit | string | Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200 Occurrence: Optional |
offset | string | Specifies the number of promotions to skip in the result set before returning the first promotion in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of Default: 0 Occurrence: Optional |
marketplace_id | string | The eBay marketplace ID of the site for which you want the promotions report. Valid values:
Occurrence: Required |
promotion_status | string | Limits the results to the promotions that are in the state specified by this query parameter. Valid values:
Occurrence: Optional |
promotion_type | string | Filters the returned promotions in the report based on their campaign promotion type. Specify one of the following values to indicate the promotion type you want returned in the report:
Occurrence: Optional |
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 |
---|---|---|
href | string | The URI of the current page of results from the result set. Occurrence: Always |
limit | integer | The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter. Occurrence: Always |
next | string | The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Occurrence: Conditional |
offset | integer | The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Always |
prev | string | The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Occurrence: Conditional |
promotionReports | array of PromotionReportDetail | A list of promotionReports contained in the paginated result set. Occurrence: Always |
promotionReports.averageItemDiscount | Amount | The average item discount is the average discount that has been applied to each item in a promotion. This value is calculated as follows: Occurrence: Always |
promotionReports.averageItemDiscount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.averageItemDiscount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.averageItemRevenue | Amount | The average item revenue is the average revenue that has been received for each item in a promotion. This value is calculated as follows: Occurrence: Always |
promotionReports.averageItemRevenue.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.averageItemRevenue.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.averageOrderDiscount | Amount | The average order discount is the average discount that has been applied to each order in a promotion. This value is calculated as follows: Occurrence: Always |
promotionReports.averageOrderDiscount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.averageOrderDiscount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.averageOrderRevenue | Amount | The average order revenue is the average revenue that has been received for each order in a promotion. This value is calculated as follows: Occurrence: Always |
promotionReports.averageOrderRevenue.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.averageOrderRevenue.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.averageOrderSize | string | The average order size is the average number of items that each order contained in a promotion. This value is calculated as follows: Occurrence: Always |
promotionReports.baseSale | Amount | This is the monetary amount of items purchased in a promotion where the threshold wasn't met, so the discount was not applied. Occurrence: Always |
promotionReports.baseSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.baseSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.itemsSoldQuantity | integer | This is the quantity of items purchased in a threshold promotion where the threshold has been met and the discount was applied. Occurrence: Always |
promotionReports.numberOfOrdersSold | integer | This is the number of orders sold in a threshold promotion where the threshold has been met and the discount was applied. Occurrence: Always |
promotionReports.percentageSalesLift | string | The percentage sales lift is the total dollar amount gained due to promotions. This value is calculated as follows: Occurrence: Conditional |
promotionReports.promotionHref | string | The URI of the promotion report. Occurrence: Always |
promotionReports.promotionId | string | A unique eBay-assigned ID for the promotion that's generated when the promotion is created. Occurrence: Always |
promotionReports.promotionReportId | string | The unique eBay-assigned ID of the promotion report that is generated when the report is created. Occurrence: Conditional |
promotionReports.promotionSale | Amount | This is the monetary amount of the items sold in a threshold promotion where the threshold has been met and the discount was applied. Occurrence: Always |
promotionReports.promotionSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.promotionSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.promotionType | PromotionTypeEnum | Indicates the type of the promotion, either Occurrence: Always |
promotionReports.totalDiscount | Amount | This is the monetary discount amount applied to the sale of items in a threshold promotion where the threshold has been met and the discount was applied. Occurrence: Always |
promotionReports.totalDiscount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.totalDiscount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
promotionReports.totalSale | Amount | This is the total monetary sales amount of all items sold in a promotion. Occurrence: Always |
promotionReports.totalSale.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
promotionReports.totalSale.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
total | integer | The total number of items retrieved in the result set. Occurrence: Always |
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 |
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. |
38211 | API_MARKETING | REQUEST | The offset value must be an integer value greater than or equal to zero. |
38213 | API_MARKETING | REQUEST | You can query a limit of between 0 and 200 promotion records at a time. Update the request and resubmit the call. |
38240 | API_MARKETING | REQUEST | Invalid input for the 'promotionStatus' field. For help, see the documentation for this call. |
345141 | API_MARKETING | REQUEST | Invalid input for the 'promotionType' field. For help, 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 Level Report
This sample returns a report on the performance of a seller's promotion for the specified marketplace.
Input
This sample contains marketplace_id (which is required) and the promotion_status fields. The report includes all ended promotions.
GEThttps://api.ebay.com/sell/marketing/v1/promotion_report?marketplace_id=EBAY_US&promotion_status=ENDED
Output
The response body contains the fields of the report.