com.ebay.sdk.call
Class AddSellingManagerTemplateCall

java.lang.Object
  com.ebay.sdk.ApiCall
      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 - Contains the data in your template, i.e. the data needed to list an item. The item data you specify will be used when you list items from the template you are adding.
Input property: SaleTemplateName - The name you provide for the template. If you don't specify a name, then Item.Title is used as the name.
Input property: ProductID - The ID of the product with which the template will be associated. Before calling AddSellingManagerTemplate, you can obtain a product ID from the response of an AddSellingManagerProduct call. That is, after you add a product using AddSellingManagerProduct, a product ID is returned in the SellingManagerProductDetails.ProductID field. The GetSellingManagerTemplates call also returns product IDs. Alternatively, you can obtain information about a user's existing products, including the product IDs, by calling GetSellingManagerInventory.
Output property: ReturnedCategoryID - ID of the primary category in which the item would be listed.
Output property: ReturnedCategory2ID - ID of the secondary category (if any) in which the item would be listed.
Output property: ReturnedSaleTemplateID - The ID of the Selling Manager template. Store this value, for use in other Selling Manager calls.
Output property: ReturnedSaleTemplateGroupID - Ignore this value. For the output value that indicates the ID of the product associated with the template, use SellingManagerProductDetails.ProductID.
Output property: ReturnedSaleTemplateName - The name of the template, as it will appear in Selling Manager Pro. This name is the input value you provided in the SaleTemplateName field. If you didn't specify a value for SaleTemplateName, then Item.Title is used as the name.
Output property: ReturnedSellingManagerProductDetails - The details of the product with which the template is associated.
Output property: ReturnedFees - Child elements contain the estimated listing fees for the new listing template. Note that the fee will only be charged when an item is created from the template. The fees do not include the Final Value Fee (FVF), which 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() Adds a Selling Manager 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

Adds a Selling Manager template. One product can have up to 20 templates associated with it. This call is subject to change without notice; the deprecation process is inapplicable to this call.

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