GeteBayDetails

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.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
GeteBayDetails Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document). 

<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <DetailName> DetailNameCodeType </DetailName>
  <!-- ... more DetailName nodes here ... -->
</GeteBayDetailsRequest>
Argument Type Reqd? Meaning
Standard Input Fields   [Jump to call-specific fields]
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

See Tags for the Identification of Languages.
MessageID string Optional In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP Headers (XML API Only)
    eBay Schema Versioning Strategy
    Lowest Supported Version
WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests in your production code.

Applicable values:

•   High

(in) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.




See Warning Level.
Call-specific Input Fields
DetailName DetailNameCodeType
(repeatable)		 Optional 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.

Applicable values:

•   CountryDetails

(in) Details about a specific country.

•   CurrencyDetails

(in) Details about a specific currency.

•   CustomCode

(in) Reserved for future use.

•   DispatchTimeMaxDetails

(in) Details about a specific maximum dispatch time.

•   ItemSpecificDetails

(in) Details about Item Specifics rules for the site.

•   PaymentOptionDetails

(in) Details about a specific payment option.

•   RegionDetails

(in) Not functional. Do not specify this value.

•   RegionOfOriginDetails

(in) Details about the region of origin of a listing.

•   ShippingCarrierDetails

(in) Details about various Shipping Carriers.

•   ShippingLocationDetails

(in) Details about a specific location or region to which the seller is willing to ship.

•   ShippingPackageDetails

(in) Details about various Shipping Packages.

•   ShippingServiceDetails

(in) Details about a specific shipping service.

•   SiteDetails

(in) Details about a specific eBay site.

•   TaxJurisdiction

(in) Details about a specific tax jurisdiction or region.

•   TimeZoneDetails

(in) Details about a specific time zone.

•   UnitOfMeasurementDetails

(in) Details about suggested unit of measure strings to use when listing items with Item Specifics.

•   URLDetails

(in) Details about a specific eBay URL.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
GeteBayDetails Output

The box below lists all fields that might be returned in the call response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document). 

