Changes since
the last release

com.ebay.sdk.call
Class ReviseItemCall

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

public class ReviseItemCall
extends ApiCall

Wrapper class of the ReviseItem 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: ItemToBeRevised - Child elements hold the values for properties that are changing. The Item.ItemID property must always be set to the ID of the item listing being changed. Set values in the Item object only for those properties that are changing. Use DeletedField to remove a property.
Input property: DeletedField - Specifies the name of a field to delete from a listing. See the eBay Features Guide for rules on deleting values when revising 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).

You cannot delete required fields from a listing.

Some fields are optional when you first list an item (e.g., SecondaryCategory), but once they are set they cannot be deleted when you revise an item. Some optional fields cannot be deleted from auction listings if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them.

Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data. See the eBay Features Guide for rules on removing values when revising items. Also see the relevant field descriptions for details on when to use DeletedField (and potential consequences).

Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, 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 in square brackets ("[ ]"); for example, Item.ListingEnhancement[BoldTitle].
Input property: VerifyOnly - When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is similar to VerifyAddItem in revise mode.
Output property: ReturnedItemID - Item ID that uniquely identifies the item listing that was revised. Provided for confirmation purposes. The value returned should be the same as the item ID specified in the ItemID property of the Item object specified as input for the call.
Output property: ReturnedStartTime - Starting date and time for the revised listing.
Output property: ReturnedEndTime - Date and time when the new listing ends. This is the starting time plus the listing duration.
Output property: ListingFees - Child elements contain the estimated listing fees for the revised item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Revising an item does not itself incur a fee. However, certain item properties are fee-based and result in the return of fees in the call's response.
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: ReturnedVerifyOnly - Supporting VerifyOnly for ReviseItem call as part of project 24083 (API - Critical enhancements). When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is simialr to VerifyAddItem in revise mode.
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 ReviseItem request, and if at least one listing recommendation exists for the listing about to be revised. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item again 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
ReviseItemCall()
          Constructor.
ReviseItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String[] getDeletedField()
          Gets the ReviseItemRequestType.deletedField.
 ItemType getItemToBeRevised()
          Gets the ReviseItemRequestType.itemToBeRevised.
 TimeFilter getListingDuration()
           
 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.
 Boolean getReturnedVerifyOnly()
          Valid after executing the API.
 Boolean getVerifyOnly()
          Gets the ReviseItemRequestType.verifyOnly.
 FeesType reviseItem()
          Enables a seller to change the properties of a currently active listing.
 void setDeletedField(String[] deletedField)
          Sets the ReviseItemRequestType.deletedField.
 void setItemToBeRevised(ItemType itemToBeRevised)
          Sets the ReviseItemRequestType.itemToBeRevised.
 void setVerifyOnly(Boolean verifyOnly)
          Sets the ReviseItemRequestType.verifyOnly.
 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

ReviseItemCall

public ReviseItemCall()
Constructor.


ReviseItemCall

public ReviseItemCall(ApiContext apiContext)
Constructor.

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

reviseItem

public FeesType reviseItem()
                    throws ApiException,
                           SdkException,
                           Exception
Enables a seller to change the properties of a currently active listing.

After one item in a multi-quantity fixed-price listing has been sold, you can not the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields for that listing. However, all other fields in the multi-quantity, fixed-price listing are editable.

Inputs are the Item ID of the listing you are revising, and the field or fields that you are updating.

Returns:
The FeesType object.
Throws:
ApiException
SdkException
Exception

getDeletedField

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

Returns:
String[]

setDeletedField

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

Parameters:
deletedField - String[]

getItemToBeRevised

public ItemType getItemToBeRevised()
Gets the ReviseItemRequestType.itemToBeRevised.

Returns:
ItemType

setItemToBeRevised

public void setItemToBeRevised(ItemType itemToBeRevised)
Sets the ReviseItemRequestType.itemToBeRevised.

Parameters:
itemToBeRevised - ItemType

getVerifyOnly

public Boolean getVerifyOnly()
Gets the ReviseItemRequestType.verifyOnly.

Returns:
Boolean

setVerifyOnly

public void setVerifyOnly(Boolean verifyOnly)
Sets the ReviseItemRequestType.verifyOnly.

Parameters:
verifyOnly - Boolean

getListingDuration

public TimeFilter getListingDuration()
Returns:
the listing duration.

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 ReviseItemResponseType.listingFees.

Returns:
FeesType

getReturnedCategory2ID

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

Returns:
String

getReturnedCategoryID

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

Returns:
String

getReturnedDiscountReason

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

Returns:
DiscountReasonCodeType[]

getReturnedEndTime

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

Returns:
Calendar

getReturnedItemID

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

Returns:
String

getReturnedListingRecommendations

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

Returns:
ListingRecommendationsType

getReturnedProductSuggestions

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

Returns:
ProductSuggestionsType

getReturnedStartTime

public Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned ReviseItemResponseType.returnedStartTime.

Returns:
Calendar

getReturnedVerifyOnly

public Boolean getReturnedVerifyOnly()
Valid after executing the API. Gets the returned ReviseItemResponseType.returnedVerifyOnly.

Returns:
Boolean

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.