com.ebay.sdk.call.AddItemFromSellingManagerTemplateCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Long;
import java.lang.String;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* 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 that was set at listing time.
*
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 seller enabled the Category Mapping feature for the listing, and the Category ID passed in as the primary listing category was mapped to a new Category ID by eBay. If the primary category has not changed, or if it has expired with no replacement, this field is not returned.
*
Output property: ReturnedCategory2ID - Unique identifier of the secondary category in which the item was listed. This field is only returned if a secondary category was used, the seller enabled the Category Mapping feature for the listing, and the Category ID passed in as the secondary listing category was mapped to a new Category ID by eBay. If the secondary category has not changed or it has expired with no replacement, this field is not returned.
*
* @author Ron Murphy
* @version 1.0
*/
public class AddItemFromSellingManagerTemplateCall extends com.ebay.sdk.ApiCall
{
private Long saleTemplateID = null;
private Calendar scheduleTime = null;
private ItemType item = null;
private String returnedItemID=null;
private Calendar returnedStartTime=null;
private Calendar returnedEndTime=null;
private FeesType returnedFees=null;
private String returnedCategoryID=null;
private String returnedCategory2ID=null;
/**
* Constructor.
*/
public AddItemFromSellingManagerTemplateCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public AddItemFromSellingManagerTemplateCall(ApiContext apiContext) {
super(apiContext);
}
/**
* 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.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The String object.
*/
public String addItemFromSellingManagerTemplate()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
AddItemFromSellingManagerTemplateRequestType req;
req = new AddItemFromSellingManagerTemplateRequestType();
if (this.saleTemplateID != null)
req.setSaleTemplateID(this.saleTemplateID);
if (this.scheduleTime != null)
req.setScheduleTime(this.scheduleTime);
if (this.item != null)
req.setItem(this.item);
AddItemFromSellingManagerTemplateResponseType resp = (AddItemFromSellingManagerTemplateResponseType) execute(req);
this.returnedItemID = resp.getItemID();
this.returnedStartTime = resp.getStartTime();
this.returnedEndTime = resp.getEndTime();
this.returnedFees = resp.getFees();
this.returnedCategoryID = resp.getCategoryID();
this.returnedCategory2ID = resp.getCategory2ID();
return this.getReturnedItemID();
}
/**
* Gets the AddItemFromSellingManagerTemplateRequestType.item.
* @return ItemType
*/
public ItemType getItem()
{
return this.item;
}
/**
* Sets the AddItemFromSellingManagerTemplateRequestType.item.
* @param item ItemType
*/
public void setItem(ItemType item)
{
this.item = item;
}
/**
* Gets the AddItemFromSellingManagerTemplateRequestType.saleTemplateID.
* @return Long
*/
public Long getSaleTemplateID()
{
return this.saleTemplateID;
}
/**
* Sets the AddItemFromSellingManagerTemplateRequestType.saleTemplateID.
* @param saleTemplateID Long
*/
public void setSaleTemplateID(Long saleTemplateID)
{
this.saleTemplateID = saleTemplateID;
}
/**
* Gets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.
* @return Calendar
*/
public Calendar getScheduleTime()
{
return this.scheduleTime;
}
/**
* Sets the AddItemFromSellingManagerTemplateRequestType.scheduleTime.
* @param scheduleTime Calendar
*/
public void setScheduleTime(Calendar scheduleTime)
{
this.scheduleTime = scheduleTime;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedCategory2ID.
*
* @return String
*/
public String getReturnedCategory2ID()
{
return this.returnedCategory2ID;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedCategoryID.
*
* @return String
*/
public String getReturnedCategoryID()
{
return this.returnedCategoryID;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedEndTime.
*
* @return Calendar
*/
public Calendar getReturnedEndTime()
{
return this.returnedEndTime;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedFees.
*
* @return FeesType
*/
public FeesType getReturnedFees()
{
return this.returnedFees;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedItemID.
*
* @return String
*/
public String getReturnedItemID()
{
return this.returnedItemID;
}
/**
* Valid after executing the API.
* Gets the returned AddItemFromSellingManagerTemplateResponseType.returnedStartTime.
*
* @return Calendar
*/
public Calendar getReturnedStartTime()
{
return this.returnedStartTime;
}
}