com.ebay.sdk.call.VerifyAddFixedPriceItemCall 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.Boolean;
import java.lang.String;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the VerifyAddFixedPriceItem 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 - Root container holding all values that define a new
* fixed-price listing.
*
Output property: ReturnedItemID - Represents the item ID for the new fixed-price listing. VerifyAddFixedPriceItem does not
* actually list an item, so 0 is returned instead of a normal item ID.
*
Output property: ReturnedSKU - Item-level SKU for the new listing, if the seller specified
* tem.SKU in the request. Variation SKUs are not returned
* (see GetItem instead).
*
Output property: ReturnedFees - Child elements contain the estimated listing fees for the new item listing.
* The fees do not include the Final Value Fee (FVF), which cannot be determined
* until an item is sold.
*
Output property: ReturnedExpressListing - This field is deprecated.
*
Output property: ReturnedExpressItemRequirements - This field is deprecated.
*
Output property: ReturnedCategoryID - ID of the primary category in which the item would be listed.
* Only returned if you set Item.CategoryMappingAllowed to true in the request
* and the ID you passed in 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 would be listed.
* Only returned if you set Item.CategoryMappingAllowed to true in the request
* and the ID you passed in 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: ReturnedDiscountReason - The nature of the discount, if a discount would have applied
* had this actually been listed at this time.
*
Output property: ReturnedListingRecommendations - Container consisting of one or more Recommendation containers. Each Recommendation container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
*
* This container is only returned if the IncludeRecommendations flag was included and set to 'true' in the VerifyAddFixedPriceItem request, and if at least one listing recommendation exists for the listing about to be listed. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the listing based on eBay's listing recommendation(s) before actually creating the listing through an AddFixedPriceItem call.
*
* @author Ron Murphy
* @version 1.0
*/
public class VerifyAddFixedPriceItemCall extends com.ebay.sdk.ApiCall
{
private ItemType item = null;
private String returnedItemID=null;
private String returnedSKU=null;
private FeesType returnedFees=null;
private Boolean returnedExpressListing=null;
private ExpressItemRequirementsType returnedExpressItemRequirements=null;
private String returnedCategoryID=null;
private String returnedCategory2ID=null;
private DiscountReasonCodeType[] returnedDiscountReason=null;
private ListingRecommendationsType returnedListingRecommendations=null;
private final String IMG_URL_FORMAT = "http://i0.ebayimg.ebay.com/i0/00/";
private final String JPG_EXT = ".jpg";
private String[] pictureFiles = null;
/**
* Constructor.
*/
public VerifyAddFixedPriceItemCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public VerifyAddFixedPriceItemCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Enables a seller to test the definition of a new fixed-price listing by
* submitting the definition to eBay without creating an actual listing.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The FeesType object.
*/
public FeesType verifyAddFixedPriceItem()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
VerifyAddFixedPriceItemRequestType req;
req = new VerifyAddFixedPriceItemRequestType();
if( this.pictureFiles != null )
{
if( item.getPictureDetails() == null )
{
PictureDetailsType pictureDetails = new PictureDetailsType();
pictureDetails.setPhotoDisplay(PhotoDisplayCodeType.NONE);
item.setPictureDetails(pictureDetails);
}
// Save urls back to item object.
String[] uris = new String[pictureFiles.length];
for(int i = 0; i < pictureFiles.length; i ++) {
uris[i] = IMG_URL_FORMAT + (new Integer(i)).toString() + JPG_EXT;
}
item.getPictureDetails().setPictureURL(uris);
}
if (this.item != null)
req.setItem(this.item);
VerifyAddFixedPriceItemResponseType resp = (VerifyAddFixedPriceItemResponseType) execute(req);
this.returnedItemID = resp.getItemID();
this.returnedSKU = resp.getSKU();
this.returnedFees = resp.getFees();
this.returnedExpressListing = resp.isExpressListing();
this.returnedExpressItemRequirements = resp.getExpressItemRequirements();
this.returnedCategoryID = resp.getCategoryID();
this.returnedCategory2ID = resp.getCategory2ID();
this.returnedDiscountReason = resp.getDiscountReason();
this.returnedListingRecommendations = resp.getListingRecommendations();
return this.getReturnedFees();
}
/**
* Gets the VerifyAddFixedPriceItemRequestType.item.
* @return ItemType
*/
public ItemType getItem()
{
return this.item;
}
/**
* Sets the VerifyAddFixedPriceItemRequestType.item.
* @param item ItemType
*/
public void setItem(ItemType item)
{
this.item = item;
}
/**
* Gets list of picture files for the item.
* @return String[]
*/
public String[] getPictureFiles() {
return this.pictureFiles;
}
/**
* Sets list of picture files for the item. Before listing
* the item, the attached picture service object (setPictureService())
* to upload these picture files then set the picture property of the
* item object.
* @param pictureFiles String[]
*/
public void setPictureFiles(String[] pictureFiles) {
this.pictureFiles = pictureFiles;
}
/**
* Executes the API call. The picture files that you provided will not be
* uploaded and some dummy urls will be used instead.
* @param item ItemType
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return FeesType The estimated fees information.
*/
public FeesType verifyAddFixedPriceItem(ItemType item)
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
VerifyAddFixedPriceItemRequestType request = new VerifyAddFixedPriceItemRequestType();
request.setItem(item);
if( this.pictureFiles != null )
{
if( item.getPictureDetails() == null )
{
PictureDetailsType pictureDetails = new PictureDetailsType();
pictureDetails.setPhotoDisplay(PhotoDisplayCodeType.NONE);
item.setPictureDetails(pictureDetails);
}
// Save urls back to item object.
String[] uris = new String[pictureFiles.length];
for(int i = 0; i < pictureFiles.length; i ++) {
uris[i] = IMG_URL_FORMAT + (new Integer(i)).toString() + JPG_EXT;
}
item.getPictureDetails().setPictureURL(uris);
}
VerifyAddFixedPriceItemResponseType resp = (VerifyAddFixedPriceItemResponseType)execute(request);
return resp.getFees();
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedCategory2ID.
*
* @return String
*/
public String getReturnedCategory2ID()
{
return this.returnedCategory2ID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedCategoryID.
*
* @return String
*/
public String getReturnedCategoryID()
{
return this.returnedCategoryID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedDiscountReason.
*
* @return DiscountReasonCodeType[]
*/
public DiscountReasonCodeType[] getReturnedDiscountReason()
{
return this.returnedDiscountReason;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedExpressItemRequirements.
*
* @return ExpressItemRequirementsType
*/
public ExpressItemRequirementsType getReturnedExpressItemRequirements()
{
return this.returnedExpressItemRequirements;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedExpressListing.
*
* @return Boolean
*/
public Boolean getReturnedExpressListing()
{
return this.returnedExpressListing;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedFees.
*
* @return FeesType
*/
public FeesType getReturnedFees()
{
return this.returnedFees;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedItemID.
*
* @return String
*/
public String getReturnedItemID()
{
return this.returnedItemID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedListingRecommendations.
*
* @return ListingRecommendationsType
*/
public ListingRecommendationsType getReturnedListingRecommendations()
{
return this.returnedListingRecommendations;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddFixedPriceItemResponseType.returnedSKU.
*
* @return String
*/
public String getReturnedSKU()
{
return this.returnedSKU;
}
}