eBay Trading APIVersion 1161

SetPromotionalSaleListingsRequestType ( AbstractRequestType )

Note: While the Trading API continues to support item promotions for an eBay store owner, the Trading API will no longer be enhanced with any new item promotion capabilities as they are developed by eBay. In addition, Promoted Listings are also not supported by the Trading API. For these two reasons, it is recommended that sellers/developers make plans to migrate to the Marketing API, which provides all Promotions Manager and Promoted Listings capabilities, and this API will continue to be improved and enhanced as more marketing features become available to sellers. Enables the seller to change the item listings that are affected by a promotional sale. To use this call, the seller must be a registered eBay Store owner.

Call that uses SetPromotionalSaleListingsRequestType:

Fields



This required field determines whether you are adding (specify 'Add') or removing (specify 'Delete) one or more listings from the promotional sale identified by the PromotionalSaleID value in the request.

If you specify 'Delete', you must include one or more ItemID values under the PromotionalSaleItemIDArray container, and you cannot use the other filter options in the request. If you specify 'Add', you can add one or more listings using any of the filtering options in the request. Active auction listings that have one or more bids cannot be added to or removed from a promotional sale.
See the Field Index to learn which calls use Action.

AllAuctionItems ( boolean ) [0..1]
If this field is included and set to 'true' in the call request, all auction listings are added to the promotional sale. This field cannot be used if the Action field is set to 'Delete'.
See the Field Index to learn which calls use AllAuctionItems.

AllFixedPriceItems ( boolean ) [0..1]
If this field is included and set to 'true' in the call request, all fixed-price listings are added to the promotional sale. This field cannot be used if the Action field is set to 'Delete'.
See the Field Index to learn which calls use AllFixedPriceItems.

AllStoreInventoryItems ( boolean ) [0..1]
Not used by any call.

This field is deprecated and should no longer be used because Store Inventory is no longer a supported listing format.
See the Field Index to learn which calls use AllStoreInventoryItems.

CategoryID ( long ) [0..1]
If a CategoryID value is included in the call request, all active items in this eBay category are added to the promotional sale. This field cannot be used if the Action field is set to 'Delete'.
See the Field Index to learn which calls use CategoryID.

PromotionalSaleID ( long ) [0..1]
The unique identifier of the seller's promotional sale. Based on the Action value, listings will either be added to or removed from the promotional sale.
See the Field Index to learn which calls use PromotionalSaleID.

PromotionalSaleItemIDArray ( ItemIDArrayType ) [0..1]
Container consisting of one or more ItemID values. Based on the Action value, the listings identified by these ItemID values are either added to or removed from the promotional sale.

This container is required if listings are being removed (Action='Delete') from the promotional sale.
See the Field Index to learn which calls use PromotionalSaleItemIDArray.

StoreCategoryID ( long ) [0..1]
If a StoreCategoryID value is included in the call request, all active items in this eBay Store category are added to the promotional sale. This field cannot be used if the Action field is set to 'Delete'.
See the Field Index to learn which calls use StoreCategoryID.