Changes since
the last release

com.ebay.sdk.call
Class GeteBayDetailsCall

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

public class GeteBayDetailsCall
extends ApiCall

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 - One or more DetailName fields may be used to control the the type of metadata that is returned in the response. If no DetailName fields are used, all metadata will be returned in the response. It is a good idea to familiarize yourself with the metadata that can be returned with GeteBayDetails by reading through the enumeration values in DetailNameCodeType.
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.

Note: This container is only returned if CountryDetails is included as a DetailName filter in the request, or if no DetailName filters are used 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 - Although the supported payment methods for the specified eBay site are returned, it is recommended that the seller use GetCategoryFeatures instead, and pass in PaymentMethods as a FeatureID value in the request.
Output property: ReturnedRegionDetails - Lists the cities and other domestic regions for the specified site's country.

Note: This container is only returned if RegionDetails is included as a DetailName filter in the request, or if no DetailName filters are used in the request.
Output property: ReturnedShippingLocationDetails - Lists the worldwide regions that can be set as shipping locations from the specified eBay site.

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 that tax jurisdictions are only applicable to the following eBay sites: eBay US (Site ID 0), eBay US Motors (Site ID 100), eBay Canada (Site ID 2), eBay Canada (French) (Site ID 210), and eBay India (Site ID 203). An empty response will be returned for any other Site ID that is passed in the HTTP header.

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 - Lists the site's maximum thresholds for specifying 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 - Lists the worldwide regions and individual countries that can be set as shipping locations from the specified eBay site.

Note: This container is only returned if RegionOfOriginDetails is included as a DetailName filter in the request, or if no DetailName filters are used in the request.
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 supported values that may be used for return policies on the specified eBay site, such as the return period, supported restocking fees, and refund options.

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: ReturnedInternationalReturnPolicyDetails - Lists the international return policies supported by the eBay marketplace specified in the request, such as the return periods supported by the marketplace.
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 through 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 eBay 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.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GeteBayDetailsCall()
          Constructor.
GeteBayDetailsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 DetailNameCodeType[] getDetailName()
          Gets the GeteBayDetailsRequestType.detailName.
 void geteBayDetails()
          This is the base request type for the GeteBayDetails call.
 SiteBuyerRequirementDetailsType[] getReturnedBuyerRequirementDetails()
          Valid after executing the API.
 CountryDetailsType[] getReturnedCountryDetails()
          Valid after executing the API.
 CurrencyDetailsType[] getReturnedCurrencyDetails()
          Valid after executing the API.
 DispatchTimeMaxDetailsType[] getReturnedDispatchTimeMaxDetails()
          Valid after executing the API.
 GeteBayDetailsResponseType getReturnedeBayDetails()
          Valid after executing the API.
 ExcludeShippingLocationDetailsType[] getReturnedExcludeShippingLocationDetails()
          Valid after executing the API.
 ReturnPolicyDetailsType getReturnedInternationalReturnPolicyDetails()
          Valid after executing the API.
 ItemSpecificDetailsType[] getReturnedItemSpecificDetails()
          Valid after executing the API.
 ListingFeatureDetailsType[] getReturnedListingFeatureDetails()
          Valid after executing the API.
 ListingStartPriceDetailsType[] getReturnedListingStartPriceDetails()
          Valid after executing the API.
 PaymentOptionDetailsType[] getReturnedPaymentOptionDetails()
          Valid after executing the API.
 ProductDetailsType getReturnedProductDetails()
          Valid after executing the API.
 RecoupmentPolicyDetailsType[] getReturnedRecoupmentPolicyDetails()
          Valid after executing the API.
 RegionDetailsType[] getReturnedRegionDetails()
          Valid after executing the API.
 RegionOfOriginDetailsType[] getReturnedRegionOfOriginDetails()
          Valid after executing the API.
 ReturnPolicyDetailsType getReturnedReturnPolicyDetails()
          Valid after executing the API.
 ShippingCarrierDetailsType[] getReturnedShippingCarrierDetails()
          Valid after executing the API.
 ShippingCategoryDetailsType[] getReturnedShippingCategoryDetails()
          Valid after executing the API.
 ShippingLocationDetailsType[] getReturnedShippingLocationDetails()
          Valid after executing the API.
 ShippingPackageDetailsType[] getReturnedShippingPackageDetails()
          Valid after executing the API.
 ShippingServiceDetailsType[] getReturnedShippingServiceDetails()
          Valid after executing the API.
 SiteDetailsType[] getReturnedSiteDetails()
          Valid after executing the API.
 TaxJurisdictionType[] getReturnedTaxJurisdiction()
          Valid after executing the API.
 TimeZoneDetailsType[] getReturnedTimeZoneDetails()
          Valid after executing the API.
 UnitOfMeasurementDetailsType[] getReturnedUnitOfMeasurementDetails()
          Valid after executing the API.
 java.util.Calendar getReturnedUpdateTime()
          Valid after executing the API.
 URLDetailsType[] getReturnedURLDetails()
          Valid after executing the API.
 VariationDetailsType getReturnedVariationDetails()
          Valid after executing the API.
 void setDetailName(DetailNameCodeType[] detailName)
          Sets the GeteBayDetailsRequestType.detailName.
 
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

