Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum DetailNameCodeType

java.lang.Object
  extended by java.lang.Enum<DetailNameCodeType>
      extended by com.ebay.soap.eBLBaseComponents.DetailNameCodeType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DetailNameCodeType>

public enum DetailNameCodeType
extends java.lang.Enum<DetailNameCodeType>

Java class for DetailNameCodeType.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="DetailNameCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="CountryDetails"/>
     <enumeration value="CurrencyDetails"/>
     <enumeration value="PaymentOptionDetails"/>
     <enumeration value="RegionDetails"/>
     <enumeration value="ShippingLocationDetails"/>
     <enumeration value="ShippingServiceDetails"/>
     <enumeration value="SiteDetails"/>
     <enumeration value="TaxJurisdiction"/>
     <enumeration value="URLDetails"/>
     <enumeration value="TimeZoneDetails"/>
     <enumeration value="RegionOfOriginDetails"/>
     <enumeration value="DispatchTimeMaxDetails"/>
     <enumeration value="ItemSpecificDetails"/>
     <enumeration value="UnitOfMeasurementDetails"/>
     <enumeration value="ShippingPackageDetails"/>
     <enumeration value="CustomCode"/>
     <enumeration value="ShippingCarrierDetails"/>
     <enumeration value="ListingStartPriceDetails"/>
     <enumeration value="ReturnPolicyDetails"/>
     <enumeration value="BuyerRequirementDetails"/>
     <enumeration value="ListingFeatureDetails"/>
     <enumeration value="VariationDetails"/>
     <enumeration value="ExcludeShippingLocationDetails"/>
     <enumeration value="RecoupmentPolicyDetails"/>
     <enumeration value="ShippingCategoryDetails"/>
     <enumeration value="ProductDetails"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
BUYER_REQUIREMENT_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the Buyer Requirement values that can be passed in through the BuyerRequirementDetails container of an Add/Revise/Relist API call.
COUNTRY_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the two-digit country codes for all countries of the world.
CURRENCY_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the three-digit currency codes for each country where the Trading API is supported.
CUSTOM_CODE
          Reserved for future use.
