Changes since
the last release

com.ebay.sdk.call
Class AddItemCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by 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) 2009

Company: eBay Inc.


Input property: Item - This container is used to specify all of the values and settings that define a new listing.
Output property: ReturnedItemID - Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
Output property: ReturnedStartTime - Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the Item.ScheduleTime field in the request and set a custom start time of the listing (in the future).
Output property: ReturnedEndTime - Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time. If the value of ListingDuration was set to GTC (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time.
Output property: ReturnedFees - This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
Output property: ReturnedCategoryID - The unique identifier of the primary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is included and set to true in the request and the Category ID passed in as the primary listing category was mapped to a new Category ID by eBay. If the primary category has not changed, or if it has expired with no replacement, this field is not returned.
Output property: ReturnedCategory2ID - Unique identifier of the secondary category in which the item was listed. This field is only returned if a secondary category was used, the Item.CategoryMappingAllowed boolean field is included and set to true in the request, and the Category ID passed in as the secondary listing category was mapped to a new Category ID by eBay. If the secondary category has not changed or it has expired with no replacement, this field is not returned.
Output property: ReturnedDiscountReason - This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.
Output property: ReturnedProductSuggestions - This container holds an array of one or more products in the eBay product catalog that appear to match the product being listed, just based on the information in the listing. This container will not be returned if no similar products were found in the eBay product catalog.
Output property: ReturnedListingRecommendations - Container consisting of one or more Recommendation containers. Each Recommendation container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.

This container is only returned if the IncludeRecommendations flag was included and set to 'true' in the AddItem request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddItemCall()
          Constructor.
AddItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 FeesType addItem()
          Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.
 boolean getAutoSetItemUUID()
          Returns AutoSetItemUUID property.
 ItemType getItem()
          Gets the AddItemRequestType.item.
 java.lang.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().
 java.lang.String getReturnedCategory2ID()
          Valid after executing the API.
 java.lang.String getReturnedCategoryID()
          Valid after executing the API.
 DiscountReasonCodeType[] getReturnedDiscountReason()
          Valid after executing the API.
 java.util.Calendar getReturnedEndTime()
          Valid after executing the API.
 FeesType getReturnedFees()
          Valid after executing the API.
 java.lang.String getReturnedItemID()
          Valid after executing the API.
 ListingRecommendationsType getReturnedListingRecommendations()
          Valid after executing the API.
 ProductSuggestionsType getReturnedProductSuggestions()
          Valid after executing the API.
 java.util.Calendar getReturnedStartTime()
          Valid after executing the API.
static java.lang.String 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(java.lang.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, 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

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,
                        java.lang.Exception
Base request type for the AddItem call, which is used to create a fixed-price, auction, or classified ad listing.

Returns:
The FeesType object.
Throws:
ApiException
SdkException
java.lang.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 java.lang.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 java.lang.String newUUID()
Generates a UUID.

Returns:
The UUID String 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(java.lang.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 java.lang.String getReturnedCategory2ID()
Valid after executing the API. Gets the returned AddItemResponseType.returnedCategory2ID.

Returns:
String

getReturnedCategoryID

public java.lang.String getReturnedCategoryID()
Valid after executing the API. Gets the returned AddItemResponseType.returnedCategoryID.

Returns:
String

getReturnedDiscountReason

public DiscountReasonCodeType[] getReturnedDiscountReason()
Valid after executing the API. Gets the returned AddItemResponseType.returnedDiscountReason.

Returns:
DiscountReasonCodeType[]

getReturnedEndTime

public java.util.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 java.lang.String getReturnedItemID()
Valid after executing the API. Gets the returned AddItemResponseType.returnedItemID.

Returns:
String

getReturnedListingRecommendations

public ListingRecommendationsType getReturnedListingRecommendations()
Valid after executing the API. Gets the returned AddItemResponseType.returnedListingRecommendations.

Returns:
ListingRecommendationsType

getReturnedProductSuggestions

public ProductSuggestionsType getReturnedProductSuggestions()
Valid after executing the API. Gets the returned AddItemResponseType.returnedProductSuggestions.

Returns:
ProductSuggestionsType

getReturnedStartTime

public java.util.Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned AddItemResponseType.returnedStartTime.

Returns:
Calendar

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.