com.ebay.sdk.call.VerifyAddItemCall 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 VerifyAddItem 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
* listing.
*
Output property: ReturnedItemID - Represents the item ID for the new listing. VerifyAddItem does not
* actually list an item, so 0 is returned instead of a normal item ID.
*
* Note:
* Although we represent item IDs as strings in the schema, we recommend you store
* them as 64-bit signed integers. If you choose to store item IDs as strings,
* allocate at least 19 characters (assuming decimal digits are used) to hold them.
* eBay will increase the size of IDs over time. Your code should be prepared to
* handle IDs of up to 19 digits. For more information about item IDs, see
*
* Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
*
*
Output property: ReturnedFees - Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.
There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions.
*
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: ReturnedProductSuggestions - Provides a list of products recommended by eBay which match the item information provided by the seller.
*
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 VerifyAddItem 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
* AddItem call.
*
* @author Ron Murphy
* @version 1.0
*/
public class VerifyAddItemCall extends com.ebay.sdk.ApiCall
{
private ItemType item = null;
private String returnedItemID=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 ProductSuggestionsType returnedProductSuggestions=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 VerifyAddItemCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public VerifyAddItemCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.
*
* Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the
* recoupment terms before adding or verifying items. This agreement allows eBay to reimburse
* a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and
* the agreement is located here.
* The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The FeesType object.
*/
public FeesType verifyAddItem()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
VerifyAddItemRequestType req;
req = new VerifyAddItemRequestType();
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);
VerifyAddItemResponseType resp = (VerifyAddItemResponseType) execute(req);
this.returnedItemID = resp.getItemID();
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.returnedProductSuggestions = resp.getProductSuggestions();
this.returnedListingRecommendations = resp.getListingRecommendations();
return this.getReturnedFees();
}
/**
* Gets the VerifyAddItemRequestType.item.
* @return ItemType
*/
public ItemType getItem()
{
return this.item;
}
/**
* Sets the VerifyAddItemRequestType.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 verifyAddItem(ItemType item)
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
VerifyAddItemRequestType request = new VerifyAddItemRequestType();
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);
}
VerifyAddItemResponseType resp = (VerifyAddItemResponseType)execute(request);
return resp.getFees();
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedCategory2ID.
*
* @return String
*/
public String getReturnedCategory2ID()
{
return this.returnedCategory2ID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedCategoryID.
*
* @return String
*/
public String getReturnedCategoryID()
{
return this.returnedCategoryID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedDiscountReason.
*
* @return DiscountReasonCodeType[]
*/
public DiscountReasonCodeType[] getReturnedDiscountReason()
{
return this.returnedDiscountReason;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedExpressItemRequirements.
*
* @return ExpressItemRequirementsType
*/
public ExpressItemRequirementsType getReturnedExpressItemRequirements()
{
return this.returnedExpressItemRequirements;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedExpressListing.
*
* @return Boolean
*/
public Boolean getReturnedExpressListing()
{
return this.returnedExpressListing;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedFees.
*
* @return FeesType
*/
public FeesType getReturnedFees()
{
return this.returnedFees;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedItemID.
*
* @return String
*/
public String getReturnedItemID()
{
return this.returnedItemID;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedListingRecommendations.
*
* @return ListingRecommendationsType
*/
public ListingRecommendationsType getReturnedListingRecommendations()
{
return this.returnedListingRecommendations;
}
/**
* Valid after executing the API.
* Gets the returned VerifyAddItemResponseType.returnedProductSuggestions.
*
* @return ProductSuggestionsType
*/
public ProductSuggestionsType getReturnedProductSuggestions()
{
return this.returnedProductSuggestions;
}
}