Changes since
the last release

com.ebay.sdk.call
Class AddSellingManagerTemplateCall

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

public class AddSellingManagerTemplateCall
extends ApiCall

Wrapper class of the AddSellingManagerTemplate 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: Item - This Item container is similar to the one that is used in standard Add/Revise/Relist/Verify Item calls, with the difference being that some of the product-specific data/settings will be inherited through the Selling Manager product that is referenced in the call request, and not through this Item container. The data that is passed in this container will become part of the listing template that is created with this call.
Input property: SaleTemplateName - The name of the Selling Manager listing template is provided in this field. If you don't specify a name, then the value in the Item.Title field will be used as the name instead.
Input property: ProductID - The unique identifier of the Selling Manager product that will be associated with the listing template being created. Selling Manager Product IDs are returned in the response of a AddSellingManagerProduct call. Alternatively, the GetSellingManagerInventory call can be used to retrieve active Selling Manager products for the user's account.
Output property: ReturnedCategoryID - The unique identifier of the eBay category in which the product associated with the Selling Manager template will be listed. The primary listing category is provided through the PrimaryCategoryID field of an AddSellingManagerProduct call or through the Item.PrimaryCategory.CategoryID field.
Output property: ReturnedCategory2ID - The unique identifier of the secondary eBay category in which the product associated with the Selling Manager template will be listed. This field will only be returned if defined through a Item.SecondaryCategory.CategoryID field.
Output property: ReturnedSaleTemplateID - This is the unique identifier of the new Selling Manager template. This value is created by eBay upon successful creation of the Selling Manager template.
Output property: ReturnedSaleTemplateGroupID - Ihis field is deprecated.
Output property: ReturnedSaleTemplateName - This is the unique name of the newly created Selling Manager template. This name will be the value that was provided in the SaleTemplateName field of the call request. If the SaleTemplateName field was omitted the Selling Manager template inherits the name specified in the Item.Title field instead.
Output property: ReturnedSellingManagerProductDetails - This container consists of details related to the Selling Manager product associated with the Selling Manager template, including the unique identifer, product name, and current quantity available.
Output property: ReturnedFees - This container consists of listing fees that can be expected to be assessed against an eBay listing created with Selling Manager template. Each Fee container will contain the name of the listing fee, the expected amount, and any eBay promotional discount that will be applied towards the expected fee. The Final Value Fee (FVF) will never be returned in this container, as this fee cannot be determined until an item is sold.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddSellingManagerTemplateCall()
          Constructor.
AddSellingManagerTemplateCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 Long addSellingManagerTemplate()
          The base request for the AddSellingManagerTemplate call, which is used to create a Selling Manager listing template.
 ItemType getItem()
          Gets the AddSellingManagerTemplateRequestType.item.
 Long getProductID()
          Gets the AddSellingManagerTemplateRequestType.productID.
 Long getReturnedCategory2ID()
          Valid after executing the API.
 Long getReturnedCategoryID()
          Valid after executing the API.
 FeesType getReturnedFees()
          Valid after executing the API.
 Long getReturnedSaleTemplateGroupID()
          Valid after executing the API.
 Long getReturnedSaleTemplateID()
          Valid after executing the API.
 String getReturnedSaleTemplateName()
          Valid after executing the API.
 SellingManagerProductDetailsType getReturnedSellingManagerProductDetails()
          Valid after executing the API.
 String getSaleTemplateName()
          Gets the AddSellingManagerTemplateRequestType.saleTemplateName.
 void setItem(ItemType item)
          Sets the AddSellingManagerTemplateRequestType.item.
 void setProductID(Long productID)
          Sets the AddSellingManagerTemplateRequestType.productID.
 void setSaleTemplateName(String saleTemplateName)
          Sets the AddSellingManagerTemplateRequestType.saleTemplateName.
 
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

AddSellingManagerTemplateCall

public AddSellingManagerTemplateCall()
Constructor.


AddSellingManagerTemplateCall

public AddSellingManagerTemplateCall(ApiContext apiContext)
Constructor.

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

addSellingManagerTemplate

public Long addSellingManagerTemplate()
                               throws ApiException,
                                      SdkException,
                                      Exception
The base request for the AddSellingManagerTemplate call, which is used to create a Selling Manager listing template. Each Selling Manager listing template must be associated with an existing Selling Manager product, and each product can have up to 20 listing templates associated with it.

Returns:
The Long object.
Throws:
ApiException
SdkException
Exception

getItem

public ItemType getItem()
Gets the AddSellingManagerTemplateRequestType.item.

Returns:
ItemType

setItem

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

Parameters:
item - ItemType

getProductID

public Long getProductID()
Gets the AddSellingManagerTemplateRequestType.productID.

Returns:
Long

setProductID

public void setProductID(Long productID)
Sets the AddSellingManagerTemplateRequestType.productID.

Parameters:
productID - Long

getSaleTemplateName

public String getSaleTemplateName()
Gets the AddSellingManagerTemplateRequestType.saleTemplateName.

Returns:
String

setSaleTemplateName

public void setSaleTemplateName(String saleTemplateName)
Sets the AddSellingManagerTemplateRequestType.saleTemplateName.

Parameters:
saleTemplateName - String

getReturnedCategory2ID

public Long getReturnedCategory2ID()
Valid after executing the API. Gets the returned AddSellingManagerTemplateResponseType.returnedCategory2ID.

Returns:
Long

getReturnedCategoryID

public Long getReturnedCategoryID()
Valid after executing the API. Gets the returned AddSellingManagerTemplateResponseType.returnedCategoryID.

Returns:
Long

getReturnedFees

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

Returns:
FeesType

getReturnedSaleTemplateGroupID

public Long getReturnedSaleTemplateGroupID()
Valid after executing the API. Gets the returned AddSellingManagerTemplateResponseType.returnedSaleTemplateGroupID.

Returns:
Long

getReturnedSaleTemplateID

public Long getReturnedSaleTemplateID()
Valid after executing the API. Gets the returned AddSellingManagerTemplateResponseType.returnedSaleTemplateID.

Returns:
Long

getReturnedSaleTemplateName

public String getReturnedSaleTemplateName()
Valid after executing the API. Gets the returned AddSellingManagerTemplateResponseType.returnedSaleTemplateName.

Returns:
String

getReturnedSellingManagerProductDetails

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

Returns:
SellingManagerProductDetailsType

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.