<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <CountryDetails> CountryDetailsType 
    <Country> CountryCodeType </Country>
    <Description> string </Description>
  </CountryDetails>
  <!-- ... more CountryDetails nodes here ... -->
  <CurrencyDetails> CurrencyDetailsType 
    <Currency> CurrencyCodeType </Currency>
    <Description> string </Description>
  </CurrencyDetails>
  <!-- ... more CurrencyDetails nodes here ... -->
  <DispatchTimeMaxDetails> DispatchTimeMaxDetailsType 
    <Description> string </Description>
    <DispatchTimeMax> int </DispatchTimeMax>
  </DispatchTimeMaxDetails>
  <!-- ... more DispatchTimeMaxDetails nodes here ... -->
  <ItemSpecificDetails> ItemSpecificDetailsType 
    <MaxCharactersPerName> int </MaxCharactersPerName>
    <MaxCharactersPerValue> int </MaxCharactersPerValue>
    <MaxItemSpecificsPerItem> int </MaxItemSpecificsPerItem>
    <MaxValuesPerName> int </MaxValuesPerName>
  </ItemSpecificDetails>
  <!-- ... more ItemSpecificDetails nodes here ... -->
  <PaymentOptionDetails> PaymentOptionDetailsType 
    <Description> string </Description>
    <PaymentOption> BuyerPaymentMethodCodeType </PaymentOption>
  </PaymentOptionDetails>
  <!-- ... more PaymentOptionDetails nodes here ... -->
  <RegionDetails> RegionDetailsType 
    <Description> string </Description>
    <RegionID> string </RegionID>
  </RegionDetails>
  <!-- ... more RegionDetails nodes here ... -->
  <RegionOfOriginDetails> RegionOfOriginDetailsType 
    <Description> string </Description>
    <RegionOfOrigin> string </RegionOfOrigin>
  </RegionOfOriginDetails>
  <!-- ... more RegionOfOriginDetails nodes here ... -->
  <ShippingCarrierDetails> ShippingCarrierDetailsType 
    <Description> string </Description>
    <ShippingCarrier> ShippingCarrierCodeType </ShippingCarrier>
    <ShippingCarrierID> int </ShippingCarrierID>
  </ShippingCarrierDetails>
  <!-- ... more ShippingCarrierDetails nodes here ... -->
  <ShippingLocationDetails> ShippingLocationDetailsType 
    <Description> string </Description>
    <ShippingLocation> string </ShippingLocation>
  </ShippingLocationDetails>
  <!-- ... more ShippingLocationDetails nodes here ... -->
  <ShippingPackageDetails> ShippingPackageDetailsType 
    <Default> boolean </Default>
    <Description> string </Description>
    <PackageID> int </PackageID>
    <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
  </ShippingPackageDetails>
  <!-- ... more ShippingPackageDetails nodes here ... -->
  <ShippingServiceDetails> ShippingServiceDetailsType 
    <CODService> boolean </CODService>
    <DeprecationDetails> AnnouncementMessageType 
      <AnnouncementStartTime> dateTime </AnnouncementStartTime>
      <EventTime> dateTime </EventTime>
      <MessageType> AnnouncementMessageCodeType </MessageType>
    </DeprecationDetails>
    <!-- ... more DeprecationDetails nodes here ... -->
    <Description> string </Description>
    <DimensionsRequired> boolean </DimensionsRequired>
    <ExpeditedService> boolean </ExpeditedService>
    <InternationalService> boolean </InternationalService>
    <MappedToShippingServiceID> int </MappedToShippingServiceID>
    <ServiceType> ShippingTypeCodeType </ServiceType>
    <!-- ... more ServiceType nodes here ... -->
    <ShippingCarrier> ShippingCarrierCodeType </ShippingCarrier>
    <!-- ... more ShippingCarrier nodes here ... -->
    <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
    <!-- ... more ShippingPackage nodes here ... -->
    <ShippingService> token </ShippingService>
    <ShippingServiceID> int </ShippingServiceID>
    <ShippingTimeMax> int </ShippingTimeMax>
    <ShippingTimeMin> int </ShippingTimeMin>
    <SurchargeApplicable> boolean </SurchargeApplicable>
    <ValidForSellingFlow> boolean </ValidForSellingFlow>
  </ShippingServiceDetails>
  <!-- ... more ShippingServiceDetails nodes here ... -->
  <SiteDetails> SiteDetailsType 
    <Site> SiteCodeType </Site>
    <SiteID> int </SiteID>
  </SiteDetails>
  <!-- ... more SiteDetails nodes here ... -->
  <TaxJurisdiction> TaxJurisdictionType 
    <JurisdictionID> string </JurisdictionID>
    <JurisdictionName> string </JurisdictionName>
  </TaxJurisdiction>
  <!-- ... more TaxJurisdiction nodes here ... -->
  <TimeZoneDetails> TimeZoneDetailsType 
    <DaylightSavingsInEffect> boolean </DaylightSavingsInEffect>
    <DaylightSavingsLabel> string </DaylightSavingsLabel>
    <DaylightSavingsOffset> string </DaylightSavingsOffset>
    <StandardLabel> string </StandardLabel>
    <StandardOffset> string </StandardOffset>
    <TimeZoneID> string </TimeZoneID>
  </TimeZoneDetails>
  <!-- ... more TimeZoneDetails nodes here ... -->
  <UnitOfMeasurementDetails> UnitOfMeasurementDetailsType 
    <UnitOfMeasurement> UnitOfMeasurementType 
      <AlternateText> string </AlternateText>
      <!-- ... more AlternateText nodes here ... -->
      <SuggestedText> string </SuggestedText>
    </UnitOfMeasurement>
    <!-- ... more UnitOfMeasurement nodes here ... -->
  </UnitOfMeasurementDetails>
  <!-- ... more UnitOfMeasurementDetails nodes here ... -->
  <URLDetails> URLDetailsType 
    <URL> anyURI </URL>
    <URLType> URLTypeCodeType </URLType>
  </URLDetails>
  <!-- ... more URLDetails nodes here ... -->
