|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.SetPromotionalSaleListingsCall
public class SetPromotionalSaleListingsCall
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.
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.
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.
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. 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'.
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'.
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'.
AllStoreInventoryItems
- This field is deprecated and should no longer be used because Store Inventory is no longer a supported listing format.
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'.
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.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SetPromotionalSaleListingsCall()
public SetPromotionalSaleListingsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public PromotionalSaleStatusCodeType setPromotionalSaleListings() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public ModifyActionCodeType getAction()
public void setAction(ModifyActionCodeType action)
action
- ModifyActionCodeTypepublic java.lang.Boolean getAllAuctionItems()
public void setAllAuctionItems(java.lang.Boolean allAuctionItems)
allAuctionItems
- Booleanpublic java.lang.Boolean getAllFixedPriceItems()
public void setAllFixedPriceItems(java.lang.Boolean allFixedPriceItems)
allFixedPriceItems
- Booleanpublic java.lang.Boolean getAllStoreInventoryItems()
public void setAllStoreInventoryItems(java.lang.Boolean allStoreInventoryItems)
allStoreInventoryItems
- Booleanpublic java.lang.Long getCategoryID()
public void setCategoryID(java.lang.Long categoryID)
categoryID
- Longpublic java.lang.Long getPromotionalSaleID()
public void setPromotionalSaleID(java.lang.Long promotionalSaleID)
promotionalSaleID
- Longpublic ItemIDArrayType getPromotionalSaleItemIDArray()
public void setPromotionalSaleItemIDArray(ItemIDArrayType promotionalSaleItemIDArray)
promotionalSaleItemIDArray
- ItemIDArrayTypepublic java.lang.Long getStoreCategoryID()
public void setStoreCategoryID(java.lang.Long storeCategoryID)
storeCategoryID
- Longpublic PromotionalSaleStatusCodeType getReturnedStatus()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.