|
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.SetStoreCategoriesCall
public class SetStoreCategoriesCall
Wrapper class of the SetStoreCategories 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.
Action
- Specifies the type of action (Add, Move, Delete, or Rename) to carry out
for the specified eBay Store categories.
ItemDestinationCategoryID
- Items can only be contained within child categories. A parent category
cannot contain items. If adding, moving, or deleting categories displaces
items, you must specify a destination child category under which the
displaced items will be moved. The destination category must have no
child categories.
DestinationParentCategoryID
- When adding or moving store categories, specifies the category under
which the listed categories will be located. To add or move categories to
the top level, set the value to -999.
StoreCategories
- Specifies the store categories on which to act.
ReturnedTaskID
- The task ID associated with the category structure change request. For a
simple change, the SetStoreCategories call is processed synchronously.
That is, simple changes are made immediately and then the response is
returned. For synchronous processing, the task ID in the response is 0.
If the category structure changes affect many listings, the changes will
be processed asynchronously and the task ID will be a positive number.
Use the non-zero task ID with GetStoreCategoryUpdateStatus to monitor
the status of asynchronously processed changes.
ReturnedStatus
- When an eBay Store category structure change is processed synchronously, the status
is returned as 'Complete' or 'Failed'. For asynchronously processed changes,
the status is reported as 'InProgress' or 'Pending'. Use GetStoreCategoryUpdateStatus to
monitor the status of asynchronously processed changes.
ReturnedCustomCategory
- Contains hierarchy data for eBay Store categories that you have created/modified.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
SetStoreCategoriesCall()
Constructor. |
|
SetStoreCategoriesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
StoreCategoryUpdateActionCodeType |
getAction()
Gets the SetStoreCategoriesRequestType.action. |
java.lang.Long |
getDestinationParentCategoryID()
Gets the SetStoreCategoriesRequestType.destinationParentCategoryID. |
java.lang.Long |
getItemDestinationCategoryID()
Gets the SetStoreCategoriesRequestType.itemDestinationCategoryID. |
StoreCustomCategoryArrayType |
getReturnedCustomCategory()
Valid after executing the API. |
TaskStatusCodeType |
getReturnedStatus()
Valid after executing the API. |
long |
getReturnedTaskID()
Valid after executing the API. |
StoreCustomCategoryArrayType |
getStoreCategories()
Gets the SetStoreCategoriesRequestType.storeCategories. |
void |
setAction(StoreCategoryUpdateActionCodeType action)
Sets the SetStoreCategoriesRequestType.action. |
void |
setDestinationParentCategoryID(java.lang.Long destinationParentCategoryID)
Sets the SetStoreCategoriesRequestType.destinationParentCategoryID. |
void |
setItemDestinationCategoryID(java.lang.Long itemDestinationCategoryID)
Sets the SetStoreCategoriesRequestType.itemDestinationCategoryID. |
long |
setStoreCategories()
This call allows you to set or modify the category structure of an eBay Store. |
void |
setStoreCategories(StoreCustomCategoryArrayType storeCategories)
Sets the SetStoreCategoriesRequestType.storeCategories. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SetStoreCategoriesCall()
public SetStoreCategoriesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public long setStoreCategories() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public StoreCategoryUpdateActionCodeType getAction()
public void setAction(StoreCategoryUpdateActionCodeType action)
action
- StoreCategoryUpdateActionCodeTypepublic java.lang.Long getDestinationParentCategoryID()
public void setDestinationParentCategoryID(java.lang.Long destinationParentCategoryID)
destinationParentCategoryID
- Longpublic java.lang.Long getItemDestinationCategoryID()
public void setItemDestinationCategoryID(java.lang.Long itemDestinationCategoryID)
itemDestinationCategoryID
- Longpublic StoreCustomCategoryArrayType getStoreCategories()
public void setStoreCategories(StoreCustomCategoryArrayType storeCategories)
storeCategories
- StoreCustomCategoryArrayTypepublic StoreCustomCategoryArrayType getReturnedCustomCategory()
public TaskStatusCodeType getReturnedStatus()
public long getReturnedTaskID()
|
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.