Changes since
the last release

com.ebay.sdk.call
Class ReviseSellingManagerTemplateCall

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

public class ReviseSellingManagerTemplateCall
extends ApiCall

Wrapper class of the ReviseSellingManagerTemplate 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: SaleTemplateID - The unique identifier of the Selling Manager template. You can obtain a SaleTemplateID value by calling GetSellingManagerInventory.
Input property: ProductID - Reserved for future use.
Input property: SaleTemplateName - The name of the Selling Manager template.
Input property: Item - This container is used to modify the Selling Manager template. In the Item.ItemID field, you specify the same value as the one specified in SaleTemplateID. Other child elements hold the values for properties that are 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 remove from a template. See the eBay Web Services guide for rules on removing 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 removed). DeletedField accepts the following path names, which remove the corresponding fields:

Item.ApplicationData
Item.AttributeSetArray
Item.ConditionID
Item.ItemSpecifics
Item.ListingCheckoutRedirectPreference.ProStoresStoreName
Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername
Item.ListingDesigner.LayoutID
Item.ListingDesigner.ThemeID
Item.ListingEnhancement[Value]
Item.PayPalEmailAddress
Item.PictureDetails.GalleryURL
Item.PictureDetails.PictureURL
Item.PostalCode
Item.ProductListingDetails
item.ShippingDetails.PaymentInstructions
item.SKU
Item.SubTitle

These values are case-sensitive. 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 (e.g., item.picturedetails.galleryUrl is not allowed).

Depending on how you have configured your pictures, you cannot necessarily delete both GalleryURL and PictureURL from an existing listing. If GalleryType was already set for the item you are revising, you cannot remove it. This means you still need to include either a first picture or a gallery URL in your revised listing.
Input property: VerifyOnly - Use this field to verify the template instead of revising it.
Output property: ReturnedSaleTemplateID - This sale template ID uniquely identifies the template that was revised in the request. This sale template ID should match the template ID specified in the request. specified for the call.
Output property: ReturnedFees - 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 - Instead of revising, only verifies the template.
Output property: ReturnedSaleTemplateName - The name of the sale template.
Output property: ReturnedSellingManagerProductDetails - The details of the product that this template belongs to.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ReviseSellingManagerTemplateCall()
          Constructor.
ReviseSellingManagerTemplateCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String[] getDeletedField()
          Gets the ReviseSellingManagerTemplateRequestType.deletedField.
 ItemType getItem()
          Gets the ReviseSellingManagerTemplateRequestType.item.
 java.lang.Long getProductID()
          Gets the ReviseSellingManagerTemplateRequestType.productID.
 java.lang.String getReturnedCategory2ID()
          Valid after executing the API.
 java.lang.String getReturnedCategoryID()
          Valid after executing the API.
 FeesType getReturnedFees()
          Valid after executing the API.
 java.lang.Long getReturnedSaleTemplateID()
          Valid after executing the API.
 java.lang.String getReturnedSaleTemplateName()
          Valid after executing the API.
 SellingManagerProductDetailsType getReturnedSellingManagerProductDetails()
          Valid after executing the API.
 java.lang.Boolean getReturnedVerifyOnly()
          Valid after executing the API.
 java.lang.Long getSaleTemplateID()
          Gets the ReviseSellingManagerTemplateRequestType.saleTemplateID.
 java.lang.String getSaleTemplateName()
          Gets the ReviseSellingManagerTemplateRequestType.saleTemplateName.
 java.lang.Boolean getVerifyOnly()
          Gets the ReviseSellingManagerTemplateRequestType.verifyOnly.
 java.lang.Long reviseSellingManagerTemplate()
          Revises a Selling Manager template.
 void setDeletedField(java.lang.String[] deletedField)
          Sets the ReviseSellingManagerTemplateRequestType.deletedField.
 void setItem(ItemType item)
          Sets the ReviseSellingManagerTemplateRequestType.item.
 void setProductID(java.lang.Long productID)
          Sets the ReviseSellingManagerTemplateRequestType.productID.
 void setSaleTemplateID(java.lang.Long saleTemplateID)
          Sets the ReviseSellingManagerTemplateRequestType.saleTemplateID.
 void setSaleTemplateName(java.lang.String saleTemplateName)
          Sets the ReviseSellingManagerTemplateRequestType.saleTemplateName.
 void setVerifyOnly(java.lang.Boolean verifyOnly)
          Sets the ReviseSellingManagerTemplateRequestType.verifyOnly.
 
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

