GeteBayDetails

Use GeteBayDetails to retrieve the available meta-data for the specified eBay site. By storing the information, you can keep your applications up to date with the latest details. In addition, you can use GeteBayDetails to look up site information instead referring to the documentation or the eBay online help system.

You can also use GeteBayDetails to get the links to the eBay Content Logos, which you might be required to display in your applications per your API License Agreement.

Request Details

Call GeteBayDetails without any input fields to get the complete set of meta-data for the site whose ID you provide in the request header. To retrieve specific site information, use DetailName elements. See GeteBayDetails Best Practices for how to programmatically obtain the supported DetailName input values.

Upon successful execution, GeteBayDetails returns meta-data on the specified DetailName fields. An unsuccessful call returns an error construct. However, if your call results in a warning, the result set will contain normal data along with an error construct outlining the warning.

Best Practices

The following sections list several hints and suggestions for working with GeteBayDetails.

Retrieving eBay Meta-Data Details

If you call GeteBayDetails without supplying a DetailName field, eBay returns the complete set of meta-data for the site specified in the request header. The top-level fields returned in the result set list the possible values you can use with DetailName). This gives you a programmatic way to determine the supported DetailName input values.

Change the site ID header value to view details for different sites. To determine the available site ID values for which you can request GeteBayDetails data, call GeteBayDetails with DetailName set to SiteDetails.

It is recommended that you call GeteBayDetails once per week for each pertinent site ID and store the returned data for ease of lookup.

Other Sources of Meta-data Sets and Specialized Data

In addition to GeteBayDetails, you can use several other methods to get eBay site meta-data:

Optimizing Your Calls

The amount of data returned from a call depends on the listed DetailName values. Call GeteBayDetails without a DetailName value to retrieve all the information available for the specified site, or use DetailName fields to filter the information returned.



Back to top

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 does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?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 Occurrence 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 Optional,
repeatable: [0..*]
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: See DetailName.



Back to top

GeteBayDetails Output

