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 - The Item container is used to make changes to the active listing. The seller must pass in the ItemID value for the listing that is being revised. For anything else that the seller wishes to change, such as quantity or price, 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 a field to delete from a listing. The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). See the relevant field descriptions to determine when to use DeletedField (and potential consequences).

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 if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them.

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 is included and set as true, the active listing is not actually revised, but the same response is returned and the seller gets to see the expected fees based on the changes made, and can also view any listing recommendations if the Item.IncludeRecommedations boolean field is included and set to true.
Output property: ReturnedItemID - The unique identifier for the revised listing. Note that the ItemID value does not change when a listing is revised, so this will be the same ItemID value that was passed in the call request.


Output property: ReturnedStartTime - This timestamp indicates the date and time when the listing was created on the eBay site. This value doesn't change when a listing is revised.
Output property: ReturnedEndTime - Date and time when the revised listing is scheduled to end based on the listing's start time and the listing duration value that was set for the listing. If the listing duration is 'GTC' (Good 'Til Cancelled), this value will be updated to 30 days in the future if the listing is automatically renewed after 30 days. GTC listings are automatically renewed if quantity still exists for the item. Note that GTC is not applicable to auction listings.

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: ListingFees - This container consists of the estimated listing fees for the revised listing. 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: ReturnedCategoryID - Unique identifier of the primary eBay category for the revised listing. This field is returned if the primary category was changed with the revision, and the primary category can only be changed if a fixed-price listing has no sales/auction listing has no bids, and the listing does not end within 12 hours.

This field can also be 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 for the revised listing. This field is returned if the secondary category was changed with the revision, and the secondary category can only be changed if a fixed-price listing has no sales/auction listing has no bids, and the listing does not end within 12 hours.

This field can also be 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: ReturnedVerifyOnly - This field is returned if the VerifyOnly field was included in the call request and set to true.

If the listing was revised in 'Verify Only' mode, the active listing is not actually revised, but the same response is returned and the seller gets to see the expected fees based on the changes made, and can also view any listing recommendations if the Item.IncludeRecommedations boolean input field was included and set to true.
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 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
 java.lang.String[] getDeletedField()
          Gets the ReviseItemRequestType.deletedField.
 ItemType getItemToBeRevised()
          Gets the ReviseItemRequestType.itemToBeRevised.
 TimeFilter getListingDuration()
           
 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.
 java.lang.Boolean getReturnedVerifyOnly()
          Valid after executing the API.
 java.lang.Boolean getVerifyOnly()
          Gets the ReviseItemRequestType.verifyOnly.
 FeesType reviseItem()
          Enables a seller to revise a listing on a specified eBay site.
 void setDeletedField(java.lang.String[] deletedField)
          Sets the ReviseItemRequestType.deletedField.
 void setItemToBeRevised(ItemType itemToBeRevised)
          Sets the ReviseItemRequestType.itemToBeRevised.
 void setVerifyOnly(java.lang.Boolean verifyOnly)
          Sets the ReviseItemRequestType.verifyOnly.
 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

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,
                           java.lang.Exception
Enables a seller to revise a listing on a specified eBay site. To revise an active listing, the seller specifies the ItemID value for the listing. The seller makes one or multiple 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.

After a multiple-quantity, fixed-price listing has one or more sales, or less than 12 hours remain before the listing is scheduled to end, you can not edit the values in the Listing Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields for that listing. The same applies to an auction listing that has at least one bid.

To revise a multiple-variation, fixed-price listing, the ReviseFixedPriceItem call should be used instead, as the ReviseItem call does not support variation-level edits.

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

getDeletedField

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

Returns:
String[]

setDeletedField

public void setDeletedField(java.lang.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 java.lang.Boolean getVerifyOnly()
Gets the ReviseItemRequestType.verifyOnly.

Returns:
Boolean

setVerifyOnly

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

Parameters:
verifyOnly - Boolean

getListingDuration

public TimeFilter getListingDuration()
Returns:
the listing duration.

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

Returns:
FeesType

getReturnedCategory2ID

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

Returns:
String

getReturnedCategoryID

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

Returns:
Calendar

getReturnedItemID

public java.lang.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 java.util.Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned ReviseItemResponseType.returnedStartTime.

Returns:
Calendar

getReturnedVerifyOnly

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