Changes since
the last release

com.ebay.sdk.call
Class VerifyAddItemCall

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

public class VerifyAddItemCall
extends ApiCall

Wrapper class of the VerifyAddItem 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 listing.
Output property: ReturnedItemID - With a successful VerifyAddItem call, this field is always returned, but the returned value is always 0, since this call only validates the data passed in through the request payload and does not actually create an active listing.
Output property: ReturnedFees - Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.

There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions.
Output property: ReturnedExpressListing - This field is deprecated.
Output property: ReturnedExpressItemRequirements - This field is deprecated.
Output property: ReturnedCategoryID - ID of the primary category in which the item would be 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.
Output property: ReturnedCategory2ID - ID of the secondary category in which the item would be 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 would have applied had this actually been listed at this time.
Output property: ReturnedProductSuggestions - Provides a list of products recommended by eBay which match the item information provided by the seller.
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 VerifyAddItem request, and if at least one listing recommendation exists for the listing about to be listed. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the listing based on eBay's listing recommendation(s) before actually creating the listing through an AddItem call.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
VerifyAddItemCall()
          Constructor.
VerifyAddItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ItemType getItem()
          Gets the VerifyAddItemRequestType.item.
 java.lang.String[] getPictureFiles()
          Gets list of picture files for the item.
 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.
 ExpressItemRequirementsType getReturnedExpressItemRequirements()
          Valid after executing the API.
 java.lang.Boolean getReturnedExpressListing()
          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.
 void setItem(ItemType item)
          Sets the VerifyAddItemRequestType.item.
 void setPictureFiles(java.lang.String[] pictureFiles)
          Sets list of picture files for the item.
 FeesType verifyAddItem()
          Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.
 FeesType verifyAddItem(ItemType item)
          Executes the API call.
 
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

VerifyAddItemCall

public VerifyAddItemCall()
Constructor.


VerifyAddItemCall

public VerifyAddItemCall(ApiContext apiContext)
Constructor.

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

verifyAddItem

public FeesType verifyAddItem()
                       throws ApiException,
                              SdkException,
                              java.lang.Exception
Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.

Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding or verifying items. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and the agreement is located here. The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response.

Returns:
The FeesType object.
Throws:
ApiException
SdkException
java.lang.Exception

getItem

public ItemType getItem()
Gets the VerifyAddItemRequestType.item.

Returns:
ItemType

setItem

public void setItem(ItemType item)
Sets the VerifyAddItemRequestType.item.

Parameters:
item - ItemType

getPictureFiles

public java.lang.String[] getPictureFiles()
Gets list of picture files for the item.

Returns:
String[]

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[]

verifyAddItem

public FeesType verifyAddItem(ItemType item)
                       throws ApiException,
                              SdkException,
                              java.lang.Exception
Executes the API call. The picture files that you provided will not be uploaded and some dummy urls will be used instead.

Parameters:
item - ItemType
Returns:
FeesType The estimated fees information.
Throws:
ApiException
SdkException
java.lang.Exception

getReturnedCategory2ID

public java.lang.String getReturnedCategory2ID()
Valid after executing the API. Gets the returned VerifyAddItemResponseType.returnedCategory2ID.

Returns:
String

getReturnedCategoryID

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

Returns:
String

getReturnedDiscountReason

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

Returns:
DiscountReasonCodeType[]

getReturnedExpressItemRequirements

public ExpressItemRequirementsType getReturnedExpressItemRequirements()
Valid after executing the API. Gets the returned VerifyAddItemResponseType.returnedExpressItemRequirements.

Returns:
ExpressItemRequirementsType

getReturnedExpressListing

public java.lang.Boolean getReturnedExpressListing()
Valid after executing the API. Gets the returned VerifyAddItemResponseType.returnedExpressListing.

Returns:
Boolean

getReturnedFees

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

Returns:
FeesType

getReturnedItemID

public java.lang.String getReturnedItemID()
Valid after executing the API. Gets the returned VerifyAddItemResponseType.returnedItemID.

Returns:
String

getReturnedListingRecommendations

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

Returns:
ListingRecommendationsType

getReturnedProductSuggestions

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

Returns:
ProductSuggestionsType

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.