The box below lists all fields that might be returned in the 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 does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?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 -->
  <BuyerRequirementDetails> SiteBuyerRequirementDetailsType 
    <DetailVersion> string </DetailVersion>
    <LinkedPayPalAccount> boolean </LinkedPayPalAccount>
    <MaximumBuyerPolicyViolations> MaximumBuyerPolicyViolationsDetailsType 
      <NumberOfPolicyViolations> NumberOfPolicyViolationsDetailsType 
        <Count> int </Count>
        <!-- ... more Count nodes here ... -->
      </NumberOfPolicyViolations>
      <PolicyViolationDuration> PolicyViolationDurationDetailsType 
        <Description> string </Description>
        <Period> PeriodCodeType </Period>
      </PolicyViolationDuration>
      <!-- ... more PolicyViolationDuration nodes here ... -->
    </MaximumBuyerPolicyViolations>
    <MaximumItemRequirements> MaximumItemRequirementsDetailsType 
      <MaximumItemCount> int </MaximumItemCount>
      <!-- ... more MaximumItemCount nodes here ... -->
      <MinimumFeedbackScore> int </MinimumFeedbackScore>
      <!-- ... more MinimumFeedbackScore nodes here ... -->
    </MaximumItemRequirements>
    <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoDetailsType 
      <MaximumUnpaidItemStrikesCount> MaximumUnpaidItemStrikesCountDetailsType 
        <Count> int </Count>
        <!-- ... more Count nodes here ... -->
      </MaximumUnpaidItemStrikesCount>
      <MaximumUnpaidItemStrikesDuration> MaximumUnpaidItemStrikesDurationDetailsType 
        <Description> string </Description>
        <Period> PeriodCodeType </Period>
      </MaximumUnpaidItemStrikesDuration>
      <!-- ... more MaximumUnpaidItemStrikesDuration nodes here ... -->
    </MaximumUnpaidItemStrikesInfo>
    <MinimumFeedbackScore> MinimumFeedbackScoreDetailsType 
      <FeedbackScore> int </FeedbackScore>
      <!-- ... more FeedbackScore nodes here ... -->
    </MinimumFeedbackScore>
    <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
    <UpdateTime> dateTime </UpdateTime>
    <VerifiedUserRequirements> VerifiedUserRequirementsDetailsType 
      <FeedbackScore> int </FeedbackScore>
      <!-- ... more FeedbackScore nodes here ... -->
      <VerifiedUser> boolean </VerifiedUser>
    </VerifiedUserRequirements>
  </BuyerRequirementDetails>
  <!-- ... more BuyerRequirementDetails nodes here ... -->
  <CountryDetails> CountryDetailsType 
    <Country> CountryCodeType </Country>
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <UpdateTime> dateTime </UpdateTime>
  </CountryDetails>
  <!-- ... more CountryDetails nodes here ... -->
  <CurrencyDetails> CurrencyDetailsType 
    <Currency> CurrencyCodeType </Currency>
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <UpdateTime> dateTime </UpdateTime>
  </CurrencyDetails>
  <!-- ... more CurrencyDetails nodes here ... -->
  <DispatchTimeMaxDetails> DispatchTimeMaxDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <DispatchTimeMax> int </DispatchTimeMax>
    <UpdateTime> dateTime </UpdateTime>
  </DispatchTimeMaxDetails>
  <!-- ... more DispatchTimeMaxDetails nodes here ... -->
  <ExcludeShippingLocationDetails> ExcludeShippingLocationDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <Location> string </Location>
    <Region> string </Region>
    <UpdateTime> dateTime </UpdateTime>
  </ExcludeShippingLocationDetails>
  <!-- ... more ExcludeShippingLocationDetails nodes here ... -->
  <ItemSpecificDetails> ItemSpecificDetailsType 
    <DetailVersion> string </DetailVersion>
    <MaxCharactersPerName> int </MaxCharactersPerName>
    <MaxCharactersPerValue> int </MaxCharactersPerValue>
    <MaxItemSpecificsPerItem> int </MaxItemSpecificsPerItem>
    <MaxValuesPerName> int </MaxValuesPerName>
    <UpdateTime> dateTime </UpdateTime>
  </ItemSpecificDetails>
  <!-- ... more ItemSpecificDetails nodes here ... -->
  <ListingFeatureDetails> ListingFeatureDetailsType 
    <BoldTitle> BoldTitleCodeType </BoldTitle>
    <Border> BorderCodeType </Border>
    <DetailVersion> string </DetailVersion>
    <FeaturedFirst> FeaturedFirstCodeType </FeaturedFirst>
    <FeaturedPlus> FeaturedPlusCodeType </FeaturedPlus>
    <GiftIcon> GiftIconCodeType </GiftIcon>
    <Highlight> HighlightCodeType </Highlight>
    <HomePageFeatured> HomePageFeaturedCodeType </HomePageFeatured>
    <ProPack> ProPackCodeType </ProPack>
    <UpdateTime> dateTime </UpdateTime>
  </ListingFeatureDetails>
  <!-- ... more ListingFeatureDetails nodes here ... -->
  <ListingStartPriceDetails> ListingStartPriceDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <ListingType> ListingTypeCodeType </ListingType>
    <MinBuyItNowPricePercent> float </MinBuyItNowPricePercent>
    <StartPrice> AmountType (double) </StartPrice>
    <UpdateTime> dateTime </UpdateTime>
  </ListingStartPriceDetails>
  <!-- ... more ListingStartPriceDetails nodes here ... -->
  <PaymentOptionDetails> PaymentOptionDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <PaymentOption> BuyerPaymentMethodCodeType </PaymentOption>
    <UpdateTime> dateTime </UpdateTime>
  </PaymentOptionDetails>
  <!-- ... more PaymentOptionDetails nodes here ... -->
  <RegionDetails> RegionDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <RegionID> string </RegionID>
    <UpdateTime> dateTime </UpdateTime>
  </RegionDetails>
  <!-- ... more RegionDetails nodes here ... -->
  <RegionOfOriginDetails> RegionOfOriginDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <RegionOfOrigin> string </RegionOfOrigin>
    <UpdateTime> dateTime </UpdateTime>
  </RegionOfOriginDetails>
  <!-- ... more RegionOfOriginDetails nodes here ... -->
  <ReturnPolicyDetails> ReturnPolicyDetailsType 
    <Description> boolean </Description>
    <DetailVersion> string </DetailVersion>
    <EAN> boolean </EAN>
    <Refund> RefundDetailsType 
      <Description> string </Description>
      <RefundOption> token </RefundOption>
    </Refund>
    <!-- ... more Refund nodes here ... -->
    <ReturnsAccepted> ReturnsAcceptedDetailsType 
      <Description> string </Description>
      <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
    </ReturnsAccepted>
    <!-- ... more ReturnsAccepted nodes here ... -->
    <ReturnsWithin> ReturnsWithinDetailsType 
      <Description> string </Description>
      <ReturnsWithinOption> token </ReturnsWithinOption>
    </ReturnsWithin>
    <!-- ... more ReturnsWithin nodes here ... -->
    <ShippingCostPaidBy> ShippingCostPaidByDetailsType 
      <Description> string </Description>
      <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
    </ShippingCostPaidBy>
    <!-- ... more ShippingCostPaidBy nodes here ... -->
    <UpdateTime> dateTime </UpdateTime>
    <WarrantyDuration> WarrantyDurationDetailsType 
      <Description> string </Description>
      <WarrantyDurationOption> token </WarrantyDurationOption>
    </WarrantyDuration>
    <!-- ... more WarrantyDuration nodes here ... -->
    <WarrantyOffered> WarrantyOfferedDetailsType 
      <Description> string </Description>
      <WarrantyOfferedOption> token </WarrantyOfferedOption>
    </WarrantyOffered>
    <!-- ... more WarrantyOffered nodes here ... -->
    <WarrantyType> WarrantyTypeDetailsType 
      <Description> string </Description>
      <WarrantyTypeOption> token </WarrantyTypeOption>
    </WarrantyType>
    <!-- ... more WarrantyType nodes here ... -->
  </ReturnPolicyDetails>
  <ShippingCarrierDetails> ShippingCarrierDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <ShippingCarrier> ShippingCarrierCodeType </ShippingCarrier>
    <ShippingCarrierID> int </ShippingCarrierID>
    <UpdateTime> dateTime </UpdateTime>
  </ShippingCarrierDetails>
  <!-- ... more ShippingCarrierDetails nodes here ... -->
  <ShippingLocationDetails> ShippingLocationDetailsType 
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <ShippingLocation> string </ShippingLocation>
    <UpdateTime> dateTime </UpdateTime>
  </ShippingLocationDetails>
  <!-- ... more ShippingLocationDetails nodes here ... -->
  <ShippingPackageDetails> ShippingPackageDetailsType 
    <DefaultValue> boolean </DefaultValue>
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <DimensionsSupported> boolean </DimensionsSupported>
    <PackageID> int </PackageID>
    <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
    <UpdateTime> dateTime </UpdateTime>
  </ShippingPackageDetails>
  <!-- ... more ShippingPackageDetails nodes here ... -->
  <ShippingServiceDetails> ShippingServiceDetailsType 
    <CODService> boolean </CODService>
    <CostGroupFlat> token </CostGroupFlat>
    <DeprecationDetails> AnnouncementMessageType 
      <AnnouncementStartTime> dateTime </AnnouncementStartTime>
      <EventTime> dateTime </EventTime>
      <MessageType> AnnouncementMessageCodeType </MessageType>
    </DeprecationDetails>
    <!-- ... more DeprecationDetails nodes here ... -->
    <Description> string </Description>
    <DetailVersion> string </DetailVersion>
    <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>
    <ShippingServicePackageDetails> ShippingServicePackageDetailsType 
      <DimensionsRequired> boolean </DimensionsRequired>
      <Name> ShippingPackageCodeType </Name>
    </ShippingServicePackageDetails>
    <!-- ... more ShippingServicePackageDetails nodes here ... -->
    <ShippingTimeMax> int </ShippingTimeMax>
    <ShippingTimeMin> int </ShippingTimeMin>
    <SurchargeApplicable> boolean </SurchargeApplicable>
    <UpdateTime> dateTime </UpdateTime>
    <ValidForSellingFlow> boolean </ValidForSellingFlow>
    <WeightRequired> boolean </WeightRequired>
  </ShippingServiceDetails>
  <!-- ... more ShippingServiceDetails nodes here ... -->
  <SiteDetails> SiteDetailsType 
    <DetailVersion> string </DetailVersion>
    <Site> SiteCodeType </Site>
    <SiteID> int </SiteID>
    <UpdateTime> dateTime </UpdateTime>
  </SiteDetails>
  <!-- ... more SiteDetails nodes here ... -->
  <TaxJurisdiction> TaxJurisdictionType 
    <DetailVersion> string </DetailVersion>
    <JurisdictionID> string </JurisdictionID>
    <JurisdictionName> string </JurisdictionName>
    <UpdateTime> dateTime </UpdateTime>
  </TaxJurisdiction>
  <!-- ... more TaxJurisdiction nodes here ... -->
  <TimeZoneDetails> TimeZoneDetailsType 
    <DaylightSavingsInEffect> boolean </DaylightSavingsInEffect>
    <DaylightSavingsLabel> string </DaylightSavingsLabel>
    <DaylightSavingsOffset> string </DaylightSavingsOffset>
    <DetailVersion> string </DetailVersion>
    <StandardLabel> string </StandardLabel>
    <StandardOffset> string </StandardOffset>
    <TimeZoneID> string </TimeZoneID>
    <UpdateTime> dateTime </UpdateTime>
  </TimeZoneDetails>
  <!-- ... more TimeZoneDetails nodes here ... -->
  <UnitOfMeasurementDetails> UnitOfMeasurementDetailsType 
    <DetailVersion> string </DetailVersion>
    <UnitOfMeasurement> UnitOfMeasurementType 
      <AlternateText> string </AlternateText>
      <!-- ... more AlternateText nodes here ... -->
      <SuggestedText> string </SuggestedText>
    </UnitOfMeasurement>
    <!-- ... more UnitOfMeasurement nodes here ... -->
    <UpdateTime> dateTime </UpdateTime>
  </UnitOfMeasurementDetails>
  <!-- ... more UnitOfMeasurementDetails nodes here ... -->
  <UpdateTime> dateTime </UpdateTime>
  <URLDetails> URLDetailsType 
    <DetailVersion> string </DetailVersion>
    <UpdateTime> dateTime </UpdateTime>
    <URL> anyURI </URL>
    <URLType> URLTypeCodeType </URLType>
  </URLDetails>
  <!-- ... more URLDetails nodes here ... -->
  <VariationDetails> VariationDetailsType 
    <DetailVersion> string </DetailVersion>
    <MaxNamesPerVariationSpecificsSet> int </MaxNamesPerVariationSpecificsSet>
    <MaxValuesPerVariationSpecificsSetName> int </MaxValuesPerVariationSpecificsSetName>
    <MaxVariationsPerItem> int </MaxVariationsPerItem>
    <UpdateTime> dateTime </UpdateTime>
  </VariationDetails>
