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 - The Item container is used to configure the item that will be relisted. If the seller plans to relist the item with no changes, the only field under the Item container that is required is the ItemID field. In the ItemID field, the seller specifies the item that will be relisted. If the seller wishes to change anything else for the listing, the seller should include this field in the call request and give it a new value.

If the seller wants to delete one or more optional settings in the listing, the seller should use the DeletedField tag.
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 - The unique identifier for the relisted item. Note that the ItemID value changes when a listing is relisted, so this will not be the same ItemID value that was passed in the call request.


Output property: ListingFees - This container consists of the estimated listing fees for the relisted item. Each type of fee is returned even if it is not appplicable (has a value of 0.0. The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made.
Output property: ReturnedStartTime - This timestamp indicates the date and time when the relisted item became active on the eBay site.
Output property: ReturnedEndTime - This timestamp indicates the date and time when the relisted item is scheduled to end on the eBay site. This date/time is calculated by using the StartTime and the the listing duration.

Note: Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the Good 'Til Cancelled listings update in the Spring 2019 Seller Updates for more information about this change.
Output property: ReturnedCategoryID - Unique identifier of the primary eBay category in which the item was relisted. This field is only returned if the Item.CategoryMappingAllowed field was included and set to true in the request and the category ID passed in the Item.PrimaryCategory field was mapped to a new category ID by eBay. If the primary category has not changed or it has expired with no replacement, this field is not returned.


Output property: ReturnedCategory2ID - Unique identifier of the secondary eBay category (if one was used) in which the item was relisted. This field is only returned if the Item.CategoryMappingAllowed field was included and set to true in the request and the category ID passed in the Item.SecondaryCategory field 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 field is returned if an eBay special offer or promotion is applicable to the listing.
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
 java.lang.String[] getDeletedField()
          Gets the RelistItemRequestType.deletedField.
 ItemType getItemToBeRelisted()
          Gets the RelistItemRequestType.itemToBeRelisted.
 FeesType getListingFees()
          Valid after executing the API.
 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.
 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.
 FeesType relistItem()
          Enables a seller to relist a listing that has recently ended on a specified eBay site.
 void setDeletedField(java.lang.String[] deletedField)
          Sets the RelistItemRequestType.deletedField.
 void setItemToBeRelisted(ItemType itemToBeRelisted)
          Sets the RelistItemRequestType.itemToBeRelisted.
 void uploadPictures(PictureInfo[] pictureInfoArray, PictureDetailsType pictureDetails)
           
 void uploadPictures(java.lang.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, 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

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,
                           java.lang.Exception
Enables a seller to relist a listing that has recently ended on a specified eBay site. A seller has to up to 90 days to relist an ended listing. When an item is relisted, it will receive a new ItemID value, but this item will remain on other users' Watch Lists after it is relisted. The seller has the opportunity to make changes to the listing through the Item container, and the seller can also use one or more DeletedField tags to remove an optional field/setting from the listing.

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

getDeletedField

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

Returns:
String[]

setDeletedField

public void setDeletedField(java.lang.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(java.lang.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 java.lang.String getReturnedCategory2ID()
Valid after executing the API. Gets the returned RelistItemResponseType.returnedCategory2ID.

Returns:
String

getReturnedCategoryID

public java.lang.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 java.util.Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned RelistItemResponseType.returnedEndTime.

Returns:
Calendar

getReturnedItemID

public java.lang.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 java.util.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.