</GeteBayDetailsResponse>
Return Value Type Returned? Meaning
Standard Output Fields   [Jump to call-specific fields]
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType
(repeatable)		 Conditionally A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters ErrorParameterType
(repeatable)		 Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
CountryDetails CountryDetailsType
(repeatable)		 Conditionally Details about a specific country. GeteBayDetails returns all countries in the system, regardless of the site to which you sent the request.
CountryDetails.Country CountryCodeType Conditionally Two-letter country abbreviation.

Related fields:
Item.Country in AddItem
SearchLocationFilter.CountryCode in GetSearchResults

Applicable values: See Country.
CountryDetails.Description string Conditionally Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser).
CurrencyDetails CurrencyDetailsType
(repeatable)		 Conditionally Details about a specific currency that can be used for listing on an eBay site. GeteBayDetails returns all site currencies in the system, regardless of the site to which you sent the request.
CurrencyDetails.Currency CurrencyCodeType Conditionally Currency abbreviation.

Related fields:
Item.Currency and Item.StartPrice in AddItem
SearchLocationFilter.Currency in GetSearchResults

Applicable values: See Currency.
CurrencyDetails.Description string Conditionally Full currency name for display purposes.
DispatchTimeMaxDetails DispatchTimeMaxDetailsType
(repeatable)		 Conditionally Details about a specific max dispatch time. 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. GeteBayDetails returns all dispatch times in the system, regardless of the site to which you sent the request.
DispatchTimeMaxDetails
  .Description 		string Conditionally Value and unit (e.g., 10 Days) for the maximum dispatch time. Useful for display purposes.
DispatchTimeMaxDetails
  .DispatchTimeMax 		int Conditionally Integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the maximum dispatch time.

Related field:
Item.DispatchTimeMax in AddItem
ItemSpecificDetails ItemSpecificDetailsType
(repeatable)		 Conditionally The site's validation rules (e.g., string lengths) for custom Item Specifics.
ItemSpecificDetails
  .MaxCharactersPerName 		int Conditionally The maximum number of characters the site supports per custom Item Specific name.

Related fields:
Item.ItemSpecifics in AddItem
ItemSpecifics in GetCategorySpecifics
ItemSpecifics in GetItemRecommendations
ItemSpecificDetails
  .MaxCharactersPerValue 		int Conditionally The maximum number of characters the site supports per custom Item Specific value.

Related fields:
Item.ItemSpecifics in AddItem
ItemSpecifics in GetCategorySpecifics
ItemSpecifics in GetItemRecommendations
ItemSpecificDetails
  .MaxItemSpecificsPerItem 		int Conditionally The maximum number of custom Item Specifics allowed when you list an item. Also the maximum returned per category in GetCategorySpecifics and GetItemRecommendations.

Related fields:
Item.ItemSpecifics in AddItem
ItemSpecifics in GetCategorySpecifics
ItemSpecifics in GetItemRecommendations
ItemSpecificDetails
  .MaxValuesPerName 		int Conditionally The maximum number of values returned for each custom Item Specific in GetCategorySpecifics and GetItemRecommendations.

Related fields:
ItemSpecifics in GetCategorySpecifics
ItemSpecifics in GetItemRecommendations
PaymentOptionDetails PaymentOptionDetailsType
(repeatable)		 Conditionally Details about a specific buyer payment method. GeteBayDetails only returns payment methods that are applicable to the site to which you sent the request.
PaymentOptionDetails
  .Description 		string Conditionally Full name of the payment method for display purposes.
PaymentOptionDetails
  .PaymentOption 		BuyerPaymentMethodCodeType Conditionally A payment method value defined in the schema.

Related fields:
Item.PaymentMethods in AddItem
PaymentMethodUsed in ReviseCheckoutStatus

