Changes since
the last release

com.ebay.sdk.call
Class AddFixedPriceItemCall

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

public class AddFixedPriceItemCall
extends ApiCall

Wrapper class of the AddFixedPriceItem 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 - Root container holding all values that define a new fixed-price listing.
Output property: ReturnedItemID - Unique identifier for the new fixed-price listing.
Output property: ReturnedSKU - Item-level SKU for the new listing, if the seller specified Item.SKU in the request. Variation-level SKUs are not returned (see GetItem instead).
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 specified Item.ScheduleTime in the request.
Output property: ReturnedEndTime - Date and time when the new listing ends. This is the starting time plus the listing duration.
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.
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 if it has expired with no replacement, CategoryID does not return a value.
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.
Output property: ReturnedDiscountReason - The nature of the discount, if a discount is applied.
Output property: ReturnedProductSuggestions - Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com.
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 reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN.

This container is only returned if the IncludeRecommendations flag was included and set to 'true' in the AddFixedPriceItem 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
AddFixedPriceItemCall()
          Constructor.
AddFixedPriceItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 FeesType addFixedPriceItem()
          Defines and lists a new fixed-price listing (not auction-style listings).
 boolean getAutoSetItemUUID()
          Returns AutoSetItemUUID property.
 ItemType getItem()
          Gets the AddFixedPriceItemRequestType.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.
 DiscountReasonCodeType[] getReturnedDiscountReason()
          Valid after executing the API.
 Calendar getReturnedEndTime()
          Valid after executing the API.
 FeesType getReturnedFees()
          Valid after executing the API.
 String getReturnedItemID()
          Valid after executing the API.
 ListingRecommendationsType getReturnedListingRecommendations()
          Valid after executing the API.
 ProductSuggestionsType getReturnedProductSuggestions()
          Valid after executing the API.
 String getReturnedSKU()
          Valid after executing the API.
 Calendar getReturnedStartTime()
          Valid after executing the API.
static 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 AddFixedPriceItemRequestType.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, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

AddFixedPriceItemCall

public AddFixedPriceItemCall()
Constructor.


AddFixedPriceItemCall

public AddFixedPriceItemCall(ApiContext apiContext)
Constructor.

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

addFixedPriceItem

public FeesType addFixedPriceItem()
                           throws ApiException,
                                  SdkException,
                                  Exception
Defines and lists a new fixed-price listing (not auction-style listings). The main difference between AddFixedPriceItem and AddItem is that AddFixedPriceItem supports the creation of fixed-price listings only, whereas AddItem supports all listing formats.

Also, only AddFixedPriceItem supports multi-variation listings and tracking inventory by SKU. AddItem does not support Variations or InventoryTrackingMethod.

See the AddFixedPriceItem documentation for additional information.

Returns:
The FeesType object.
Throws:
ApiException
SdkException
Exception

getItem

public ItemType getItem()
Gets the AddFixedPriceItemRequestType.item.

Returns:
ItemType

setItem

public void setItem(ItemType item)
Sets the AddFixedPriceItemRequestType.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 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(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 AddFixedPriceItemResponseType.returnedCategory2ID.

Returns:
String

getReturnedCategoryID

public String getReturnedCategoryID()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.returnedCategoryID.

Returns:
String

getReturnedDiscountReason

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

Returns:
DiscountReasonCodeType[]

getReturnedEndTime

public Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.returnedEndTime.

Returns:
Calendar

getReturnedFees

public FeesType getReturnedFees()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.returnedFees.

Returns:
FeesType

getReturnedItemID

public String getReturnedItemID()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.returnedItemID.

Returns:
String

getReturnedListingRecommendations

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

Returns:
ListingRecommendationsType

getReturnedProductSuggestions

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

Returns:
ProductSuggestionsType

getReturnedSKU

public String getReturnedSKU()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.returnedSKU.

Returns:
String

getReturnedStartTime

public Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned AddFixedPriceItemResponseType.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.