eBay::API::XML::Call::SetPromotionalSaleListings::SetPromotionalSaleListingsRequestType(3)

NAME
eBay::API::XML::Call::SetPromotionalSaleListings::SetPromotionalSaleListingsRequestType

DESCRIPTION
Used to change which item listings are affected by a promotional sale. Item listings affected by a promotional sale have a reduced price and/or free shipping and are displayed as items on sale. Use the Action field to specify addition of listings to, or deletion of listings from, a promotional sale. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings. Promotional sales apply to single and multi-quantity Store Inventory format, regular fixed-price format, auction, and auction/BIN formats. Auction and auction/BIN format listings can be added free shipping sales only.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::SetPromotionalSaleListings::SetPromotionalSaleListingsRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

  setAction()
You must specify either Add or Delete. This field determines whether you are adding listings to, or deleting listings from, the promotional sale you specify in the PromotionalSaleID field. If you specify Delete, you must specify PromotionalSaleItemIDArray. Delete is applicable only in cases where you specify PromotionalSaleItemIDArray. Auction or auction/BIN format listings cannot be added to or deleted from a promotional sale if the item has bids.

  RequiredInput: Yes
  OnlyTheseValues: Add, Delete
#    Argument: 'ns:ModifyActionCodeType'

  getAction()
# Returns: 'ns:ModifyActionCodeType'

  setAllAuctionItems()
Adds to the promotional sale all the seller's item listings that are auction items. Auction and auction/BIN format listings can be added to free shipping sales only. Requires that you specify Add in the Action field.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isAllAuctionItems()
# Returns: 'xs:boolean'

  setAllFixedPriceItems()
Adds to the promotional sale all the seller's item listings that are fixed price items. Requires that you specify Add in the Action field.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isAllFixedPriceItems()
# Returns: 'xs:boolean'

  setAllStoreInventoryItems()
Adds to the promotional sale all the seller's item listings that are store inventory items. Requires that you specify Add in the Action field.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isAllStoreInventoryItems()
# Returns: 'xs:boolean'

  setCategoryID()
Adds to the promotional sale all the seller's item listings with the CategoryID specified in this field. Requires that you specify Add in the Action field.

  RequiredInput: No
#    Argument: 'xs:long'

  getCategoryID()
# Returns: 'xs:long'

  setPromotionalSaleID()
The ID of the promotional sale that you want to add listings to or delete listings from.

  RequiredInput: Yes
#    Argument: 'xs:long'

  getPromotionalSaleID()
# Returns: 'xs:long'

  setPromotionalSaleItemIDArray()
The IDs of the item listings to be affected by the action you specify in the Action field.

  RequiredInput: Conditionally
#    Argument: 'ns:ItemIDArrayType'

  getPromotionalSaleItemIDArray()
# Returns: 'ns:ItemIDArrayType'

  setStoreCategoryID()
Adds to the promotional sale all the seller's item listings with the StoreCategoryID specified in this field. Requires that you specify Add in the Action field.

  RequiredInput: No
#    Argument: 'xs:long'

  getStoreCategoryID()
# Returns: 'xs:long'