</GeteBayDetailsResponse>
Return Value Type Occurrence 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 Conditionally,
repeatable: [0..*]
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. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
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
BuyerRequirementDetails SiteBuyerRequirementDetailsType Conditionally,
repeatable: [0..*]
Details various eBay-buyer requirements.
BuyerRequirementDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
BuyerRequirementDetails
  .LinkedPayPalAccount
boolean Conditionally If true, it specifies that the site's buyer requirements support PayPal.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
MaximumBuyerPolicyViolationsDetailsType Conditionally If provided, blocks bidders who have received the maximum allowed buyer policy violation reports (in a specific time period) from bidding on this item.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .NumberOfPolicyViolations
NumberOfPolicyViolationsDetailsType Conditionally [Selling] The number of policy violation that can be used to limit buyers at the site.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .NumberOfPolicyViolations
  .Count
int Conditionally,
repeatable: [0..*]
[Selling] Maximum allowed buyer policy violation reports against a buyer. If the limit has been reached reached, the buyer can not bid on this item.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .PolicyViolationDuration
PolicyViolationDurationDetailsType Conditionally,
repeatable: [0..*]
[Selling] The policy violation duration(s) supported by the site.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .PolicyViolationDuration
  .Description
string Conditionally [Selling] The description of the Period, such as 'Last Month', 'Second Quarter', 'First Half or the Year'. This field is often used as a label for displaying Period data.
BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .PolicyViolationDuration
  .Period
PeriodCodeType Conditionally [Selling] The Period is the number of days (last 60 days, last 180 days, etc.) within which the buyer violation reports are calculated.

Applicable values:

•   CustomCode

 

•   Days_1

 

•   Days_30

 

•   Days_180

 

•   Days_360

 

•   Days_540

 


BuyerRequirementDetails
  .MaximumItemRequirements
MaximumItemRequirementsDetailsType Conditionally If this field is included in your call, you can limit unpaying or low feedback bidders, by setting the MaximumItemCount and MinimumFeedbackScore to define when a bidder is blocked from bidding.
BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditionally,
repeatable: [0..*]
[Selling] The maximum mumber of items allowed for this buyer.
BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore
int Conditionally,
repeatable: [0..*]
[Selling] The minimum feedback required for a buyer who wants to purchase this item..
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
MaximumUnpaidItemStrikesInfoDetailsType Conditionally If provided, you can specify a maximum number of unpaid items that will result in blocking bidders who have received the maximum unpaid item strikes (in a specific time period) from bidding on this item.
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .MaximumUnpaidItemStrikesCount
MaximumUnpaidItemStrikesCountDetailsType Conditionally [Selling] The number of the maximum unpaid item strikes.
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .MaximumUnpaidItemStrikesCount
  .Count
int Conditionally,
repeatable: [0..*]
[Selling] Number of allowed unpaid item strikes against the buyer.
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .MaximumUnpaidItemStrikesDuration
MaximumUnpaidItemStrikesDurationDetailsType Conditionally,
repeatable: [0..*]
[Selling] Range of time used to determine maximum unpaid item count.
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .MaximumUnpaidItemStrikesDuration
  .Description
string Conditionally [Selling] The description of the period, such as 'month', 'quarter', or 'half a year'. The data in this field can be used as a label in your application's display.
BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .MaximumUnpaidItemStrikesDuration
  .Period
PeriodCodeType Conditionally [Selling] The period is the number of days (last 60 days, last 180 days, etc.) during which the buyer's unpaid item strikes are calculated.

Applicable values:

•   CustomCode

 

•   Days_1

 

•   Days_30

 

•   Days_180

 

•   Days_360

 

•   Days_540

 


BuyerRequirementDetails
  .MinimumFeedbackScore
MinimumFeedbackScoreDetailsType Conditionally Specifies the valid values for blocking bidders with this feedback score or lower.
BuyerRequirementDetails
  .MinimumFeedbackScore
  .FeedbackScore
int Conditionally,
repeatable: [0..*]
[Selling] The values supported for the minimum feedback score restriction.
BuyerRequirementDetails
  .ShipToRegistrationCountry
boolean Conditionally if true, it specifies if the sites buyer requirements supports ShipToRegistrationCountry.
BuyerRequirementDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
BuyerRequirementDetails
  .VerifiedUserRequirements
VerifiedUserRequirementsDetailsType Conditionally Specifies the valid values for limiting unverified bidders.
BuyerRequirementDetails
  .VerifiedUserRequirements
  .FeedbackScore
int Conditionally,
repeatable: [0..*]
[Selling] The values supported for the minimum feedback score for verified users.
BuyerRequirementDetails
  .VerifiedUserRequirements
  .VerifiedUser
boolean Conditionally [Selling] if true, it specifies that the site's buyer requirements support VerifiedUserRequirements.
CountryDetails CountryDetailsType Conditionally,
repeatable: [0..*]
Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in 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).
CountryDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
CountryDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
CurrencyDetails CurrencyDetailsType Conditionally,
repeatable: [0..*]
Lists the currencies supported by the eBay system, regardless of the site specified in 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.
CurrencyDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
CurrencyDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
DispatchTimeMaxDetails DispatchTimeMaxDetailsType Conditionally,
repeatable: [0..*]
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.
DispatchTimeMaxDetails
  .Description
string Conditionally Value and unit (e.g., 10 Days) for the maximum dispatch time. Useful for display purposes.
DispatchTimeMaxDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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
DispatchTimeMaxDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ExcludeShippingLocationDetails ExcludeShippingLocationDetailsType Conditionally,
repeatable: [0..*]
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.
The codes reflect the ISO 3166 location codes.
ExcludeShippingLocationDetails
  .Description
string Conditionally The localized location name.
ExcludeShippingLocationDetails
  .DetailVersion
string Conditionally Returns the current version number of the ExcludeShippingLocation data. Use the version number to determine if you need to refresh your cached client data.
ExcludeShippingLocationDetails
  .Location
string Conditionally The location or region code to be used with the AddItem family of calls. These codes are also returned by GetItem. This code reflects the ISO 3166 codes.
ExcludeShippingLocationDetails
  .Region
string Conditionally The region code to which the location belongs.
ExcludeShippingLocationDetails
  .UpdateTime
dateTime Conditionally The time in GMT that the feature flags for the details were last updated. Use this timestamp to determine if you need to refresh your cached client data.
ItemSpecificDetails ItemSpecificDetailsType Conditionally,
repeatable: [0..*]
The site's validation rules (e.g., string lengths) for custom Item Specifics.
ItemSpecificDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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
ItemSpecificDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ListingFeatureDetails ListingFeatureDetailsType Conditionally,
repeatable: [0..*]
Details the listing features available for the site specified in the request.
ListingFeatureDetails
  .BoldTitle
BoldTitleCodeType Conditionally Defines the availability of the BoldTitle feature for the site.