ReviseSellingManagerTemplateCall

public ReviseSellingManagerTemplateCall()
Constructor.


ReviseSellingManagerTemplateCall

public ReviseSellingManagerTemplateCall(ApiContext apiContext)
Constructor.

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

reviseSellingManagerTemplate

public java.lang.Long reviseSellingManagerTemplate()
                                            throws ApiException,
                                                   SdkException,
                                                   java.lang.Exception
Revises a Selling Manager template. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.

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

getDeletedField

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

Returns:
String[]

setDeletedField

public void setDeletedField(java.lang.String[] deletedField)
Sets the ReviseSellingManagerTemplateRequestType.deletedField.

Parameters:
deletedField - String[]

getItem

public ItemType getItem()
Gets the ReviseSellingManagerTemplateRequestType.item.

Returns:
ItemType

setItem

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

Parameters:
item - ItemType

getProductID

public java.lang.Long getProductID()
Gets the ReviseSellingManagerTemplateRequestType.productID.

Returns:
Long

setProductID

public void setProductID(java.lang.Long productID)
Sets the ReviseSellingManagerTemplateRequestType.productID.

Parameters:
productID - Long

getSaleTemplateID

public java.lang.Long getSaleTemplateID()
Gets the ReviseSellingManagerTemplateRequestType.saleTemplateID.

Returns:
Long

setSaleTemplateID

public void setSaleTemplateID(java.lang.Long saleTemplateID)
Sets the ReviseSellingManagerTemplateRequestType.saleTemplateID.

Parameters:
saleTemplateID - Long

getSaleTemplateName

public java.lang.String getSaleTemplateName()
Gets the ReviseSellingManagerTemplateRequestType.saleTemplateName.

Returns:
String

setSaleTemplateName

public void setSaleTemplateName(java.lang.String saleTemplateName)
Sets the ReviseSellingManagerTemplateRequestType.saleTemplateName.

Parameters:
saleTemplateName - String

getVerifyOnly

public java.lang.Boolean getVerifyOnly()
Gets the ReviseSellingManagerTemplateRequestType.verifyOnly.

Returns:
Boolean

setVerifyOnly

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

Parameters:
verifyOnly - Boolean

getReturnedCategory2ID

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

Returns:
String

getReturnedCategoryID

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

Returns:
String

getReturnedFees

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

Returns:
FeesType

getReturnedSaleTemplateID

public java.lang.Long getReturnedSaleTemplateID()
Valid after executing the API. Gets the returned ReviseSellingManagerTemplateResponseType.returnedSaleTemplateID.

Returns:
Long

getReturnedSaleTemplateName

public java.lang.String getReturnedSaleTemplateName()
Valid after executing the API. Gets the returned ReviseSellingManagerTemplateResponseType.returnedSaleTemplateName.

Returns:
String

getReturnedSellingManagerProductDetails

public SellingManagerProductDetailsType getReturnedSellingManagerProductDetails()
Valid after executing the API. Gets the returned ReviseSellingManagerTemplateResponseType.returnedSellingManagerProductDetails.

Returns:
SellingManagerProductDetailsType

getReturnedVerifyOnly

public java.lang.Boolean getReturnedVerifyOnly()
Valid after executing the API. Gets the returned ReviseSellingManagerTemplateResponseType.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.