GeteBayDetailsCall

public GeteBayDetailsCall()
Constructor.


GeteBayDetailsCall

public GeteBayDetailsCall(ApiContext apiContext)
Constructor.

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

geteBayDetails

public void geteBayDetails()
                    throws ApiException,
                           SdkException,
                           java.lang.Exception
This is the base request type for the GeteBayDetails call. This call retrieves the latest eBay feature-related metadata values that are supported when listing items. This metadata includes country codes, currency codes, Item Specifics thresholds, supported Return Policy values, available shipping carriers and shipping service options, and more. This call may be used to keep metadata up-to-date in your applications.

In some cases, the data returned in the response will vary according to the eBay site that you use for the request.

Throws:
ApiException
SdkException
java.lang.Exception

getDetailName

public DetailNameCodeType[] getDetailName()
Gets the GeteBayDetailsRequestType.detailName.

Returns:
DetailNameCodeType[]

setDetailName

public void setDetailName(DetailNameCodeType[] detailName)
Sets the GeteBayDetailsRequestType.detailName.

Parameters:
detailName - DetailNameCodeType[]

getReturnedeBayDetails

public GeteBayDetailsResponseType getReturnedeBayDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.

Returns:
GeteBayDetailsResponseType

getReturnedBuyerRequirementDetails

public SiteBuyerRequirementDetailsType[] getReturnedBuyerRequirementDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedBuyerRequirementDetails.

Returns:
SiteBuyerRequirementDetailsType[]

getReturnedCountryDetails

public CountryDetailsType[] getReturnedCountryDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedCountryDetails.

Returns:
CountryDetailsType[]

getReturnedCurrencyDetails

public CurrencyDetailsType[] getReturnedCurrencyDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedCurrencyDetails.

Returns:
CurrencyDetailsType[]

getReturnedDispatchTimeMaxDetails

public DispatchTimeMaxDetailsType[] getReturnedDispatchTimeMaxDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedDispatchTimeMaxDetails.

Returns:
DispatchTimeMaxDetailsType[]

getReturnedExcludeShippingLocationDetails

public ExcludeShippingLocationDetailsType[] getReturnedExcludeShippingLocationDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedExcludeShippingLocationDetails.

Returns:
ExcludeShippingLocationDetailsType[]

getReturnedInternationalReturnPolicyDetails

public ReturnPolicyDetailsType getReturnedInternationalReturnPolicyDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedInternationalReturnPolicyDetails.

Returns:
ReturnPolicyDetailsType

getReturnedItemSpecificDetails

