Get promotion_report — sell-marketing

v1

latestOpenAPI 3.0.0eBay API License Agreement2026-07-1469127536.5 KB

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.

get/promotion_report

Query parameters

limitstring

Specifies the maximum number of promotions returned on a page from the result set. Default: 200 Maximum: 200

marketplace_idstring required

The eBay marketplace ID of the site for which you want the promotions report. Valid values: <ul><li><code>EBAY_AU</code> = Australia</li> <li><code>EBAY_DE</code> = Germany</li> <li><code>EBAY_ES</code> = Spain</li> <li><code>EBAY_FR</code> = France</li> <li><code>EBAY_GB</code> = Great Britain</li> <li><code>EBAY_IT</code> = Italy</li> <li><code>EBAY_US</code> = United States</li></ul>

offsetstring

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 <code>0</code> and a limit of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is <code>10</code> and limit is <code>20</code>, the first page of the response contains items 11-30 from the complete result set. Default: 0

promotion_statusstring

Limits the results to the promotions that are in the state specified by this query parameter. Valid values: <ul><li><code>DRAFT</code></li> <li><code>SCHEDULED</code></li> <li><code>RUNNING</code></li> <li><code>PAUSED</code></li> <li><code>ENDED</code></li></ul>Maximum number of values supported: 1

promotion_typestring

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: <ul><li><code>CODED_COUPON</code> – A coupon code promotion set with createItemPromotion.</li> <li><code>MARKDOWN_SALE</code> – A markdown promotion set with createItemPriceMarkdownPromotion.</li> <li><code>ORDER_DISCOUNT</code> – A threshold promotion set with createItemPromotion.</li> <li><code>VOLUME_DISCOUNT</code> – A volume pricing promotion set with createItemPromotion.</li></ul>

qstring

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.

Response

Success

hrefstring

The URI of the current page of results from the result set.

limitinteger

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.

nextstring

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. Max length: 2048

offsetinteger

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 <code>0</code>.

prevstring

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. Max length: 2048

totalinteger

The total number of items retrieved in the result set. If no items are found, this field is returned with a value of <code>0</code>.