Applicable values: See PaymentOption.
RegionDetails RegionDetailsType
(repeatable)		 Conditionally [Ignorable region values for all sites.]
RegionDetails.Description string Conditionally Full name of the region.
RegionDetails.RegionID string Conditionally Numeric identifier for a region within a country.
RegionOfOriginDetails RegionOfOriginDetailsType
(repeatable)		 Conditionally Details about the region of origin, specific to a site.
RegionOfOriginDetails
  .Description 		string Conditionally Full name of the region.
RegionOfOriginDetails
  .RegionOfOrigin 		string Conditionally Numeric identifier for a region within a country. Permissible values are as in ShippingRegionCodeList.xsd and CountryCodeList.xsd
ShippingCarrierDetails ShippingCarrierDetailsType
(repeatable)		 Conditionally The kinds of carrier supported by this shipping service.
ShippingCarrierDetails
  .Description 		string Conditionally Full name of the shipping Carrier for display purposes.
ShippingCarrierDetails
  .ShippingCarrier 		ShippingCarrierCodeType Conditionally Value used for the shipping Carrier.

Applicable values:

•   Chronopost

(out) Chronopost.

•   ColiposteDomestic

(out) Coliposte Domestic.

•   ColiposteInternational

(out) Coliposte International.

•   Correos

(out) Correos.

•   CustomCode

(out) Reserved for internal or future use.

•   DeutschePost

(out) Deutsche Post.

•   DHL

(out) DHL service

•   Hermes

(out) Hermes.

•   iLoxx

(out) iLoxx.

•   Other

(out) Other Postal Service.

•   Seur

(out) Seur.

•   UPS

(in/out) United Parcel Service.

•   USPS

(in/out) U.S. Postal Service.
ShippingCarrierDetails
  .ShippingCarrierID 		int Conditionally Numeric identifier. Some applications use this ID to look up shipping Carriers more efficiently.
ShippingLocationDetails ShippingLocationDetailsType
(repeatable)		 Conditionally Details about a location or region to which the seller is willing to ship. GeteBayDetails returns all shipping locations in the system, regardless of the site to which you sent the request.
ShippingLocationDetails
  .Description 		string Conditionally Display name of region or location (sometimes more descriptive than the ShippingLocation short name).
ShippingLocationDetails
  .ShippingLocation 		string Conditionally Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan).

Related field:
Item.ShippingDetails.InternationalShippingServiceOption.ShipToLocation in AddItem
ShippingPackageDetails ShippingPackageDetailsType
(repeatable)		 Conditionally Details about various shipping packages.
ShippingPackageDetails.Default boolean Conditionally Indicates if the package type is the default for the specified site.
ShippingPackageDetails
  .Description 		string Conditionally Full name of the shipping package for display purposes.
ShippingPackageDetails
  .PackageID 		int Conditionally Numeric identifier. Some applications use this ID to look up shipping packages more efficiently.
ShippingPackageDetails
  .ShippingPackage 		ShippingPackageCodeType Conditionally Value used for the shipping package. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingPackageDetails.

Applicable values: See ShippingPackage.
ShippingServiceDetails ShippingServiceDetailsType
(repeatable)		 Conditionally Details about a specific shipping service. GeteBayDetails only returns shipping services that are applicable to the site to which you sent the request.
ShippingServiceDetails
  .CODService 		boolean Conditionally Applies to the Italy site (site ID 101) only. Indicates whether the shipping service is a Cash On Delivery shipping service. Returned only if true.
ShippingServiceDetails
  .DeprecationDetails 		AnnouncementMessageType
(repeatable)		 Conditionally A mechanism by which details about deprecation of a shipping service is announced. See also MappedToShippingServiceID. If this container is empty, it means that there is no mapping for this shipping service and that the shipping service will be dropped from the listing without an accompanying warning message from the eBay API.

See Deprecated Shipping Services.
ShippingServiceDetails
  .DeprecationDetails
  .AnnouncementStartTime 		dateTime Conditionally The date on which an upcoming event can start to be announced.