DISPATCH_TIME_MAX_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the handling time values (in number of business days) that the seller can set on a listing.
EXCLUDE_SHIPPING_LOCATION_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the geographical regions and individual countries that can be passed in to the ShippingDetails.ExcludeShipToLocation field in an Add/Revise/Relist API call.
ITEM_SPECIFIC_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the maximum thresholds for Item Specifics in listings.
LISTING_FEATURE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the listing features/upgrades that are enabled or disabled for the specified site.
LISTING_START_PRICE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the minimum starting prices for each applicable listing format for the specified eBay site.
PAYMENT_OPTION_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve all payment methods that are accepted on the specified eBay site.
PRODUCT_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the appropriate text to insert into a product identifier field (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.
RECOUPMENT_POLICY_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve details on a site's recoupment policy.
REGION_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the local regions within the specified country.
REGION_OF_ORIGIN_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the international regions and individual countries.
RETURN_POLICY_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the return policy values that can be passed in through the ReturnPolicy container of an Add/Revise/Relist API call (or in a Return business policy).
SHIPPING_CARRIER_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping carriers supported by the specified eBay site for domestic and international shipping.
SHIPPING_CATEGORY_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping service categories (Standard, Expedited, Economy, etc.) supported for the site.
SHIPPING_LOCATION_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the geographical regions and country codes that can be used when creating a 'ship-to' location list.
SHIPPING_PACKAGE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping package types that are supported by the specified eBay site.
SHIPPING_SERVICE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the domestic and international shipping service options available on the specified eBay site.
SITE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the eBay sites that are supported in Trading API calls.
TAX_JURISDICTION
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the different tax jurisdictions (such as states or provinces) within the specified eBay site.
TIME_ZONE_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the names of the different global time zones.
UNIT_OF_MEASUREMENT_DETAILS
          This enumeration value is no longer applicable, and should not be used.
URL_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the different eBay URLs associated with the specified eBay site.
VARIATION_DETAILS
          This enumeration value can be included in a DetailName field if the user wishes to retrieve the maximum thresholds when using multiple-variation listings.
 
Method Summary
static DetailNameCodeType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static DetailNameCodeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DetailNameCodeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

COUNTRY_DETAILS

public static final DetailNameCodeType COUNTRY_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the two-digit country codes for all countries of the world. Among other things, the two-digit country codes can be used when a seller is creating a 'ship-to' and/or an 'exclude ship-to' location list.

The same CountryDetails metadata will be returned regardless of the value that is passed into the X-EBAY-API-SITEID request header.


CURRENCY_DETAILS

public static final DetailNameCodeType CURRENCY_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the three-digit currency codes for each country where the Trading API is supported. These three-digit currency codes are used when a seller is expressing a dollar value in Trading API calls. For example, the currencyID attribute value in the StartPrice field of an AddItem call.

The same CurrencyDetails metadata will be returned regardless of the value that is passed into the X-EBAY-API-SITEID request header.


PAYMENT_OPTION_DETAILS

public static final DetailNameCodeType PAYMENT_OPTION_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve all payment methods that are accepted on the specified eBay site. Note that the accepted payment methods within an eBay site can vary by category and/or by listing format, so a user may also want to make a GetCategoryFeatures call to retrieve category-level payment method metadata. To retrieve the accepted payment methods for a specific category on a specific site with GetCategoryFeatures, the user specifies the listing category ID through the CategoryID, and sets the FeatureID value to PaymentMethods.


REGION_DETAILS

public static final DetailNameCodeType REGION_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the local regions within the specified country.


SHIPPING_LOCATION_DETAILS

public static final DetailNameCodeType SHIPPING_LOCATION_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the geographical regions and country codes that can be used when creating a 'ship-to' location list.


SHIPPING_SERVICE_DETAILS

public static final DetailNameCodeType SHIPPING_SERVICE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the domestic and international shipping service options available on the specified eBay site. The returned metadata on each available shipping service will include the full name of the shipping service option (including carrier name), the actual shipping service enumeration value that will be used in an AddItem call, the expected shipping time range, the package types that can be used for that shipping service, and whether the shipping service is for domestic or international shipping. In addition to this information, the seller will have to look for a value of true in the ValidForSellingFlow field. If the value in this field is false, it indicates that the shipping service is no longer available for shipping.


SITE_DETAILS

public static final DetailNameCodeType SITE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the eBay sites that are supported in Trading API calls. The SiteID values that are returned for each country are specified as an HTTP header if the seller wants to see site metadata returned for that particular site.

The same SiteDetails metadata will be returned regardless of the value that is passed into the X-EBAY-API-SITEID request header.


TAX_JURISDICTION

public static final DetailNameCodeType TAX_JURISDICTION
This enumeration value can be included in a DetailName field if the user wishes to retrieve the different tax jurisdictions (such as states or provinces) within the specified eBay site. The two-digit JurisdictionID codes that are returned are used when a seller is setting/configuring sales tax rates in a Sales Tax Table, or when creating a listing. For example, the SalesTax.SalesTaxState field of an AddItem call.

Sales tax jurisdictions are only applicable to the US and Canada, so the TaxJurisdiction metadata will only be returned for these sites:


URL_DETAILS

public static final DetailNameCodeType URL_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the different eBay URLs associated with the specified eBay site.


TIME_ZONE_DETAILS

public static final DetailNameCodeType TIME_ZONE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the names of the different global time zones. The returned information includes the number of hours that each time zone is either ahead or behind UTC time, and it also indicates if the time zone participates in 'Daylight Savings'.

The same TimeZoneDetails metadata will be returned regardless of the value that is passed into the X-EBAY-API-SITEID request header, although the metadata text will be localized for that site's language.


REGION_OF_ORIGIN_DETAILS

public static final DetailNameCodeType REGION_OF_ORIGIN_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the international regions and individual countries.

The same RegionOfOriginDetails metadata will be returned regardless of the value that is passed into the X-EBAY-API-SITEID request header.


DISPATCH_TIME_MAX_DETAILS

public static final DetailNameCodeType DISPATCH_TIME_MAX_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the handling time values (in number of business days) that the seller can set on a listing. The seller must ship an order line item within this time or risk getting a seller defect. For the US, the supported handling times are 0-3 days. Some listing categories support 'extended handling' time, and if this is the case, the handling times will be longer, and the ExtendedHandling field will be returned as true.


ITEM_SPECIFIC_DETAILS

public static final DetailNameCodeType ITEM_SPECIFIC_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the maximum thresholds for Item Specifics in listings. These thresholds include the maximum number of item specifics that can be used for an item (or item variation), as well as the maximum number of characters that can be used for Item Specific names and values.


UNIT_OF_MEASUREMENT_DETAILS

public static final DetailNameCodeType UNIT_OF_MEASUREMENT_DETAILS
This enumeration value is no longer applicable, and should not be used.


SHIPPING_PACKAGE_DETAILS

public static final DetailNameCodeType SHIPPING_PACKAGE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping package types that are supported by the specified eBay site. A seller can also just use the ShippingServiceDetails filter, and the supported shipping package types for each shipping service option will be returned.


CUSTOM_CODE

public static final DetailNameCodeType CUSTOM_CODE
Reserved for future use.


SHIPPING_CARRIER_DETAILS

public static final DetailNameCodeType SHIPPING_CARRIER_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping carriers supported by the specified eBay site for domestic and international shipping.


LISTING_START_PRICE_DETAILS

public static final DetailNameCodeType LISTING_START_PRICE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the minimum starting prices for each applicable listing format for the specified eBay site. The price input into the StartPrice field of an AddItem call must be at or above this minimum threshold value or the listing will be blocked.


RETURN_POLICY_DETAILS

public static final DetailNameCodeType RETURN_POLICY_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the return policy values that can be passed in through the ReturnPolicy container of an Add/Revise/Relist API call (or in a Return business policy). These values include the return period, the 'Money back' options that the seller can make available to the buyers, and who pays for return shipping (Buyer or Seller).

Note: As of September 2018, the GetCategoryFeatures call started returning category-level metadata for both domestic and international return policies. Due to this update, developers may want to consider using that call for return policy metadata instead, as the GeteBayDetails call only retrieves site-level metadata, and does not distinguish between domestic and international metadata.


BUYER_REQUIREMENT_DETAILS

public static final DetailNameCodeType BUYER_REQUIREMENT_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the Buyer Requirement values that can be passed in through the BuyerRequirementDetails container of an Add/Revise/Relist API call.


LISTING_FEATURE_DETAILS

public static final DetailNameCodeType LISTING_FEATURE_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the listing features/upgrades that are enabled or disabled for the specified site.


VARIATION_DETAILS

public static final DetailNameCodeType VARIATION_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the maximum thresholds when using multiple-variation listings.


EXCLUDE_SHIPPING_LOCATION_DETAILS

public static final DetailNameCodeType EXCLUDE_SHIPPING_LOCATION_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the geographical regions and individual countries that can be passed in to the ShippingDetails.ExcludeShipToLocation field in an Add/Revise/Relist API call. Multiple ShippingDetails.ExcludeShipToLocation can be used, and any region or country value that is passed in to one of these fields will exclude that region or country as a "ship-to" location.


RECOUPMENT_POLICY_DETAILS

public static final DetailNameCodeType RECOUPMENT_POLICY_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve details on a site's recoupment policy.


SHIPPING_CATEGORY_DETAILS

public static final DetailNameCodeType SHIPPING_CATEGORY_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the shipping service categories (Standard, Expedited, Economy, etc.) supported for the site.


PRODUCT_DETAILS

public static final DetailNameCodeType PRODUCT_DETAILS
This enumeration value can be included in a DetailName field if the user wishes to retrieve the appropriate text to insert into a product identifier field (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 ProductDetails.ProductIdentifierUnavailableText field that is returned in the response will contain the actual text that should be passed into the relevant product identification fields when creating a listing.

Method Detail

values

public static DetailNameCodeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (DetailNameCodeType c : DetailNameCodeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static DetailNameCodeType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

fromValue

public static DetailNameCodeType fromValue(java.lang.String v)

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.