Changes since
the last release

com.ebay.sdk.call
Class SetPromotionalSaleListingsCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.SetPromotionalSaleListingsCall

public class SetPromotionalSaleListingsCall
extends ApiCall

Wrapper class of the SetPromotionalSaleListings call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: PromotionalSaleID - 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.
Input property: Action - 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.
Input property: PromotionalSaleItemIDArray - 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.
Input property: StoreCategoryID - 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'.
Input property: CategoryID - 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'.
Input property: AllFixedPriceItems - 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'.
Input property: AllStoreInventoryItems - This field is deprecated and should no longer be used because Store Inventory is no longer a supported listing format.
Input property: AllAuctionItems - 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'.
Output property: ReturnedStatus - The enumeration value in this field indicates the status of the promotional sale action (add or delete). See PromotionalSaleStatusCodeType for more information on status values.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetPromotionalSaleListingsCall()
          Constructor.
SetPromotionalSaleListingsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ModifyActionCodeType getAction()
          Gets the SetPromotionalSaleListingsRequestType.action.
 java.lang.Boolean getAllAuctionItems()
          Gets the SetPromotionalSaleListingsRequestType.allAuctionItems.
 java.lang.Boolean getAllFixedPriceItems()
          Gets the SetPromotionalSaleListingsRequestType.allFixedPriceItems.
 java.lang.Boolean getAllStoreInventoryItems()
          Gets the SetPromotionalSaleListingsRequestType.allStoreInventoryItems.
 java.lang.Long getCategoryID()
          Gets the SetPromotionalSaleListingsRequestType.categoryID.
 java.lang.Long getPromotionalSaleID()
          Gets the SetPromotionalSaleListingsRequestType.promotionalSaleID.
 ItemIDArrayType getPromotionalSaleItemIDArray()
          Gets the SetPromotionalSaleListingsRequestType.promotionalSaleItemIDArray.
 PromotionalSaleStatusCodeType getReturnedStatus()
          Valid after executing the API.
 java.lang.Long getStoreCategoryID()
          Gets the SetPromotionalSaleListingsRequestType.storeCategoryID.
 void setAction(ModifyActionCodeType action)
          Sets the SetPromotionalSaleListingsRequestType.action.
 void setAllAuctionItems(java.lang.Boolean allAuctionItems)
          Sets the SetPromotionalSaleListingsRequestType.allAuctionItems.
 void setAllFixedPriceItems(java.lang.Boolean allFixedPriceItems)
          Sets the SetPromotionalSaleListingsRequestType.allFixedPriceItems.
 void setAllStoreInventoryItems(java.lang.Boolean allStoreInventoryItems)
          Sets the SetPromotionalSaleListingsRequestType.allStoreInventoryItems.
 void setCategoryID(java.lang.Long categoryID)
          Sets the SetPromotionalSaleListingsRequestType.categoryID.
 void setPromotionalSaleID(java.lang.Long promotionalSaleID)
          Sets the SetPromotionalSaleListingsRequestType.promotionalSaleID.
 void setPromotionalSaleItemIDArray(ItemIDArrayType promotionalSaleItemIDArray)
          Sets the SetPromotionalSaleListingsRequestType.promotionalSaleItemIDArray.
 PromotionalSaleStatusCodeType setPromotionalSaleListings()
          Enables the seller to change the item listings that are affected by a promotional sale.
 void setStoreCategoryID(java.lang.Long storeCategoryID)
          Sets the SetPromotionalSaleListingsRequestType.storeCategoryID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetPromotionalSaleListingsCall

public SetPromotionalSaleListingsCall()
Constructor.


SetPromotionalSaleListingsCall

public SetPromotionalSaleListingsCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

setPromotionalSaleListings

public PromotionalSaleStatusCodeType setPromotionalSaleListings()
                                                         throws ApiException,
                                                                SdkException,
                                                                java.lang.Exception
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.

Returns:
The PromotionalSaleStatusCodeType object.
Throws:
ApiException
SdkException
java.lang.Exception

getAction

public ModifyActionCodeType getAction()
Gets the SetPromotionalSaleListingsRequestType.action.

Returns:
ModifyActionCodeType

setAction

public void setAction(ModifyActionCodeType action)
Sets the SetPromotionalSaleListingsRequestType.action.

Parameters:
action - ModifyActionCodeType

getAllAuctionItems

public java.lang.Boolean getAllAuctionItems()
Gets the SetPromotionalSaleListingsRequestType.allAuctionItems.

Returns:
Boolean

setAllAuctionItems

public void setAllAuctionItems(java.lang.Boolean allAuctionItems)
Sets the SetPromotionalSaleListingsRequestType.allAuctionItems.

Parameters:
allAuctionItems - Boolean

getAllFixedPriceItems

public java.lang.Boolean getAllFixedPriceItems()
Gets the SetPromotionalSaleListingsRequestType.allFixedPriceItems.

Returns:
Boolean

setAllFixedPriceItems

public void setAllFixedPriceItems(java.lang.Boolean allFixedPriceItems)
Sets the SetPromotionalSaleListingsRequestType.allFixedPriceItems.

Parameters:
allFixedPriceItems - Boolean

getAllStoreInventoryItems

public java.lang.Boolean getAllStoreInventoryItems()
Gets the SetPromotionalSaleListingsRequestType.allStoreInventoryItems.

Returns:
Boolean

setAllStoreInventoryItems

public void setAllStoreInventoryItems(java.lang.Boolean allStoreInventoryItems)
Sets the SetPromotionalSaleListingsRequestType.allStoreInventoryItems.

Parameters:
allStoreInventoryItems - Boolean

getCategoryID

public java.lang.Long getCategoryID()
Gets the SetPromotionalSaleListingsRequestType.categoryID.

Returns:
Long

setCategoryID

public void setCategoryID(java.lang.Long categoryID)
Sets the SetPromotionalSaleListingsRequestType.categoryID.

Parameters:
categoryID - Long

getPromotionalSaleID

public java.lang.Long getPromotionalSaleID()
Gets the SetPromotionalSaleListingsRequestType.promotionalSaleID.

Returns:
Long

setPromotionalSaleID

public void setPromotionalSaleID(java.lang.Long promotionalSaleID)
Sets the SetPromotionalSaleListingsRequestType.promotionalSaleID.

Parameters:
promotionalSaleID - Long

getPromotionalSaleItemIDArray

public ItemIDArrayType getPromotionalSaleItemIDArray()
Gets the SetPromotionalSaleListingsRequestType.promotionalSaleItemIDArray.

Returns:
ItemIDArrayType

setPromotionalSaleItemIDArray

public void setPromotionalSaleItemIDArray(ItemIDArrayType promotionalSaleItemIDArray)
Sets the SetPromotionalSaleListingsRequestType.promotionalSaleItemIDArray.

Parameters:
promotionalSaleItemIDArray - ItemIDArrayType

getStoreCategoryID

public java.lang.Long getStoreCategoryID()
Gets the SetPromotionalSaleListingsRequestType.storeCategoryID.

Returns:
Long

setStoreCategoryID

public void setStoreCategoryID(java.lang.Long storeCategoryID)
Sets the SetPromotionalSaleListingsRequestType.storeCategoryID.

Parameters:
storeCategoryID - Long

getReturnedStatus

public PromotionalSaleStatusCodeType getReturnedStatus()
Valid after executing the API. Gets the returned SetPromotionalSaleListingsResponseType.returnedStatus.

Returns:
PromotionalSaleStatusCodeType

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.