public ItemSpecificDetailsType[] getReturnedItemSpecificDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedItemSpecificDetails.

Returns:
ItemSpecificDetailsType[]

getReturnedListingFeatureDetails

public ListingFeatureDetailsType[] getReturnedListingFeatureDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedListingFeatureDetails.

Returns:
ListingFeatureDetailsType[]

getReturnedListingStartPriceDetails

public ListingStartPriceDetailsType[] getReturnedListingStartPriceDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedListingStartPriceDetails.

Returns:
ListingStartPriceDetailsType[]

getReturnedPaymentOptionDetails

public PaymentOptionDetailsType[] getReturnedPaymentOptionDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedPaymentOptionDetails.

Returns:
PaymentOptionDetailsType[]

getReturnedProductDetails

public ProductDetailsType getReturnedProductDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedProductDetails.

Returns:
ProductDetailsType

getReturnedRecoupmentPolicyDetails

public RecoupmentPolicyDetailsType[] getReturnedRecoupmentPolicyDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedRecoupmentPolicyDetails.

Returns:
RecoupmentPolicyDetailsType[]

getReturnedRegionDetails

public RegionDetailsType[] getReturnedRegionDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedRegionDetails.

Returns:
RegionDetailsType[]

getReturnedRegionOfOriginDetails

public RegionOfOriginDetailsType[] getReturnedRegionOfOriginDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedRegionOfOriginDetails.

Returns:
RegionOfOriginDetailsType[]

getReturnedReturnPolicyDetails

public ReturnPolicyDetailsType getReturnedReturnPolicyDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedReturnPolicyDetails.

Returns:
ReturnPolicyDetailsType

getReturnedShippingCarrierDetails

public ShippingCarrierDetailsType[] getReturnedShippingCarrierDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedShippingCarrierDetails.

Returns:
ShippingCarrierDetailsType[]

getReturnedShippingCategoryDetails

public ShippingCategoryDetailsType[] getReturnedShippingCategoryDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedShippingCategoryDetails.

Returns:
ShippingCategoryDetailsType[]

getReturnedShippingLocationDetails

public ShippingLocationDetailsType[] getReturnedShippingLocationDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedShippingLocationDetails.

Returns:
ShippingLocationDetailsType[]

getReturnedShippingPackageDetails

public ShippingPackageDetailsType[] getReturnedShippingPackageDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedShippingPackageDetails.

Returns:
ShippingPackageDetailsType[]

getReturnedShippingServiceDetails

public ShippingServiceDetailsType[] getReturnedShippingServiceDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedShippingServiceDetails.

Returns:
ShippingServiceDetailsType[]

getReturnedSiteDetails

public SiteDetailsType[] getReturnedSiteDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedSiteDetails.

Returns:
SiteDetailsType[]

getReturnedTaxJurisdiction

public TaxJurisdictionType[] getReturnedTaxJurisdiction()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedTaxJurisdiction.

Returns:
TaxJurisdictionType[]

getReturnedTimeZoneDetails

public TimeZoneDetailsType[] getReturnedTimeZoneDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedTimeZoneDetails.

Returns:
TimeZoneDetailsType[]

getReturnedURLDetails

public URLDetailsType[] getReturnedURLDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedURLDetails.

Returns:
URLDetailsType[]

getReturnedUnitOfMeasurementDetails

public UnitOfMeasurementDetailsType[] getReturnedUnitOfMeasurementDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedUnitOfMeasurementDetails.

Returns:
UnitOfMeasurementDetailsType[]

getReturnedUpdateTime

public java.util.Calendar getReturnedUpdateTime()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedUpdateTime.

Returns:
Calendar

getReturnedVariationDetails

public VariationDetailsType getReturnedVariationDetails()
Valid after executing the API. Gets the returned GeteBayDetailsResponseType.returnedVariationDetails.

Returns:
VariationDetailsType

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.