com.ebay.sdk.call.GeteBayDetailsCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
/*
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.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GeteBayDetails 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: DetailName - A designation of what kind of information you wish returned for the
* specified eBay site. If omitted, all details are returned. The
* possible values for input (the enumeration values of
* DetailNameCodeType) are the same name as fields returned by the
* response. See the documentation for the GeteBayDetails response to
* better understand the DetailName options.
*
Output property: ReturnedCountryDetails - Lists the country code and associated name of the countries supported by
* the eBay system, regardless of the site specified in the request.
*
Output property: ReturnedCurrencyDetails - Lists the currencies supported by the eBay system, regardless of the site
* specified in the request.
*
* Note:
* This container is only returned if CurrencyDetails is included as a
* DetailName filter in the request, or if no DetailName filters are
* used in the request.
*
*
Output property: ReturnedDispatchTimeMaxDetails - A dispatch time specifies the maximum number of business days a seller commits
* to for shipping an item to domestic buyers after receiving a cleared payment.
* Returns all dispatch times in the system, regardless of the site specified in
* the request.
*
* Note:
* This container is only returned if DispatchTimeMaxDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedPaymentOptionDetails - Deprecated
* Use GetCategoryFeatures instead, and pass in
* PaymentMethods as a FeatureID value in the request.
*
Output property: ReturnedRegionDetails - No longer returned; replaced by ShippingLocationDetails.
*
Output property: ReturnedShippingLocationDetails - Lists the regions and locations supported by eBay's shipping services. Returns
* all shipping locations supported by eBay, regardless of the site specified in
* the request.
*
* Note:
* This container is only returned if ShippingLocationDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedShippingServiceDetails - Lists the shipping services supported by the specified eBay site. Returns only
* the shipping services that are applicable to the site specified in the
* request.
*
* Note:
* This container is only returned if ShippingServiceDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedSiteDetails - Lists all available eBay sites and their associated SiteID numbers.
*
* Note:
* This container is only returned if SiteDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedTaxJurisdiction - Details the different tax jurisdictions or tax regions applicable to the
* site specified in the request.
*
* Note:
* This container is only returned if TaxJurisdiction is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedURLDetails - Lists eBay URLs that are applicable to the site specified in the request.\
*
* Note:
* This container is only returned if URLDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedTimeZoneDetails - Lists the details of the time zones supported by the eBay system.
*
* Note:
* This container is only returned if TimeZoneDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedItemSpecificDetails - The site's validation rules (e.g., string lengths) for custom Item Specifics.
*
* Note:
* This container is only returned if ItemSpecificDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedUnitOfMeasurementDetails - Units of measurement are no longer returned in GeteBayDetails, so this container is no longer applicable.
*
Output property: ReturnedRegionOfOriginDetails - No longer returned.
*
Output property: ReturnedShippingPackageDetails - Lists the various shipping packages supported by the specified site.
*
* Note:
* This container is only returned if ShippingPackageDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedShippingCarrierDetails - Lists the shipping carriers supported by the specified site.
*
* Note:
* This container is only returned if ShippingCarrierDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedReturnPolicyDetails - Lists the return policies supported by the eBay site specified in the request.
*
* Note:
* This container is only returned if ReturnPolicyDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedListingStartPriceDetails - Lists the minimum starting prices for the supported types of eBay listings.
*
* Note:
* This container is only returned if ListingStartPriceDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedBuyerRequirementDetails - Lists the threshold values that can be passed in throught the BuyerRequirementDetails container in the Add/Revise/Relist API calls. Buyer Requirements allow the seller to block buyers who have unpaid item defects, policy violations, low Feedback scores, and/or other undesirable qualities/statistics. Buyer Requirements are set at the seller's account level, but by using a BuyerRequirementDetails container in an Add/Revise/Relist API call, the values in that container will override values set at the account level.
*
* Note:
* This container is only returned if BuyerRequirementDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedListingFeatureDetails - Details the listing features available for the site specified in the request.
*
* Note:
* This container is only returned if ListingFeatureDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedVariationDetails - Site-level validation rules for multi-variation listings (for example, the
* maximum number of variations per listing). Use GetCategoryFeatures to
* determine which categories on a site support variations. Use
* GetCategorySpecifics for rules related to recommended or required variation
* specifics.
*
* Note:
* This container is only returned if VariationDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedExcludeShippingLocationDetails - Lists the locations supported by the ExcludeShipToLocation feature. These are
* locations that a seller can list as areas where they will not ship an item.
*
Output property: ReturnedUpdateTime - The time of the most recent modification to any feature detail. If specific
* feature details are passed in the request, gives the most recent modification time
* of those feature details.
*
Output property: ReturnedRecoupmentPolicyDetails - Details the recoupment policies for the site specified in the request.
*
* Note:
* This container is only returned if RecoupmentPolicyDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
Output property: ReturnedShippingCategoryDetails - A shipping service category supported for the site.
*
* Note:
* This container is only returned if ShippingCategoryDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
* Each shipping service supported for a site is automatically categorized by eBay into one of the
* shipping categories available for that site depending on how the shipping service shipping time
* aligns with the shipping times specified by eBay for each category.
*
* Notice that you cannot specify a ShippingCategory
* as an input to any API call - eBay does this categorizing automatically. ShippingCategory is read-only data
* that is returned in the ShippingServiceDetails container. One possible use of this data is to segregate shipping
* services by ShippingCategory in a pick list. (For an example of this, see the Services pulldown menu in the
* Give buyers shipping details form in the eBay Sell Your Item flow.)
*
* One way to populate the picklist would be to call GeteBayDetails
* with DetailName set to ShippingServiceDetails.
* Then sort these results by ShippingCategory and populate the picklist.
*
Output property: ReturnedProductDetails - The ProductDetails.ProductIdentifierUnavailableText
* field contains the actual text that should be passed into the relevant
* product identification fields (EAN, ISBN, UPC, MPN/Brand) if eBay is
* prompting/expecting one of these fields in the call request, but the identifiers do not exist/apply for the product. The text will vary based on the listing site. This text should only be used if no product ID exists for the product. If a product identifier value does actually exist for a product, but the seller passes in 'Does not apply' text, that listing may get penalized in search.
*
* Note:
* This container is only returned if ProductDetails is included as a
* DetailName filter in the request, or if no DetailName
* filters are used in the request.
*
*
* @author Ron Murphy
* @version 1.0
*/
public class GeteBayDetailsCall extends com.ebay.sdk.ApiCall
{
private DetailNameCodeType[] detailName = null;
private CountryDetailsType[] returnedCountryDetails=null;
private CurrencyDetailsType[] returnedCurrencyDetails=null;
private DispatchTimeMaxDetailsType[] returnedDispatchTimeMaxDetails=null;
private PaymentOptionDetailsType[] returnedPaymentOptionDetails=null;
private RegionDetailsType[] returnedRegionDetails=null;
private ShippingLocationDetailsType[] returnedShippingLocationDetails=null;
private ShippingServiceDetailsType[] returnedShippingServiceDetails=null;
private SiteDetailsType[] returnedSiteDetails=null;
private TaxJurisdictionType[] returnedTaxJurisdiction=null;
private URLDetailsType[] returnedURLDetails=null;
private TimeZoneDetailsType[] returnedTimeZoneDetails=null;
private ItemSpecificDetailsType[] returnedItemSpecificDetails=null;
private UnitOfMeasurementDetailsType[] returnedUnitOfMeasurementDetails=null;
private RegionOfOriginDetailsType[] returnedRegionOfOriginDetails=null;
private ShippingPackageDetailsType[] returnedShippingPackageDetails=null;
private ShippingCarrierDetailsType[] returnedShippingCarrierDetails=null;
private ReturnPolicyDetailsType returnedReturnPolicyDetails=null;
private ListingStartPriceDetailsType[] returnedListingStartPriceDetails=null;
private SiteBuyerRequirementDetailsType[] returnedBuyerRequirementDetails=null;
private ListingFeatureDetailsType[] returnedListingFeatureDetails=null;
private VariationDetailsType returnedVariationDetails=null;
private ExcludeShippingLocationDetailsType[] returnedExcludeShippingLocationDetails=null;
private Calendar returnedUpdateTime=null;
private RecoupmentPolicyDetailsType[] returnedRecoupmentPolicyDetails=null;
private ShippingCategoryDetailsType[] returnedShippingCategoryDetails=null;
private ProductDetailsType returnedProductDetails=null;
/**
* Constructor.
*/
public GeteBayDetailsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GeteBayDetailsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves eBay IDs and codes (e.g., site IDs and shipping service
* codes), enumerated data (e.g., payment methods), and other common eBay
* meta-data. This call enables you to keep certain data up to date in your
* applications without referring to the schema, the documentation, or the
* eBay online help. Other data is returned for your reference, but you may
* need to refer to the schema or the documentation for information about
* valid values and usage.
*
* In some cases, the data returned in the response will vary according to
* the site that you use for the request.
*
* If you use GeteBayDetails in preparation for listing in the US Motors Parts
* and Accessories categories, use site ID 0 (which is the site ID of the US
* site) when you call GeteBayDetails.
*
* Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the
* recoupment terms before adding items to the site. This agreement allows eBay to reimburse
* a buyer during a dispute and then recoup the cost from the seller. Information about whether a site
* is a recoupment site is returned in the GeteBayDetailsResponse.RecoupmentPolicyDetails container.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void geteBayDetails()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GeteBayDetailsRequestType req;
req = new GeteBayDetailsRequestType();
req.setDetailLevel(this.getDetailLevel());
if (this.detailName != null)
req.setDetailName(this.detailName);
GeteBayDetailsResponseType resp = (GeteBayDetailsResponseType) execute(req);
this.returnedCountryDetails = resp.getCountryDetails();
this.returnedCurrencyDetails = resp.getCurrencyDetails();
this.returnedDispatchTimeMaxDetails = resp.getDispatchTimeMaxDetails();
this.returnedPaymentOptionDetails = resp.getPaymentOptionDetails();
this.returnedRegionDetails = resp.getRegionDetails();
this.returnedShippingLocationDetails = resp.getShippingLocationDetails();
this.returnedShippingServiceDetails = resp.getShippingServiceDetails();
this.returnedSiteDetails = resp.getSiteDetails();
this.returnedTaxJurisdiction = resp.getTaxJurisdiction();
this.returnedURLDetails = resp.getURLDetails();
this.returnedTimeZoneDetails = resp.getTimeZoneDetails();
this.returnedItemSpecificDetails = resp.getItemSpecificDetails();
this.returnedUnitOfMeasurementDetails = resp.getUnitOfMeasurementDetails();
this.returnedRegionOfOriginDetails = resp.getRegionOfOriginDetails();
this.returnedShippingPackageDetails = resp.getShippingPackageDetails();
this.returnedShippingCarrierDetails = resp.getShippingCarrierDetails();
this.returnedReturnPolicyDetails = resp.getReturnPolicyDetails();
this.returnedListingStartPriceDetails = resp.getListingStartPriceDetails();
this.returnedBuyerRequirementDetails = resp.getBuyerRequirementDetails();
this.returnedListingFeatureDetails = resp.getListingFeatureDetails();
this.returnedVariationDetails = resp.getVariationDetails();
this.returnedExcludeShippingLocationDetails = resp.getExcludeShippingLocationDetails();
this.returnedUpdateTime = resp.getUpdateTime();
this.returnedRecoupmentPolicyDetails = resp.getRecoupmentPolicyDetails();
this.returnedShippingCategoryDetails = resp.getShippingCategoryDetails();
this.returnedProductDetails = resp.getProductDetails();
}
/**
* Gets the GeteBayDetailsRequestType.detailName.
* @return DetailNameCodeType[]
*/
public DetailNameCodeType[] getDetailName()
{
return this.detailName;
}
/**
* Sets the GeteBayDetailsRequestType.detailName.
* @param detailName DetailNameCodeType[]
*/
public void setDetailName(DetailNameCodeType[] detailName)
{
this.detailName = detailName;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.
*
* @return GeteBayDetailsResponseType
*/
public GeteBayDetailsResponseType getReturnedeBayDetails()
{
return (GeteBayDetailsResponseType) this.getResponseObject();
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedBuyerRequirementDetails.
*
* @return SiteBuyerRequirementDetailsType[]
*/
public SiteBuyerRequirementDetailsType[] getReturnedBuyerRequirementDetails()
{
return this.returnedBuyerRequirementDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedCountryDetails.
*
* @return CountryDetailsType[]
*/
public CountryDetailsType[] getReturnedCountryDetails()
{
return this.returnedCountryDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedCurrencyDetails.
*
* @return CurrencyDetailsType[]
*/
public CurrencyDetailsType[] getReturnedCurrencyDetails()
{
return this.returnedCurrencyDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedDispatchTimeMaxDetails.
*
* @return DispatchTimeMaxDetailsType[]
*/
public DispatchTimeMaxDetailsType[] getReturnedDispatchTimeMaxDetails()
{
return this.returnedDispatchTimeMaxDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedExcludeShippingLocationDetails.
*
* @return ExcludeShippingLocationDetailsType[]
*/
public ExcludeShippingLocationDetailsType[] getReturnedExcludeShippingLocationDetails()
{
return this.returnedExcludeShippingLocationDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedItemSpecificDetails.
*
* @return ItemSpecificDetailsType[]
*/
public ItemSpecificDetailsType[] getReturnedItemSpecificDetails()
{
return this.returnedItemSpecificDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedListingFeatureDetails.
*
* @return ListingFeatureDetailsType[]
*/
public ListingFeatureDetailsType[] getReturnedListingFeatureDetails()
{
return this.returnedListingFeatureDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedListingStartPriceDetails.
*
* @return ListingStartPriceDetailsType[]
*/
public ListingStartPriceDetailsType[] getReturnedListingStartPriceDetails()
{
return this.returnedListingStartPriceDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedPaymentOptionDetails.
*
* @return PaymentOptionDetailsType[]
*/
public PaymentOptionDetailsType[] getReturnedPaymentOptionDetails()
{
return this.returnedPaymentOptionDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedProductDetails.
*
* @return ProductDetailsType
*/
public ProductDetailsType getReturnedProductDetails()
{
return this.returnedProductDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedRecoupmentPolicyDetails.
*
* @return RecoupmentPolicyDetailsType[]
*/
public RecoupmentPolicyDetailsType[] getReturnedRecoupmentPolicyDetails()
{
return this.returnedRecoupmentPolicyDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedRegionDetails.
*
* @return RegionDetailsType[]
*/
public RegionDetailsType[] getReturnedRegionDetails()
{
return this.returnedRegionDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedRegionOfOriginDetails.
*
* @return RegionOfOriginDetailsType[]
*/
public RegionOfOriginDetailsType[] getReturnedRegionOfOriginDetails()
{
return this.returnedRegionOfOriginDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedReturnPolicyDetails.
*
* @return ReturnPolicyDetailsType
*/
public ReturnPolicyDetailsType getReturnedReturnPolicyDetails()
{
return this.returnedReturnPolicyDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedShippingCarrierDetails.
*
* @return ShippingCarrierDetailsType[]
*/
public ShippingCarrierDetailsType[] getReturnedShippingCarrierDetails()
{
return this.returnedShippingCarrierDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedShippingCategoryDetails.
*
* @return ShippingCategoryDetailsType[]
*/
public ShippingCategoryDetailsType[] getReturnedShippingCategoryDetails()
{
return this.returnedShippingCategoryDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedShippingLocationDetails.
*
* @return ShippingLocationDetailsType[]
*/
public ShippingLocationDetailsType[] getReturnedShippingLocationDetails()
{
return this.returnedShippingLocationDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedShippingPackageDetails.
*
* @return ShippingPackageDetailsType[]
*/
public ShippingPackageDetailsType[] getReturnedShippingPackageDetails()
{
return this.returnedShippingPackageDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedShippingServiceDetails.
*
* @return ShippingServiceDetailsType[]
*/
public ShippingServiceDetailsType[] getReturnedShippingServiceDetails()
{
return this.returnedShippingServiceDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedSiteDetails.
*
* @return SiteDetailsType[]
*/
public SiteDetailsType[] getReturnedSiteDetails()
{
return this.returnedSiteDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedTaxJurisdiction.
*
* @return TaxJurisdictionType[]
*/
public TaxJurisdictionType[] getReturnedTaxJurisdiction()
{
return this.returnedTaxJurisdiction;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedTimeZoneDetails.
*
* @return TimeZoneDetailsType[]
*/
public TimeZoneDetailsType[] getReturnedTimeZoneDetails()
{
return this.returnedTimeZoneDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedURLDetails.
*
* @return URLDetailsType[]
*/
public URLDetailsType[] getReturnedURLDetails()
{
return this.returnedURLDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedUnitOfMeasurementDetails.
*
* @return UnitOfMeasurementDetailsType[]
*/
public UnitOfMeasurementDetailsType[] getReturnedUnitOfMeasurementDetails()
{
return this.returnedUnitOfMeasurementDetails;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedUpdateTime.
*
* @return Calendar
*/
public Calendar getReturnedUpdateTime()
{
return this.returnedUpdateTime;
}
/**
* Valid after executing the API.
* Gets the returned GeteBayDetailsResponseType.returnedVariationDetails.
*
* @return VariationDetailsType
*/
public VariationDetailsType getReturnedVariationDetails()
{
return this.returnedVariationDetails;
}
}