Applicable values:

•   CustomCode

(out) Reserved for future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.


ListingFeatureDetails.Border BorderCodeType Conditionally Defines the availability of the Border feature for the site.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.


ListingFeatureDetails
  .DetailVersion
string Always Returns the current version of details.
ListingFeatureDetails
  .FeaturedFirst
FeaturedFirstCodeType Conditionally Defines the availability of FeaturedFirst for the site, including whether it is only available for certain seller groups such as PowerSeller or TopRatedSeller.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.

•   PowerSellerOnly

(out) The listing feature is restricted to PowerSellers.

•   TopRatedSellerOnly

(out) The listing feature is restricted to TopRatedSellers.


ListingFeatureDetails
  .FeaturedPlus
FeaturedPlusCodeType Conditionally Defines the availability of FeaturedPlus for site, including whether it is only available for certain seller groups such as PowerSeller or TopRatedSeller.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.

•   PowerSellerOnly

(out) The listing feature is restricted to PowerSellers.

•   TopRatedSellerOnly

(out) The listing feature is restricted to TopRatedSellers.


ListingFeatureDetails.GiftIcon GiftIconCodeType Conditionally Defines the availability of the Gift Icon feature for the site.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.


ListingFeatureDetails
  .Highlight
HighlightCodeType Conditionally Defines the availability of the Highlight feature for the site.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.


ListingFeatureDetails
  .HomePageFeatured
HomePageFeaturedCodeType Conditionally Defines the availability of the HomePageFeatured feature for the site.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.


ListingFeatureDetails.ProPack ProPackCodeType Conditionally Defines the availability of ProPack for the site, including whether it is only available for certain seller groups such as PowerSeller or TopRatedSeller.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Disabled

(out) The listing feature is disabled for the site.

•   Enabled

(out) The listing feature is enabled for the site.

•   PowerSellerOnly

(out) The listing feature is restricted to PowerSellers.

•   TopRatedSellerOnly

(out) The listing feature is restricted to TopRatedSellers.


ListingFeatureDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated.
ListingStartPriceDetails ListingStartPriceDetailsType Conditionally,
repeatable: [0..*]
Lists the minimum starting prices for the supported types of eBay listings.
ListingStartPriceDetails
  .Description
string Conditionally The lowest (beginning) price that can be associated with an item for each type of eBay listing.
ListingStartPriceDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
ListingStartPriceDetails
  .ListingType
ListingTypeCodeType Conditionally Type of eBay listing, such as 'Chinese', 'AdType', 'StoresFixedPrice', 'FixedPriceItem', and others.

Applicable values:

•   AdType

