Get promotionpromotion_idget_listing_set — sell-marketing

v1

latestOpenAPI 3.0.0eBay API License Agreement2026-07-1469127536.5 KB

promotion

This method returns the set of listings associated with the promotion_id specified in the path parameter. Call <a href="/api-docs/sell/marketing/resources/promotion/methods/getPromotions">getPromotions</a> to retrieve the IDs of a seller's promotions. The listing details are returned in a paginated set and you can control and results returned using the following query parameters: limit, offset, q, sort, and status. <ul><li>Maximum associated listings returned: 200</li> <li>Default number of listings returned: 200</li></ul>

get/promotion/{promotion_id}/get_listing_set

Path parameters

promotion_idstring required

This path parameter takes a concatenation of the ID of the promotion you want to get plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@). The ID of the promotion (promotionId) is a unique eBay-assigned value that's generated when the promotion is created. The Marketplace ID is the ENUM value of eBay marketplace where the promotion is hosted. Example: <code>1********5@EBAY_US</code>

Query parameters

limitstring

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

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

qstring

Reserved for future use.

sortstring

Specifies the order in which to sort the associated listings in the response. If you precede the supplied value with a dash, the response is sorted in reverse order. Example: <code>sort=PRICE</code> - Sorts the associated listings by their current price in ascending order <code>sort=-TITLE</code> - Sorts the associated listings by their title in descending alphabetical order (Z-Az-a) Valid values:<ul class="compact"><li>AVAILABLE</li> <li>PRICE</li> <li>TITLE</li></ul> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/marketing/types/csb:SortField

statusstring

This query parameter applies only to markdown promotions. It filters the response based on the indicated status of the promotion. Currently, the only supported value for this parameter is <code>MARKED_DOWN</code>, which indicates active markdown promotions. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/marketing/types/sme:ItemMarkdownStatusEnum

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>.