ShippingServiceDetails
  .DeprecationDetails.EventTime 		dateTime Conditionally The date on which the event occurs. This is also the ending date of the announcement that lead up to the event (see AnnouncementStartTime).
ShippingServiceDetails
  .DeprecationDetails
  .MessageType 		AnnouncementMessageCodeType Conditionally Control of what messages to display.

Applicable values:

•   CustomCode

(out) Reserved for future use.

•   Deprecation

(out) A deprecation message is to be made available, but only if today's date is between AnnouncementMessageType.AnnouncementStartTime and AnnouncementMessageType.EventTime.

•   DeprecationAndMapping

(out) Both "Deprecation" and "Mapping" enumerations are to apply.

•   Mapping

(out) A mapping message is to be made available, but only if today's date is after AnnouncementMessageType.EventTime.

•   None

(out) No message is to be made available.
ShippingServiceDetails
  .Description 		string Conditionally Full name of the shipping service for display purposes.
ShippingServiceDetails
  .DimensionsRequired 		boolean Conditionally True if this shipping service requires package dimensions.
ShippingServiceDetails
  .ExpeditedService 		boolean Conditionally Indicates whether the shipping service is an expedited shipping service. See Enabling Get It Fast. Whether the service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true.

Related fields:
Item.DispatchTimeMax and Item.GetItFast in AddItem
ShippingServiceDetails
  .InternationalService 		boolean Conditionally Indicates whether the shipping service is an international shipping service, i.e. one that ships from to another country from the country of the specified site.

Related field: Item.ShippingDetails.InternationalShippingServiceOption in AddItem.
ShippingServiceDetails
  .MappedToShippingServiceID 		int Conditionally The ID of another shipping service that will be used when a shipping service is deprecated. See also DeprecationDetails.

See Deprecated Shipping Services.
ShippingServiceDetails
  .ServiceType 		ShippingTypeCodeType
(repeatable)		 Conditionally The types of shipping that this shipping service supports.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.


(Not all values in ShippingTypeCodeType apply to this field.)
ShippingServiceDetails
  .ShippingCarrier 		ShippingCarrierCodeType
(repeatable)		 Conditionally The kinds of carrier supported by this shipping service.

Applicable values:

•   Chronopost

(out) Chronopost.

•   ColiposteDomestic

(out) Coliposte Domestic.

•   ColiposteInternational

(out) Coliposte International.

•   Correos

(out) Correos.

•   CustomCode

(out) Reserved for internal or future use.

•   DeutschePost

(out) Deutsche Post.

•   DHL

(out) DHL service

•   Hermes

(out) Hermes.

•   iLoxx

(out) iLoxx.

•   Other

(out) Other Postal Service.

•   Seur

(out) Seur.

•   UPS

(in/out) United Parcel Service.

•   USPS

(in/out) U.S. Postal Service.
ShippingServiceDetails
  .ShippingPackage 		ShippingPackageCodeType
(repeatable)		 Conditionally The kinds of packages supported by this shipping service.

Applicable values: See ShippingPackage.
ShippingServiceDetails
  .ShippingService 		token Conditionally Value used for the shipping service. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails.

Related fields:
Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in AddItem
Item.ShippingDetails.ShippingServiceOptions.ShippingService in AddItem
ShippingServiceDetails
  .ShippingServiceID 		int Conditionally Numeric identifier. A value greater than 50000 represents an international shipping service (confirmed by InternationalShippingService being true). Some applications use this ID to look up shipping services more efficiently. Also useful for applications that have migrated from the legacy XML API.
ShippingServiceDetails
  .ShippingTimeMax 		int Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. See Enabling Get It Fast feature.
ShippingServiceDetails
  .ShippingTimeMin 		int Conditionally The minimum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. See Enabling Get It Fast feature.
ShippingServiceDetails
  .SurchargeApplicable 		boolean Conditionally True if a surcharge applies for any region that this service ships to.
ShippingServiceDetails
  .ValidForSellingFlow 		boolean Conditionally True if the shipping service is valid for the Sell Your Item flow.