(in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.

•   Auction

(in/out) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions (Chinese).

•   Chinese

(in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Dutch

Deprecated as of version 611.
(in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.

Deprecation version: 611. See also Deprecated Objects.

•   Express

Deprecated as of version 561.
(in/out) For Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be an Express Germany seller to use this format. See "Express Format Criteria" in the eBay Web Services guide. As of late April 2008, this value will no longer work, regardless of the API version you are using.
Deprecation version: 561. See also Deprecated Objects.

•   FixedPriceItem

(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information.

•   Half

(in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format.

•   LeadGeneration

(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

•   Live

Deprecated as of version 601.
(out) Live auction, on-site auction that can include non-eBay bidders. (Use AddLiveAuctionItem to list live auctions.) Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category.
Deprecation version: 601. See also Deprecated Objects.

•   PersonalOffer

(out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.

•   StoresFixedPrice

(in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information.

•   Unknown

(out) Unknown or undefined auction type. Applicable to user preferences and other informational use cases.


ListingStartPriceDetails
  .MinBuyItNowPricePercent
float Conditionally Coming soon. This feature will not be active until the 2009 SR2 release. Minimum percentage difference value between start price and the Buy It Now price for a listing, defined in the site parameters. In the Motors site, requirements for Motors Vehicles are different from those for Parts and Accessories, and the category details are needed to get the percentage requirements for the Motors site.
ListingStartPriceDetails
  .StartPrice
AmountType (double) Conditionally StartPrice for a specific listing type.
ListingStartPriceDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
PaymentOptionDetails PaymentOptionDetailsType Conditionally,
repeatable: [0..*]
The values returned in this field detail different payment options.
This feature is no longer in use. If you need valid payment option information, use GetCategoryFeatures instead.
PaymentOptionDetails
  .Description
string Conditionally Full name of the payment method for display purposes.
PaymentOptionDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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.
PaymentOptionDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
RegionDetails RegionDetailsType Conditionally,
repeatable: [0..*]
No longer returned.
RegionDetails.Description string Conditionally Full name of the region.
RegionDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
RegionDetails.RegionID string Conditionally Numeric identifier for a region within a country.
RegionDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
RegionOfOriginDetails RegionOfOriginDetailsType Conditionally,
repeatable: [0..*]
No longer returned.
RegionOfOriginDetails
  .Description
string Conditionally Full name of the region.
RegionOfOriginDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
RegionOfOriginDetails
  .RegionOfOrigin
string Conditionally Numeric identifier for a region within a country. Permissible values are as in ShippingRegionCodeList.xsd and CountryCodeList.xsd
RegionOfOriginDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ReturnPolicyDetails ReturnPolicyDetailsType Conditionally Lists the return policies supported by the eBay site specified in the request.
ReturnPolicyDetails
  .Description
boolean Conditionally If true, the site supports a text description of the seller's return policy.
ReturnPolicyDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
ReturnPolicyDetails.EAN boolean Conditionally If true, the site supports specifying a European Article Number (EAN) with the return policy.
ReturnPolicyDetails.Refund RefundDetailsType Conditionally,
repeatable: [0..*]
How the seller will compensate the buyer for a returned item (such as money back or exchange).
ReturnPolicyDetails.Refund
  .Description
string Conditionally Display string that applications can use to present RefundOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use RefundOption instead.)
ReturnPolicyDetails.Refund
  .RefundOption
token Conditionally How the seller will compensate the buyer for a returned item.

Applicable values: See RefundOptionsCodeType
ReturnPolicyDetails
  .ReturnsAccepted
ReturnsAcceptedDetailsType Conditionally,
repeatable: [0..*]
Whether the seller allows the buyer to return the item.
ReturnPolicyDetails
  .ReturnsAccepted.Description
string Conditionally Display string that applications can use to present ReturnsAcceptedOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.)
ReturnPolicyDetails
  .ReturnsAccepted
  .ReturnsAcceptedOption
token Conditionally Whether the seller allows the buyer to return the item. This value can be passed in the AddItem family of calls.

Applicable values: See ReturnsAcceptedOptionsCodeType
ReturnPolicyDetails
  .ReturnsWithin
ReturnsWithinDetailsType Conditionally,
repeatable: [0..*]
Time period within which the buyer can return the item, starting from the day they receive the item.
ReturnPolicyDetails
  .ReturnsWithin.Description
string Conditionally Display string that applications can use to present ReturnsWithinOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.)
ReturnPolicyDetails
  .ReturnsWithin
  .ReturnsWithinOption
token Conditionally The buyer can return the item within this period of time from the day they receive the item. This value can be passed in the AddItem family of calls.

Applicable values: See ReturnsWithinOptionsCodeType
ReturnPolicyDetails
  .ShippingCostPaidBy
ShippingCostPaidByDetailsType Conditionally,
repeatable: [0..*]
The party who pays the shipping cost for a returned item.
ReturnPolicyDetails
  .ShippingCostPaidBy
  .Description
string Conditionally Display string that applications can use to present ShippingCostPaidByOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.)
ReturnPolicyDetails
  .ShippingCostPaidBy
  .ShippingCostPaidByOption
token Conditionally The party who pays the shipping cost for a returned item. This value can be passed in the AddItem family of calls.

Applicable values: See ShippingCostPaidByOptionsCodeType
ReturnPolicyDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ReturnPolicyDetails
  .WarrantyDuration
WarrantyDurationDetailsType Conditionally,
repeatable: [0..*]
The length of the warranty offered.
ReturnPolicyDetails
  .WarrantyDuration.Description
string Conditionally Display string that applications can use to present WarrantyDurationOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.)
ReturnPolicyDetails
  .WarrantyDuration
  .WarrantyDurationOption
token Conditionally The warranty period. This value can be passed in the AddItem family of calls.

Applicable values: See WarrantyDurationOptionsCodeType
ReturnPolicyDetails
  .WarrantyOffered
WarrantyOfferedDetailsType Conditionally,
repeatable: [0..*]
Whether the item includes a warranty.
ReturnPolicyDetails
  .WarrantyOffered.Description
string Conditionally Display string that applications can use to present WarrantyOfferedOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.)
ReturnPolicyDetails
  .WarrantyOffered
  .WarrantyOfferedOption
token Conditionally Whether the item includes a warranty. This value can be passed in the AddItem family of calls.

Applicable values: See WarrantyOfferedCodeType
ReturnPolicyDetails
  .WarrantyType
WarrantyTypeDetailsType Conditionally,
repeatable: [0..*]
The type of warranty offered.
ReturnPolicyDetails
  .WarrantyType.Description
string Conditionally Display string that applications can use to present WarrantyTypeOption in a more user-friendly format (such as in a drop-down list). Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.)
ReturnPolicyDetails
  .WarrantyType
  .WarrantyTypeOption
token Conditionally The source or type of the warranty. This value can be passed in the AddItem family of calls.

Applicable values: See WarrantyTypeOptionsCodeType
ShippingCarrierDetails ShippingCarrierDetailsType Conditionally,
repeatable: [0..*]
Lists the shipping carriers supported by the specified site.
ShippingCarrierDetails
  .Description
string Conditionally Full name of the shipping Carrier for display purposes.
ShippingCarrierDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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

•   Nacex

(out) Nacex

•   Other

(out) Other postal service

•   Seur

(out) Seur (reserved for future use)

•   UPS

(out) United Parcel Service.

•   USPS

(out) U.S. Postal Service.


ShippingCarrierDetails
  .ShippingCarrierID
int Conditionally Numeric identifier. Some applications use this ID to look up shipping Carriers more efficiently.
ShippingCarrierDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ShippingLocationDetails ShippingLocationDetailsType Conditionally,
repeatable: [0..*]
Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request.
ShippingLocationDetails
  .Description
string Conditionally Display name of region or location (sometimes more descriptive than the ShippingLocation short name).
ShippingLocationDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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
ShippingLocationDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ShippingPackageDetails ShippingPackageDetailsType Conditionally,
repeatable: [0..*]
Lists the various shipping packages supported by the specified site.
ShippingPackageDetails
  .DefaultValue
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
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
ShippingPackageDetails
  .DimensionsSupported
boolean Conditionally This is a characteristic of a type of package. There is no connection between it and individual shipping services. (Compare with ShippingServicePackageDetails.DimensionsRequired.) DimensionsSupported is true if dimensions are required for this package type for at least one shipping service on the specified eBay site. If not returned, DimensionsSupported is false.
Default: false.
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.
ShippingPackageDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ShippingServiceDetails ShippingServiceDetailsType Conditionally,
repeatable: [0..*]
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.
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
  .CostGroupFlat
token Conditionally If returned, this is the shipping service group to which the shipping service belongs. Valid values are found in CostGroupFlatCodeType.

Applicable values: See CostGroupFlatCodeType
ShippingServiceDetails
  .DeprecationDetails
AnnouncementMessageType Conditionally,
repeatable: [0..*]
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
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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 Conditionally,
repeatable: [0..*]
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 Conditionally,
repeatable: [0..*]
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

•   Nacex

(out) Nacex

•   Other

(out) Other postal service

•   Seur

(out) Seur (reserved for future use)

•   UPS

(out) United Parcel Service.

•   USPS

(out) U.S. Postal Service.


ShippingServiceDetails
  .ShippingPackage
ShippingPackageCodeType Conditionally,
repeatable: [0..*]
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

Applicable values: See ShippingServiceCodeType
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
  .ShippingServicePackageDetails
ShippingServicePackageDetailsType Conditionally,
repeatable: [0..*]
Shipping Package level details for the enclosing shipping service, this complex type replaces the existing ShippingPackage type.
ShippingServiceDetails
  .ShippingServicePackageDetails
  .DimensionsRequired
boolean Conditionally This is a characteristic of a package type in the context of a particular shipping service. If true, dimensions are required when this particular package type is assigned to the listing and the seller offers this particular shipping service. If not returned, DimensionsSupported is false.
Default: false.
ShippingServiceDetails
  .ShippingServicePackageDetails
  .Name
ShippingPackageCodeType Conditionally The name of the package type.

Applicable values: See Name.
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
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
ShippingServiceDetails
  .ValidForSellingFlow
boolean Conditionally True if the shipping service is valid for the Sell Your Item flow.
ShippingServiceDetails
  .WeightRequired
boolean Conditionally If true, a seller who selects this package type for the listing and then offers this shipping service must specify WeightMajor and WeightMinor in the item definition. If not returned, WeightRequired is false.
Default: false.
SiteDetails SiteDetailsType Conditionally,
repeatable: [0..*]
Lists all available eBay sites and their associated SiteID numbers.
SiteDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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 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.
SiteDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
TaxJurisdiction TaxJurisdictionType Conditionally,
repeatable: [0..*]
Details the different tax jurisdictions or tax regions applicable to the site specified in the request.

Related fields:
TaxTable.TaxJurisdiction in SetTaxTable
Item.UseTaxTable in Additem
TaxJurisdiction.DetailVersion string Conditionally Returns the latest version number for this feature. Use the version to determine if and when to refresh your cached client data.
TaxJurisdiction.JurisdictionID string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).
TaxJurisdiction
  .JurisdictionName
string Conditionally Full name for the jurisdiction or region for display purposes.
TaxJurisdiction.UpdateTime dateTime Conditionally The time in GMT when the details for this feature were last updated. Use this timestamp to determine if and when to refresh your cached client data.
TimeZoneDetails TimeZoneDetailsType Conditionally,
repeatable: [0..*]
Lists the details of the time zones supported by the eBay system.
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.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
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

TimeZoneDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
UnitOfMeasurementDetails UnitOfMeasurementDetailsType Conditionally,
repeatable: [0..*]
Lists the suggested unit-of-measurement strings to use with Item Specifics descriptions.
UnitOfMeasurementDetails
  .DetailVersion
string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UnitOfMeasurementDetails
  .UnitOfMeasurement
UnitOfMeasurementType Conditionally,
repeatable: [0..*]
Contains a suggested unit of measure name plus one or more synonyms.
UnitOfMeasurementDetails
  .UnitOfMeasurement
  .AlternateText
