eBay Trading API
Version 1359


complexType "GeteBayDetailsResponseType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Derived By:
Content:
complex, 40 elements, elem. wildcard
Defined:
in ebaySvc.wsdl/Schema
Includes:
declarations of 25 elements
Referenced:
Component Diagram

Content Element Model:
Component
Type / Value
Occurs
Required?
Nillable?
Description
SEQUENCE
1..1
yes
dateTime
0..1
no
no
This value represents the date and time when eBay processed the request. »
 Ack
AckCodeType : enumeration of token
0..1
no
no
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). »
string
0..1
no
no
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »
0..∞
no
no
A list of application-level errors (if any) that occurred when eBay processed the request.
string
0..1
no
no
Supplemental information from eBay, if applicable. »
string
0..1
no
no
The version of the response payload schema. »
string
0..1
no
no
This refers to the specific software build that eBay used when processing the request and generating the response. »
string
0..1
no
no
Event name of the notification. »
0..1
no
no
Information that explains a failure due to a duplicate InvocationID being passed in.
string
0..1
no
no
Recipient user ID of the notification. »
string
0..1
no
no
Unique Identifier of Recipient user ID of the notification. »
string
0..1
no
no
A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay.
string
0..1
no
no
Expiration date of the user's authentication token. »
0..1
no
no
This container is conditionally returned in the PlaceOffer call response if eBay wants to challenge the user making the call to ensure that the call is being made by a real user and not a bot. »
string
0..1
no
no
An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. »
from any namespace
0..∞
no
 CountryDetails
0..∞
no
no
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.
 CurrencyDetails
0..∞
no
no
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.
 DispatchTimeMaxDetails
0..∞
no
no
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.
 PaymentOptionDetails
0..∞
no
no
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.

Note: This container is only returned if PaymentOptionDetails is included as a DetailName filter in the request, or if no DetailName filters are used in the request.
 RegionDetails
0..∞
no
no
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.
 ShippingLocationDetails
0..∞
no
no
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.
 ShippingServiceDetails
0..∞
no
no
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.
 SiteDetails
0..∞
no
no
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.
 TaxJurisdiction
0..∞
no
no
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 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.
 URLDetails
0..∞
no
no
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.
 TimeZoneDetails
0..∞
no
no
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.
 ItemSpecificDetails
0..∞
no
no
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.
 RegionOfOriginDetails
0..∞
no
no
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.
 ShippingPackageDetails
0..∞
no
no
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.
 ShippingCarrierDetails
0..∞
no
no
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.
 ReturnPolicyDetails
0..1
no
no
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. Note: This container has been staged for deprecation. Although domestic return policy metadata is still getting returned at the moment, it is recommended that users start making plans to use the GetCategoryFeatures call instead to retrieve category-level, domestic return policy metadata.
 ListingStartPriceDetails
0..∞
no
no
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.
 BuyerRequirementDetails
0..∞
no
no
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.
 ListingFeatureDetails
0..∞
no
no
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.
 VariationDetails
0..1
no
no
Site-level validation rules for multiple-variation listings (for example, the maximum number of variations per listing). Use GetCategoryFeatures to determine which categories on a site support variations.

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.
 ExcludeShippingLocationDetails
0..∞
no
no
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.

Note: This container is only returned if ExcludeShippingLocationDetails is included as a DetailName filter in the request, or if no DetailName filters are used in the request.
 UpdateTime
dateTime
0..1
no
no
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.
 RecoupmentPolicyDetails
0..∞
no
no
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.
 ShippingCategoryDetails
0..∞
no
no
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.
 ProductDetails
0..1
no
no
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.
Description
Details about a specified site in response to GeteBayDetailsRequest. If no DetailName field is identified in the request, all elements of GeteBayDetailsResponse are returned. Otherwise, eBay returns only the elements corresponding to the specified DetailName fields. UpdateTime gives the time of modification of the most recently modified DetailName.
Referenced By
Type Definition Detail
Type Derivation Tree
AbstractResponseType (extension)
  GeteBayDetailsResponseType


WSDL documentation generated with FlexDoc/XML 1.14 using FlexDoc/XML WSDLDoc 2.0 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.