Changes since
the last release

com.ebay.sdk.call
Class RelistItemCall

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

public class RelistItemCall
extends ApiCall

Wrapper class of the RelistItem 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: ItemToBeRelisted - Child elements hold the values for item properties that change for the item re-list. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the listing being re-listed (a listing that ended in the past 90 days). By default, the new listing's Item object properties are the same as those of the original (ended) listing. By setting a new value in the Item object, the new listing uses the new value rather than the corresponding value from the old listing.
Input property: DeletedField - Specifies the name of the field to delete from a listing. See Relisting Items for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted).

Case-sensitivity must be taken into account when using a DeletedField tag to delete a field. The value passed into a DeletedField tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL). Do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed.

To delete a listing enhancement like 'BoldTitle', specify the value you are deleting; for example, Item.ListingEnhancement[BoldTitle].
Output property: ReturnedItemID - Unique item ID for the new listing.
Output property: ListingFees - 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: ReturnedStartTime - Date and time the new listing became active on the eBay site.
Output property: ReturnedEndTime - Date and time when the new listing ends. This is the starting time plus the listing duration.
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 passed in Item.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 was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.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 applied.
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 RelistItem request, and if at least one listing recommendation exists for the newly relisted item. 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
RelistItemCall()
          Constructor.
RelistItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String[] getDeletedField()
          Gets the RelistItemRequestType.deletedField.
 ItemType getItemToBeRelisted()
          Gets the RelistItemRequestType.itemToBeRelisted.
 FeesType getListingFees()
          Valid after executing the API.
 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.
 String getReturnedItemID()
          Valid after executing the API.
 ListingRecommendationsType getReturnedListingRecommendations()
          Valid after executing the API.
 ProductSuggestionsType getReturnedProductSuggestions()
          Valid after executing the API.
 Calendar getReturnedStartTime()
          Valid after executing the API.
 FeesType relistItem()
          Enables a seller to relist a single listing that has ended on a specified eBay site.
 void setDeletedField(String[] deletedField)
          Sets the RelistItemRequestType.deletedField.
 void setItemToBeRelisted(ItemType itemToBeRelisted)
          Sets the RelistItemRequestType.itemToBeRelisted.
 void uploadPictures(PictureInfo[] pictureInfoArray, PictureDetailsType pictureDetails)
           
 void uploadPictures(String[] pictureFiles, PictureDetailsType pictureDetails)
           
 
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

RelistItemCall

public RelistItemCall()
Constructor.


RelistItemCall

public RelistItemCall(ApiContext apiContext)
Constructor.

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

relistItem

public FeesType relistItem()
                    throws ApiException,
                           SdkException,
                           Exception
Enables a seller to relist a single listing that has ended on a specified eBay site. If the item was being watched when the listing ended, it will continue to be watched when the item is relisted.

Returns:
The FeesType object.
Throws:
ApiException
SdkException
Exception

getDeletedField

public String[] getDeletedField()
Gets the RelistItemRequestType.deletedField.

Returns:
String[]

setDeletedField

public void setDeletedField(String[] deletedField)
Sets the RelistItemRequestType.deletedField.

Parameters:
deletedField - String[]

getItemToBeRelisted

public ItemType getItemToBeRelisted()
Gets the RelistItemRequestType.itemToBeRelisted.

Returns:
ItemType

setItemToBeRelisted

public void setItemToBeRelisted(ItemType itemToBeRelisted)
Sets the RelistItemRequestType.itemToBeRelisted.

Parameters:
itemToBeRelisted - ItemType

uploadPictures

public void uploadPictures(String[] pictureFiles,
                           PictureDetailsType pictureDetails)
                    throws SdkException
Throws:
SdkException

uploadPictures

public void uploadPictures(PictureInfo[] pictureInfoArray,
                           PictureDetailsType pictureDetails)
                    throws SdkException
Throws:
SdkException

getListingFees

public FeesType getListingFees()
Valid after executing the API. Gets the returned RelistItemResponseType.listingFees.

Returns:
FeesType

getReturnedCategory2ID

public String getReturnedCategory2ID()
Valid after executing the API. Gets the returned RelistItemResponseType.returnedCategory2ID.

Returns:
String

getReturnedCategoryID

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

Returns:
String

getReturnedDiscountReason

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

Returns:
DiscountReasonCodeType[]

getReturnedEndTime

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

Returns:
Calendar

getReturnedItemID

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

Returns:
String

getReturnedListingRecommendations

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

Returns:
ListingRecommendationsType

getReturnedProductSuggestions

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

Returns:
ProductSuggestionsType

getReturnedStartTime

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