string Conditionally,
repeatable: [0..*]
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).
UnitOfMeasurementDetails
  .UpdateTime
dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
UpdateTime dateTime Always Time in GMT of the most recent modification to any feature detail. If specific feature details are passed in the request, gives most recent modification time of the passed feature details.
URLDetails URLDetailsType Conditionally,
repeatable: [0..*]
Lists eBay URLs that are applicable to the site specified in the request.
URLDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
URLDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.
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.


VariationDetails VariationDetailsType Conditionally 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.

See:
    GetCategoryFeatures
    GetCategorySpecifics

VariationDetails.DetailVersion string Always Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
VariationDetails
  .MaxNamesPerVariationSpecificsSet
int Conditionally The maximum number of variation specific names allowed per listing (i.e., within VariationSpecificsSet).
VariationDetails
  .MaxValuesPerVariationSpecificsSetName
int Conditionally The maximum number of values allowed per listing (i.e., within VariationSpecificsSet).
VariationDetails
  .MaxVariationsPerItem
int Conditionally The maximum number of variations the site allows within a multi-variation listing.
VariationDetails.UpdateTime dateTime Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.



Back to top

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

GeteBayDetails Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

Sample: Basic Call

Retrieves the current set of meta-data for all eBay sites.

Description

The basic call uses no input fields and returns the complete set of eBay meta-data for all sites. If you want to retrieve specific sets of meta-data, use the major headings in the response as values for the field.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GeteBayDetailsRequest>

Output

XML format. Also available is the .txt version of this XML.

<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-08-03T23:44:49.974Z</Timestamp>
  <Ack>Success</Ack>
  <Version>627</Version>
  <Build>E627_CORE_BUNDLED_9778114_R1</Build>
  <CountryDetails>
    <Country>AL</Country>
    <Description>Albania</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:51:09.000Z</UpdateTime>
  </CountryDetails>
  <CountryDetails>
    <Country>DZ</Country>
    <Description>Algeria</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:51:09.000Z</UpdateTime>
  </CountryDetails>

...

  <CurrencyDetails>
    <Currency>USD</Currency>
    <Description>US Dollar</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </CurrencyDetails>
  <CurrencyDetails>
    <Currency>CAD</Currency>
    <Description>Canadian Dollar</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </CurrencyDetails>

...

  <DispatchTimeMaxDetails>
    <DispatchTimeMax>0</DispatchTimeMax>
    <Description>0 Days</Description>
    <DetailVersion>3</DetailVersion>
    <UpdateTime>2009-07-13T19:29:00.000Z</UpdateTime>
  </DispatchTimeMaxDetails>
  <DispatchTimeMaxDetails>
    <DispatchTimeMax>1</DispatchTimeMax>
    <Description>1 Day</Description>
    <DetailVersion>3</DetailVersion>
    <UpdateTime>2009-07-13T19:29:00.000Z</UpdateTime>
  </DispatchTimeMaxDetails>

...

  <PaymentOptionDetails>
    <PaymentOption>MOCC</PaymentOption>
    <Description>Money Order or Cashier's Check</Description>
    <DetailVersion>2</DetailVersion>
    <UpdateTime>2009-07-01T23:44:14.000Z</UpdateTime>
  </PaymentOptionDetails>
  <PaymentOptionDetails>
    <PaymentOption>PersonalCheck</PaymentOption>
    <Description>Personal Check</Description>
    <DetailVersion>2</DetailVersion>
    <UpdateTime>2009-07-01T23:44:14.000Z</UpdateTime>
  </PaymentOptionDetails>

...

  <RegionDetails>
    <RegionID>39</RegionID>
    <Description>AZ-Phoenix</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </RegionDetails>
  <RegionDetails>
    <RegionID>1</RegionID>
    <Description>CA-Los Angeles</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </RegionDetails>

...

  <ShippingLocationDetails>
    <ShippingLocation>Americas</ShippingLocation>
    <Description>N. and S. America</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:16:56.000Z</UpdateTime>
  </ShippingLocationDetails>
  <ShippingLocationDetails>
    <ShippingLocation>Asia</ShippingLocation>
    <Description>Asia</Description>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:16:56.000Z</UpdateTime>
  </ShippingLocationDetails>

...

  <ShippingServiceDetails>
    <Description>USPS Global Express Mail</Description>
    <InternationalService>true</InternationalService>
    <ShippingService>USPSGlobalExpress</ShippingService>
    <ShippingServiceID>50003</ShippingServiceID>
    <ShippingTimeMax>5</ShippingTimeMax>
    <ShippingTimeMin>3</ShippingTimeMin>
    <ServiceType>Flat</ServiceType>
    <ServiceType>Calculated</ServiceType>
    <ShippingPackage>Letter</ShippingPackage>
    <ShippingPackage>LargeEnvelope</ShippingPackage>
    <ShippingPackage>PackageThickEnvelope</ShippingPackage>
    <ShippingCarrier>USPS</ShippingCarrier>
    <ShippingServicePackageDetails>
      <Name>Letter</Name>
    </ShippingServicePackageDetails>
    <ShippingServicePackageDetails>
      <Name>LargeEnvelope</Name>
    </ShippingServicePackageDetails>
    <ShippingServicePackageDetails>
      <Name>PackageThickEnvelope</Name>
    </ShippingServicePackageDetails>
    <WeightRequired>true</WeightRequired>
    <DetailVersion>9</DetailVersion>
    <UpdateTime>2009-07-16T06:44:11.000Z</UpdateTime>
  </ShippingServiceDetails>

...

  <SiteDetails>
    <Site>US</Site>
    <SiteID>0</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Canada</Site>
    <SiteID>2</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>

...

  <TaxJurisdiction>
    <JurisdictionID>WY</JurisdictionID>
    <JurisdictionName>Wyoming</JurisdictionName>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:16:56.000Z</UpdateTime>
  </TaxJurisdiction>
  <TaxJurisdiction>
    <JurisdictionID>WI</JurisdictionID>
    <JurisdictionName>Wisconsin</JurisdictionName>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:16:56.000Z</UpdateTime>
  </TaxJurisdiction>

...

  <URLDetails>
    <URLType>ViewItemURL</URLType>
    <URL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&amp;item=</URL>
    <DetailVersion>2</DetailVersion>
    <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
  </URLDetails>
  <URLDetails>
    <URLType>ViewUserURL</URLType>
    <URL>http://feedback.sandbox.ebay.com/ws/eBayISAPI.dll?ViewFeedback&amp;userid=</URL>
    <DetailVersion>2</DetailVersion>
    <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
  </URLDetails>

...

  <TimeZoneDetails>
    <TimeZoneID>MIT</TimeZoneID>
    <StandardLabel>West Samoa Time</StandardLabel>
    <StandardOffset>-11:00</StandardOffset>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:57.000Z</UpdateTime>
  </TimeZoneDetails>

...

<TimeZoneDetails>
    <TimeZoneID>Europe/Dublin</TimeZoneID>
    <StandardLabel>Greenwich Mean Time (Dublin)</StandardLabel>
    <StandardOffset>+0:00</StandardOffset>
    <DaylightSavingsLabel>Irish Summer Time</DaylightSavingsLabel>
    <DaylightSavingsOffset>+1:00</DaylightSavingsOffset>
    <DaylightSavingsInEffect>true</DaylightSavingsInEffect>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:57.000Z</UpdateTime>
  </TimeZoneDetails>