SiteDetails SiteDetailsType
(repeatable)		 Conditionally Details about a specific eBay site. GeteBayDetails returns all sites in the system, regardless of the site to which you sent the request.
SiteDetails.Site SiteCodeType Conditionally Short name that identifies an eBay site. Usually, an eBay site is associated with a particular country or region (e.g., US or Belgium_French). Specialty sites (e.g., eBay Express or eBay Stores) use the same site ID as their associated main eBay site. The US eBay Motors site is an exception to this convention.

Related fields:
Item.Site in AddItem
User.Site in GetUser

Applicable values: See Site.
SiteDetails.SiteID int Conditionally Numeric identifier for an eBay site. If you are using the SOAP API, you use numeric site IDs in the request URL. If you are using the XML API, you use numeric site IDs in the X-EBAY-API-SITEID header.
TaxJurisdiction TaxJurisdictionType
(repeatable)		 Conditionally Details about a specific tax jurisdiction or tax region. GeteBayDetails only returns jurisdictions that are applicable to the site to which you sent the request.

Related fields:
TaxTable.TaxJurisdiction in SetTaxTable
Item.UseTaxTable in Additem
TaxJurisdiction.JurisdictionID string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (e.g. CA for California).
TaxJurisdiction
  .JurisdictionName 		string Conditionally Full name for the jurisdiction or region for display purposes.
TimeZoneDetails TimeZoneDetailsType
(repeatable)		 Conditionally Details about a specific eBay time zone. GeteBayDetails returns all time zones eBay supports.
TimeZoneDetails
  .DaylightSavingsInEffect 		boolean Conditionally Indicates whether or not the time zone is currently on daylight saving time. A value of true indicates that the time zone is on daylights savings time. This element is emitted for time zones that support daylight saving time only.
TimeZoneDetails
  .DaylightSavingsLabel 		string Conditionally Display name of a time zone in its daylight saving time representation. This element is emitted for time zones that support daylight saving time only. The value is localized and returned in the language for the site specified in the request.
TimeZoneDetails
  .DaylightSavingsOffset 		string Conditionally The offset in hours from GMT for a time zone when it is on daylight saving time. This element is emitted for time zones that support daylight saving time only.
TimeZoneDetails.StandardLabel string Conditionally Display name of a time zone in its standard (non-daylight saving) time representation. This value is localized and returned in the language for the site specified in the request (i.e., the numeric site ID that you specify in the request URL for the SOAP API or the X-EBAY-API-SITEID header for the XML API).
TimeZoneDetails.StandardOffset string Conditionally The offset in hours from GMT for a time zone when it is not adjusted for daylight saving time.
TimeZoneDetails.TimeZoneID string Conditionally A unique identifier for a given time zone. This ID does not change for a given time zone, even if the time zone supports both standard and daylight saving time variants. Valid values for TimeZoneID correspond to OLSON IDs. These IDs provide not only the information as to the offset from GMT (UTC), but also daylight saving time information. Thus, for example, America/Phoenix is distinct from America/Denver because they have different daylight saving time behavior. This value is not localized.

See:
    Time Values
    Olson ID Comparison
UnitOfMeasurementDetails UnitOfMeasurementDetailsType
(repeatable)		 Conditionally Suggested text to use when specifying units of measure in custom Item Specifics.
UnitOfMeasurementDetails
  .UnitOfMeasurement 		UnitOfMeasurementType
(repeatable)		 Conditionally Contains a suggested unit of measure name plus one or more synonyms.
UnitOfMeasurementDetails
  .UnitOfMeasurement
  .AlternateText 		string
