com.ebay.sdk.call
Class AddItemCall

java.lang.Object
  com.ebay.sdk.ApiCall
      com.ebay.sdk.call.AddItemCall

public class AddItemCall
extends ApiCall

Wrapper class of the AddItem call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2007

Company: eBay Inc.

Input property: Item - Child elements hold the values that define the new item. Item is a required input. Also applicable to Half.com.
Output property: ReturnedItemID - Unique item ID for the new listing. Also applicable to Half.com.
Output property: ReturnedStartTime - Starting date and time for the new listing. Also returned for Half.com (for Half.com, the start time is always the time the item was listed).
Output property: ReturnedEndTime - Date and time when the new listing ends. This is the starting time plus the listing duration. Also returned for Half.com, but for Half.com the actual end time is GTC (not the end time returned in the response).
Output property: ReturnedFees - Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Also returned for Half.com, but the values are not applicable to Half.com listings.
Output property: ReturnedCategoryID - ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. Not applicable to Half.com.
Output property: ReturnedCategory2ID - ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. Not applicable to Half.com.

Field Summary

Fields inherited from class com.ebay.sdk.ApiCall

apiException, fullCredentials, sendReqListeners

Constructor Summary

AddItemCall()
Constructor.

AddItemCall(ApiContext apiContext)
Constructor.

Method Summary

FeesType	addItem() Defines a single new item and lists it on a specified eBay site.
boolean	getAutoSetItemUUID() Returns AutoSetItemUUID property.
ItemType	getItem() Gets the AddItemRequestType.item.
String[]	getPictureFiles() Gets list of picture files for the item.
PictureService	getPictureService() Gets the PictureService object that will be used to upload picture files specified in setPictureFiles().
String	getReturnedCategory2ID() Valid after executing the API.
String	getReturnedCategoryID() Valid after executing the API.
Calendar	getReturnedEndTime() Valid after executing the API.
FeesType	getReturnedFees() Valid after executing the API.
ItemIDType	getReturnedItemID() Valid after executing the API.
Calendar	getReturnedStartTime() Valid after executing the API.
static UUIDType	newUUID() Generates a UUID.
static void	resetItemUUID(ItemType item) Reset the UUID property of eBay item object.
void	setAutoSetItemUUID(boolean autoSetItemUUID) Sets AutoSetItemUUID property.
void	setItem(ItemType item) Sets the AddItemRequestType.item.
void	setPictureFiles(String[] pictureFiles) Sets list of picture files for the item.
void	setPictureService(PictureService pictureService) Set the PictureService object that will be used to upload picture files specified in setPictureFiles().

Methods inherited from class com.ebay.sdk.ApiCall

addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getCallRetry, getDetailLevel, getEnableCompression, getRequestXml, getResponseObject, getResponseXml, getSite, hasError, hasWarning, removeSendRequestListener, setApiContext, setCallRetry, setDetailLevel, setEnableCompression, setSite

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddItemCall

public AddItemCall()

Constructor.

AddItemCall

public AddItemCall(ApiContext apiContext)

Constructor.

Parameters:

apiContext - The ApiContext object to be used to make the call.

Method Detail

addItem

public FeesType addItem()
                 throws ApiException,
                        SdkException,
                        Exception

Defines a single new item and lists it on a specified eBay site. To list multiple new items, execute AddItem once for each item, with a new item definition each time.

Returns:

The FeesType object.

Throws:

ApiException

SdkException

Exception

getItem

public ItemType getItem()

Gets the AddItemRequestType.item.

Returns:

ItemType

setItem

public void setItem(ItemType item)

Sets the AddItemRequestType.item.

Parameters:

item - ItemType

getAutoSetItemUUID

public boolean getAutoSetItemUUID()

Returns AutoSetItemUUID property.

Returns:

true means if UUID property of item (item.getUUID()) is null, the call object will automatically generate an UUID and fills it to the item object (item.setUUID()).

getPictureFiles

public String[] getPictureFiles()

Gets list of picture files for the item.

Returns:

String[]

getPictureService

public PictureService getPictureService()

Gets the PictureService object that will be used to upload picture files specified in setPictureFiles().

Returns:

The PictureService instance.

newUUID

public static UUIDType newUUID()

Generates a UUID.

Returns:

The UUIDType object.

resetItemUUID

public static void resetItemUUID(ItemType item)

Reset the UUID property of eBay item object.

Parameters:

item - The ItemType object whose UUID property will be reset.

setAutoSetItemUUID

public void setAutoSetItemUUID(boolean autoSetItemUUID)

Sets AutoSetItemUUID property. true means if UUID property of item is null, the call object will automatically generate an UUID and fills it to the item object (item.setUUID()).

Parameters:

autoSetItemUUID - boolean

setPictureFiles

public void setPictureFiles(String[] pictureFiles)

Sets list of picture files for the item. Before listing the item, the attached picture service object (setPictureService()) to upload these picture files then set the picture property of the item object.

Parameters:

pictureFiles - String[]

setPictureService

public void setPictureService(PictureService pictureService)

Set the PictureService object that will be used to upload picture files specified in setPictureFiles().

Parameters:

pictureService - the PictureService object.

getReturnedCategory2ID

public String getReturnedCategory2ID()

Valid after executing the API. Gets the returned AddItemResponseType.returnedCategory2ID.

Returns:

String

getReturnedCategoryID

public String getReturnedCategoryID()

Valid after executing the API. Gets the returned AddItemResponseType.returnedCategoryID.

Returns:

String

getReturnedEndTime

public Calendar getReturnedEndTime()

Valid after executing the API. Gets the returned AddItemResponseType.returnedEndTime.

Returns:

Calendar

getReturnedFees

public FeesType getReturnedFees()

Valid after executing the API. Gets the returned AddItemResponseType.returnedFees.

Returns:

FeesType

getReturnedItemID

public ItemIDType getReturnedItemID()

Valid after executing the API. Gets the returned AddItemResponseType.returnedItemID.

Returns:

ItemIDType

getReturnedStartTime

public Calendar getReturnedStartTime()

Valid after executing the API. Gets the returned AddItemResponseType.returnedStartTime.

Returns:

Calendar