Changes since
the last release

com.ebay.sdk.call
Class AddItemFromSellingManagerTemplateCall

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

public class AddItemFromSellingManagerTemplateCall
extends ApiCall

Wrapper class of the AddItemFromSellingManagerTemplate 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 that a seller is using to create a listing. Unique identifiers of Selling Manager templates can be retrieved programatically by using the GetSellingManagerInventory call.
Input property: ScheduleTime - This field allows the user to specify a time in the future when the listing being created becomes active. If this field is not used, the listing will become active immediately upon being created successfully. The time in this field should be specified in GMT format.
Input property: Item - This container is intended for specifying setting in the listing that differ from values in the Selling Manager template being used.

Note: Only the following three values of ItemType may be used for a AddItemFromSellingManagerTemplate call: CategoryMappingAllowed, PaymentMethods, and PayPalEmailAddress.
Output property: ReturnedItemID - Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
Output property: ReturnedStartTime - Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the ScheduleTime field in the request and set a custom start time of the listing (in the future).
Output property: ReturnedEndTime - Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time. If the value of ListingDuration was set to GTC (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time. Note that GTC is not an option with auction listings.

Note: As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been 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: ReturnedFees - This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
Output property: ReturnedCategoryID - The unique identifier of the primary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is set to true in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.

Note: The Item.CategoryMappingAllowed field value in the request now defaults to true if omitted. Previously, the default value was false, so a user had to include this field and set it to true in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.
Output property: ReturnedCategory2ID - Unique identifier of the secondary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is set to true in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.

Note: The Item.CategoryMappingAllowed field value in the request now defaults to true if omitted. Previously, the default value was false, so a user had to include this field and set it to true in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddItemFromSellingManagerTemplateCall()
          Constructor.
AddItemFromSellingManagerTemplateCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String addItemFromSellingManagerTemplate()
          This is the base request type of the AddItemFromSellingManagerTemplate call, which is used to create listings based on settings contained in a Selling Manager template.
 ItemType getItem()
          Gets the AddItemFromSellingManagerTemplateRequestType.item.
 java.lang.String getReturnedCategory2ID()
          Valid after executing the API.
 java.lang.String getReturnedCategoryID()
          Valid after executing the API.
 java.util.Calendar getReturnedEndTime()
          Valid after executing the API.
 FeesType getReturnedFees()
          Valid after executing the API.
 java.lang.String getReturnedItemID()
          Valid after executing the API.
 java.util.Calendar getReturnedStartTime()
          Valid after executing the API.
 java.lang.Long getSaleTemplateID()
          Gets the AddItemFromSellingManagerTemplateRequestType.saleTemplateID.
 java.util.Calendar getScheduleTime()
          Gets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.
 void setItem(ItemType item)
          Sets the AddItemFromSellingManagerTemplateRequestType.item.
 void setSaleTemplateID(java.lang.Long saleTemplateID)
          Sets the AddItemFromSellingManagerTemplateRequestType.saleTemplateID.
 void setScheduleTime(java.util.Calendar scheduleTime)
          Sets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.
 
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

AddItemFromSellingManagerTemplateCall

public AddItemFromSellingManagerTemplateCall()
Constructor.


AddItemFromSellingManagerTemplateCall

public AddItemFromSellingManagerTemplateCall(ApiContext apiContext)
Constructor.

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

addItemFromSellingManagerTemplate

public java.lang.String addItemFromSellingManagerTemplate()
                                                   throws ApiException,
                                                          SdkException,
                                                          java.lang.Exception
This is the base request type of the AddItemFromSellingManagerTemplate call, which is used to create listings based on settings contained in a Selling Manager template.

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

getItem

public ItemType getItem()
Gets the AddItemFromSellingManagerTemplateRequestType.item.

Returns:
ItemType

setItem

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

Parameters:
item - ItemType

getSaleTemplateID

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

Returns:
Long

setSaleTemplateID

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

Parameters:
saleTemplateID - Long

getScheduleTime

public java.util.Calendar getScheduleTime()
Gets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.

Returns:
Calendar

setScheduleTime

public void setScheduleTime(java.util.Calendar scheduleTime)
Sets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.

Parameters:
scheduleTime - Calendar

getReturnedCategory2ID

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

Returns:
String

getReturnedCategoryID

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

Returns:
String

getReturnedEndTime

public java.util.Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedEndTime.

Returns:
Calendar

getReturnedFees

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

Returns:
FeesType

getReturnedItemID

public java.lang.String getReturnedItemID()
Valid after executing the API. Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedItemID.

Returns:
String

getReturnedStartTime

public java.util.Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedStartTime.

Returns:
Calendar

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.