(repeatable)		 Conditionally A synonym for the unit of measure (such as a fully spelled out name like "inches" instead of the standard abbreviation). This can be used to help a seller map unit names they use in their own catalog to unit names that are more popular on eBay.
UnitOfMeasurementDetails
  .UnitOfMeasurement
  .SuggestedText 		string Conditionally The preferred way to specify a given unit of measure name, such as "in." (instead of "inches" or the " (double quote) symbol).
URLDetails URLDetailsType
(repeatable)		 Conditionally Details about a specific eBay URL. GeteBayDetails only returns URLs that are applicable to the site to which you sent the request.
URLDetails.URL anyURI Conditionally A commonly used eBay URL. Applications use some of these URLs (such as the View Item URL) to launch eBay Web site pages in a browser.

Logo URLs are required to be used in certain types of applications. See your API license agreement. Also see this page for logo usage rules:
http://developer.ebay.com/join/licenses/apilogousage
URLDetails.URLType URLTypeCodeType Conditionally A compressed, representative title for the eBay URL.

Applicable values:

•   CustomCode

(out) Reserved for future use.

•   eBayStoreURL

(out) Full URL for eBay Stores.

•   LargeLogoURL

(out) Full URL for the large version of the "An eBay Marketplace" logo.

•   MediumLogoURL

(out) Full URL for the medium version of the "An eBay Marketplace" logo.

•   MyeBayBiddingURL

(out) Full URL for viewing the items on which the user is bidding.

•   MyeBayNotWonURL

(out) Full URL for viewing the items on which the user bid but did not win.

•   MyeBayURL

(out) Full URL for an eBay login page.

•   MyeBayWatchingURL

(out) Full URL for viewing the items the user is currently watching.

•   MyeBayWonURL

(out) Full URL for viewing the items on which the user bid and also won.

•   SmallLogoURL

(out) Full URL for the small version of the "An eBay Marketplace" logo.

•   ViewItemURL

(out) URL Prefix for viewing a particular listing. Just add an item id.

•   ViewUserURL

(out) URL Prefix for viewing the feedback for a particular userid. Just add a userid.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
GeteBayDetails Detail Controls


Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
GeteBayDetails Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GeteBayDetails.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
GeteBayDetails Change History
Version Description
573
2008-07-09
  • ShippingServiceDetails.DeprecationDetails (added): Mechanism by which details about a deprecation of a shipping service is announced.
  • ShippingServiceDetails.DeprecationDetails.AnnouncementStartTime (added): The start date of an announcement about an upcoming event.
  • ShippingServiceDetails.DeprecationDetails.EventTime (added): The date on which the event occurs and also the ending date of the announcement leading up to the event.
  • ShippingServiceDetails.DeprecationDetails.MessageType (added): The type of deprecation message displayed.
  • ShippingServiceDetails.MappedToShippingServiceID (added): The ID of shipping service that will be used instead of a deprecated shipping service.
555
2008-03-05
  • ShippingServiceDetails.CODService (added): Indicates whether the shipping service is a Cash On Delivery shipping service.
537
2007-10-31
  • PaymentOptionDetails.PaymentOption.PaisaPayEscrow, PaymentOptionDetails.PaymentOption.PaisaPayEscrowEMI (added): These values will be returned for items offering PaisaPayEscrow and PaisaPayEscrowEMI payment methods.
523
2007-07-25
  • (doc change) If you use GeteBayDetails in preparation for listing in the US Motors Parts and Accessories categories, use site ID 0 when you call GeteBayDetails.
521
2007-07-11
  • ShippingServiceDetails (added): New elements are returned with ShippingServiceDetails: DimensionsRequired, ServiceType, ShippingPackage, SurchargeApplicable, ValidForSellingFlow.
  • ItemSpecificsDetails, UnitOfMeasurementDetails, (added): Provides information about basic string validation rules and recommended unit of measure identifiers for custom Item Specifics.
499
2007-02-07
  • TimeZoneDetails (added): Provides information about a specific eBay time zone. GeteBayDetails returns all time zones eBay supports.
437
2005-11-30
  • DispatchTimeMaxDetails (added): The call response now includes DispatchTimeMaxDetails, which provides the allowable values for domestic handling time. DispatchTimeMaxDetails is also an allowable value for DetailName in the request.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GeteBayDetails User Notes
User-Contributed Notes
   
 
 
 

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.