...

  <ItemSpecificDetails>
    <MaxItemSpecificsPerItem>15</MaxItemSpecificsPerItem>
    <MaxValuesPerName>10</MaxValuesPerName>
    <MaxCharactersPerValue>50</MaxCharactersPerValue>
    <MaxCharactersPerName>30</MaxCharactersPerName>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </ItemSpecificDetails>

...

  <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
</GeteBayDetailsResponse>

Back to list of samples

Sample: Shipping Services

Details the shipping services available through eBay.

Description

Returns the shipping services that are currently available through the eBay interface for the specified site.

Input

Specify in the field to return the current list of shipping services supported by the indicated site.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?> 
<GeteBayDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>ABC...123</eBayAuthToken> 
  </RequesterCredentials> 
  <DetailName>ShippingCarrierDetails</DetailName> 
  <DetailName>ShippingServiceDetails</DetailName> 
</GeteBayDetailsRequest> 

Output

The output contains all the shipping services supported by the eBay interface (note the output here has been abbreviated).

If you use any of the supported shipping services, eBay calcualtes the actual cost of shipping the item to the buyer. Although you can use a shipping service not directly offered by eBay, using an eBay-supported shipping service has the benefit of letting users know they are paying the current rate for the item shipping.

XML format. Also available is the .txt version of this XML.

<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-08-04T00:30:19.884Z</Timestamp>
  <Ack>Success</Ack>
  <Version>627</Version>
  <Build>E627_CORE_BUNDLED_9778114_R1</Build>
  <ShippingServiceDetails>
    <Description>USPS Global Express Mail</Description>
    <InternationalService>true</InternationalService>
    <ShippingService>USPSGlobalExpress</ShippingService>
    <ShippingServiceID>50003</ShippingServiceID>
    <ShippingTimeMax>5</ShippingTimeMax>
    <ShippingTimeMin>3</ShippingTimeMin>
    <ServiceType>Flat</ServiceType>
    <ServiceType>Calculated</ServiceType>
    <ShippingPackage>Letter</ShippingPackage>
    <ShippingPackage>LargeEnvelope</ShippingPackage>
    <ShippingPackage>PackageThickEnvelope</ShippingPackage>
    <ShippingCarrier>USPS</ShippingCarrier>
    <ShippingServicePackageDetails>
      <Name>Letter</Name>
    </ShippingServicePackageDetails>
    <ShippingServicePackageDetails>
      <Name>LargeEnvelope</Name>
    </ShippingServicePackageDetails>
    <ShippingServicePackageDetails>
      <Name>PackageThickEnvelope</Name>
    </ShippingServicePackageDetails>
    <WeightRequired>true</WeightRequired>
    <DetailVersion>9</DetailVersion>
    <UpdateTime>2009-07-16T06:44:11.000Z</UpdateTime>
  </ShippingServiceDetails>

...

  <ShippingCarrierDetails>
    <ShippingCarrierID>1</ShippingCarrierID>
    <Description>UPS</Description>
    <ShippingCarrier>UPS</ShippingCarrier>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </ShippingCarrierDetails>
  <ShippingCarrierDetails>
    <ShippingCarrierID>2</ShippingCarrierID>
    <Description>USPS</Description>
    <ShippingCarrier>USPS</ShippingCarrier>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-01T23:43:58.000Z</UpdateTime>
  </ShippingCarrierDetails>
  <UpdateTime>2009-07-16T06:44:11.000Z</UpdateTime>
</GeteBayDetailsResponse>

Back to list of samples

Sample: Site Details

Retrieves the current list of eBay sites and their Site ID values.

Description

Specify SiteDetails for the field--this returns a current list of all eBay sites and thier Site ID values.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <DetailName>SiteDetails</DetailName>
</GeteBayDetailsRequest>

Output

XML format. Also available is the .txt version of this XML.

<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-08-04T00:35:02.218Z</Timestamp>
  <Ack>Success</Ack>
  <Version>627</Version>
  <Build>E627_CORE_BUNDLED_9778114_R1</Build>
  <SiteDetails>
    <Site>US</Site>
    <SiteID>0</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Canada</Site>
    <SiteID>2</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>UK</Site>
    <SiteID>3</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Germany</Site>
    <SiteID>77</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Australia</Site>
    <SiteID>15</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>France</Site>
    <SiteID>71</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>eBayMotors</Site>
    <SiteID>100</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Italy</Site>
    <SiteID>101</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Netherlands</Site>
    <SiteID>146</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Spain</Site>
    <SiteID>186</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>India</Site>
    <SiteID>203</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>HongKong</Site>
    <SiteID>201</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Singapore</Site>
    <SiteID>216</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Malaysia</Site>
    <SiteID>207</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Philippines</Site>
    <SiteID>211</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>CanadaFrench</Site>
    <SiteID>210</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Poland</Site>
    <SiteID>212</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Belgium_Dutch</Site>
    <SiteID>123</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Belgium_French</Site>
    <SiteID>23</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Austria</Site>
    <SiteID>16</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Switzerland</Site>
    <SiteID>193</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <SiteDetails>
    <Site>Ireland</Site>
    <SiteID>205</SiteID>
    <DetailVersion>1</DetailVersion>
    <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
  </SiteDetails>
  <UpdateTime>2009-07-02T00:09:50.000Z</UpdateTime>
</GeteBayDetailsResponse>

Back to list of samples

Sample: Finding the eBay Logo and Other eBay URLs

Returns the current set of eBay URLs, including the URLs where you can find the eBay logos.

Description

As an eBay developer, you are required to display the eBay logo on your eBay web application. You can use this call to determine the URL for the eBay logo.

Input

Set DetailName to URLDetails.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <DetailName>URLDetails</DetailName>
</GeteBayDetailsRequest>

Output

Among other eBay URLs, the response includes the several URLs for eBay logos, with each hosting logos of different sizes.

XML format. Also available is the .txt version of this XML.

<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2009-08-04T00:35:44.523Z</Timestamp>
   <Ack>Success</Ack>
   <Version>627</Version>
   <Build>E627_CORE_BUNDLED_9778114_R1</Build>
   <URLDetails>
      <URLType>ViewItemURL</URLType>
      <URL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&item=</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>ViewUserURL</URLType>
      <URL>http://feedback.sandbox.ebay.com/ws/eBayISAPI.dll?ViewFeedback&userid=</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MyeBayURL</URLType>
      <URL>http://cgi1.sandbox.ebay.com/aw-cgi/eBayISAPI.dll?MyEbayLogin</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MyeBayBiddingURL</URLType>
      <URL>http://cgi1.sandbox.ebay.com/aw-cgi/ebayISAPI.dll?MyEbayItemsBiddingOn#BidOn</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MyeBayNotWonURL</URLType>
      <URL>http://cgi1.sandbox.ebay.com/aw-cgi/ebayISAPI.dll?MyEbayItemsBiddingOn#lost</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MyeBayWonURL</URLType>
      <URL>http://cgi1.sandbox.ebay.com/aw-cgi/ebayISAPI.dll?MyEbayItemsBiddingOn#won</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MyeBayWatchingURL</URLType>
      <URL>http://cgi1.sandbox.ebay.com/aw-cgi/ebayISAPI.dll?MyEbayItemsBiddingOn#watching</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>eBayStoreURL</URLType>
      <URL>http://www.stores.sandbox.ebay.com/</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>SmallLogoURL</URLType>
      <URL>https://securepics.ebaystatic.com/api/ebay_market_108x45.gif</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>MediumLogoURL</URLType>
      <URL>https://securepics.ebaystatic.com/api/ebay_market_144x59.gif</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <URLDetails>
      <URLType>LargeLogoURL</URLType>
      <URL>https://securepics.ebaystatic.com/api/ebay_market_182x76.gif</URL>
      <DetailVersion>2</DetailVersion>
      <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
   </URLDetails>
   <UpdateTime>2009-07-29T00:48:40.000Z</UpdateTime>
