SetPromotionalSaleListingsRequestType

Defines the SetPromotionalSaleListings call request.

Fields

Action ( ModifyActionCodeType )
AllAuctionItems ( boolean )
AllFixedPriceItems ( boolean )
AllStoreInventoryItems ( boolean )
CategoryID ( long )
PromotionalSaleID ( long )
PromotionalSaleItemIDArray ( ItemIDArrayType )
StoreCategoryID ( long )

Action ( see ModifyActionCodeType for possible values ) [1]
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]
If this field is included and set to 'true' in the call request, all store inventory items 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 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 ) [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 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.

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.