</GeteBayDetailsResponse>

Back to list of samples

Sample: Determining the Return Policy

Returns the return-policy options for the site.

Description

Magic Bookseller wants to know the return-policy options for the her item listing.

Input

To review a site's return-policy options, set the field to . Specify the site ID where you are listing your item in the headers.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <DetailName>ReturnPolicyDetails</DetailName>
</GeteBayDetailsRequest>

Output

Because the Site ID is set to 0 in the headers, the response is specific to the eBay US site. The payload returns the return policy options that you can use in your item listings.

XML format. Also available is the .txt version of this XML.

<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2009-08-04T00:29:35.982Z</Timestamp>
   <Ack>Success</Ack>
   <Version>627</Version>
   <Build>E627_CORE_BUNDLED_9778114_R1</Build>
   <ReturnPolicyDetails>
      <Refund>
         <RefundOption>MoneyBack</RefundOption>
         <Description>Money Back</Description>
      </Refund>
      <Refund>
         <RefundOption>Exchange</RefundOption>
         <Description>Exchange</Description>
      </Refund>
      <Refund>
         <RefundOption>MerchandiseCredit</RefundOption>
         <Description>Merchandise Credit</Description>
      </Refund>
      <ReturnsWithin>
         <ReturnsWithinOption>Days_3</ReturnsWithinOption>
         <Description>3 Days</Description>
      </ReturnsWithin>
      <ReturnsWithin>
         <ReturnsWithinOption>Days_7</ReturnsWithinOption>
         <Description>7 Days</Description>
      </ReturnsWithin>
      <ReturnsWithin>
         <ReturnsWithinOption>Days_14</ReturnsWithinOption>
         <Description>14 Days</Description>
      </ReturnsWithin>
      <ReturnsWithin>
         <ReturnsWithinOption>Days_30</ReturnsWithinOption>
         <Description>30 Days</Description>
      </ReturnsWithin>
      <ReturnsWithin>
         <ReturnsWithinOption>Days_60</ReturnsWithinOption>
         <Description>60 Days</Description>
      </ReturnsWithin>
      <ReturnsAccepted>
         <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
         <Description>Returns Accepted</Description>
      </ReturnsAccepted>
      <ReturnsAccepted>
         <ReturnsAcceptedOption>ReturnsNotAccepted</ReturnsAcceptedOption>
         <Description>Returns Not Accepted</Description>
      </ReturnsAccepted>
      <Description>true</Description>
      <ShippingCostPaidBy>
         <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
         <Description>Buyer</Description>
      </ShippingCostPaidBy>
      <ShippingCostPaidBy>
         <ShippingCostPaidByOption>Seller</ShippingCostPaidByOption>
         <Description>Seller</Description>
      </ShippingCostPaidBy>
      <DetailVersion>1</DetailVersion>
      <UpdateTime>2009-07-01T23:43:57.000Z</UpdateTime>
   </ReturnPolicyDetails>
   <UpdateTime>2009-07-01T23:43:57.000Z</UpdateTime>
</GeteBayDetailsResponse>

Back to list of samples



Back to top

GeteBayDetails Change History
Version Description
635
2009-09-16
  • ExcludeShippingLocationDetails (added): Sellers can now exclude specific regions and countries from where they will ship items.
629
2009-08-05
  • VariationDetails (added): Added variation validation rules (such as maximum number of variations allowed for a listing).
623
2009-06-24
  • CountryDetailsType.DetailVersion, CountryDetailsType.UpdateTime, CurrencyDetailsType.DetailVersion, CurrencyDetailsType.UpdateTime, DispatchTimeMaxDetailsType.DetailVersion, DispatchTimeMaxDetailsType.UpdateTime, ItemSpecificDetailsType.DetailVersion, ItemSpecificDetailsType.UpdateTime, ListingStartPriceDetailsType.DetailVersion, ListingStartPriceDetailsType.UpdateTime, PaymentOptionDetailsType.DetailVersion, PaymentOptionDetailsType.UpdateTime, RegionDetailsType.DetailVersion, RegionDetailsType.UpdateTime, RegionOfOriginDetailsType.DetailVersion, RegionOfOriginDetailsType.UpdateTime, ReturnPolicyDetailsType.DetailVersion, ReturnPolicyDetailsType.UpdateTime, ShippingCarrierDetailsType.DetailVersion, ShippingCarrierDetailsType.UpdateTime, ShippingLocationDetailsType.DetailVersion, ShippingLocationDetailsType.UpdateTime, ShippingPackageDetailsType.DetailVersion, ShippingPackageDetailsType.UpdateTime, ShippingServiceDetailsType.DetailVersion, ShippingServiceDetailsType.UpdateTime, SiteBuyerRequirementDetailsType.DetailVersion, SiteBuyerRequirementDetailsType.UpdateTime, SiteDetailsType.DetailVersion, SiteDetailsType.UpdateTime, CurrencyDetailsType.DetailVersion, TaxJurisdictionType.UpdateTime, TaxJurisdictionType.DetailVersion, TimeZoneDetailsType.UpdateTime, TimeZoneDetailsType.DetailVersion, URLDetailsType.UpdateTime, URLDetailsType.DetailVersion, UnitOfMeasurementDetailsType.UpdateTime, and UnitOfMeasurementDetailsType.DetailVersion. (added): UpdateTime and DetailVersion fields added so developer's client cache can be more easily updated.
617
2009-05-13
  • BuyerRequirementDetails (added): Site-specific buyer requirements are now returned in the GeteBayDetails response.
613
2009-04-15
  • DetailName.PaymentOptionDetails (doc change): The DetailName.PaymentOptionDetails value should not be used. Formerly, this value was used for specifying information about a specific payment option. If you want such information, use GetCategoryFeatures.
603
2009-02-04
  • PaymentOptionDetails.PaymentOption.IntegratedMerchantCreditCard (added): This payment method can apply if a seller has a payment gateway account.
601
2009-01-21
  • ListingStartPriceDetails (added): Developers can now retrieve the start price for each eBay listing type.
587
2008-10-15
  • ShippingServiceDetails: ShippingServicePackageDetails (with Name and DimensionsRequired) and WeightRequired (added): See Shipping documentation to learn about these elements related to calculated shipping and package dimensions.
  • ShippingPackageDetailsType: DimensionsSupported (added): See Shipping documentation to learn about these elements related to calculated shipping and package dimensions.
585
2008-10-01
  • ShippingServiceDetails.CostGroupFlat (added): If returned, indicates the name of the shipping service group to which this shipping service belongs.
581
2008-09-03
  • ReturnPolicyDetails (added): Indicates the return policy details that are supported on the specified site.
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.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.