This guide explains the process of transitioning from the deprecated GeteBayDetails call within the Trading API to the REST Metadata API. eBay is breaking up this single, large-response call into a set of individual REST methods, each returning a smaller, purpose-built response. The relevant metadata is available through methods in the marketplace, shipping:marketplace, and country resources of the Metadata API, letting you retrieve currency, handling time, shipping, minimum listing price, sales tax jurisdiction, and return policy metadata for a given eBay marketplace.

The following table contains all GeteBayDetails fields that return data (in alphabetical order), and their new equivalent field and method in the Metadata API, where a REST equivalent exists. Any legacy field not listed in this table is covered in the Deprecated/non-migrated fields section below.

GeteBayDetails Field Metadata API Equivalent
Method Field
CurrencyDetails.Currency getCurrencies defaultCurrency.code
CurrencyDetails.Description getCurrencies defaultCurrency.description
DispatchTimeMaxDetails.Description getHandlingTimes handlingTimes.description
DispatchTimeMaxDetails.DispatchTimeMax getHandlingTimes handlingTimes.maxHandlingTime
DispatchTimeMaxDetails.ExtendedHandling getHandlingTimes handlingTimes.extendedHandling
ExcludeShippingLocationDetails.Description getExcludeShippingLocations excludeShippingLocations.description
ExcludeShippingLocationDetails.Location getExcludeShippingLocations excludeShippingLocations.location
ExcludeShippingLocationDetails.Region getExcludeShippingLocations excludeShippingLocations.region
ListingStartPriceDetails.Description getMinimumListingPricePolicies minimumListingPricePolicies.description
ListingStartPriceDetails.ListingType getMinimumListingPricePolicies minimumListingPricePolicies.listingType
ListingStartPriceDetails.MinBuyItNowPricePercent getMinimumListingPricePolicies minimumListingPricePolicies.minBuyItNowPricePercent
ListingStartPriceDetails.StartPrice getMinimumListingPricePolicies minimumListingPricePolicies.startPrice.value
PaymentOptionDetails.PaymentOption getCategoryPolicies categoryPolicies.paymentMethods
ReturnPolicyDetails.Description getReturnPolicies returnPolicies.domestic.policyDescriptionEnabled (also returnPolicies.international.policyDescriptionEnabled)
ReturnPolicyDetails.Refund.RefundOption getReturnPolicies returnPolicies.domestic.refundMethods
ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption getReturnPolicies returnPolicies.domestic.returnsAcceptanceEnabled
ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption getReturnPolicies returnPolicies.domestic.returnPeriods
ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption getReturnPolicies

returnPolicies.domestic.returnShippingCostPayers

Note: getReturnPolicies returns return policy metadata per leaf category, broken out into domestic and international objects, rather than as a single flat, site-wide list of allowed option values as returned by the legacy container. The international object mirrors the same fields shown above for domestic.

ShippingCarrierDetails.Description getShippingCarriers shippingCarriers.description
ShippingCarrierDetails.ShippingCarrier getShippingCarriers

shippingCarriers.shippingCarrier

Note: The numeric ShippingCarrierID value used in the legacy container is not returned by getShippingCarriers. Use the enumerated shippingCarrier string value instead when providing shipment tracking information.

ShippingCategoryDetails.ShippingCategory getShippingServices shippingServices.shippingCategory
ShippingLocationDetails.Description getShippingLocations shippingLocations.description
ShippingLocationDetails.ShippingLocation getShippingLocations shippingLocations.shippingLocation
ShippingServiceDetails.Description getShippingServices shippingServices.description
ShippingServiceDetails.InternationalService getShippingServices shippingServices.internationalService
ShippingServiceDetails.ServiceType getShippingServices shippingServices.shippingCostTypes
ShippingServiceDetails.ShippingCarrier getShippingServices shippingServices.shippingCarrier
ShippingServiceDetails.ShippingCategory getShippingServices shippingServices.shippingCategory
ShippingServiceDetails.ShippingService getShippingServices shippingServices.shippingService
ShippingServiceDetails.ShippingTimeMax getShippingServices shippingServices.maxShippingTime
ShippingServiceDetails.ShippingTimeMin getShippingServices shippingServices.minShippingTime
ShippingServiceDetails.ValidForSellingFlow getShippingServices shippingServices.validForSellingFlow
TaxJurisdiction.JurisdictionID getSalesTaxJurisdictions

salesTaxJurisdictions.salesTaxJurisdictionId

Note: getSalesTaxJurisdictions only returns the jurisdiction identifier (salesTaxJurisdictionId). The legacy JurisdictionName field is not returned by the REST method.

Deprecated/non-migrated fields

The following table contains all GeteBayDetails fields that return data, but for which no REST equivalent is being introduced, along with the reason:

GeteBayDetails Field Reason
Ack This field is a Trading API concept and was not carried over.
Build This field is a Trading API concept and was not carried over.
BuyerRequirementDetails Buyer requirement thresholds are configured today through Business Policies and the Account API rather than exposed as global site metadata.
CorrelationID This field is a Trading API concept and was not carried over.
CountryDetails Sellers can reference the ISO 3166 standard, or another tool, to get two-letter country codes.
DetailVersion This field is a Trading API concept that recurs in nearly every GeteBayDetails container to version that container’s metadata independently. It was not carried over to the Metadata API, so it is listed once here rather than repeated for each container.
HardExpirationWarning This field is a Trading API concept and was not carried over.
ItemSpecificDetails Item specifics constraints are available through the Taxonomy API's getItemAspectsForCategory and fetchItemAspects methods.
ListingFeatureDetails Metadata no longer relevant; Bold Title is the only feature still supported, and it is available for most categories on all eBay marketplaces.
PaymentOptionDetails.Description Descriptions of payment methods are described in the PaymentEnum type of getCategoryPolicies.
ProductDetails.ProductIdentifierUnavailableText Static information; product identifier guidance is documented per marketplace language in the Product Identifier Text reference.
RecoupmentPolicyDetails No longer applicable.
RegionDetails Using RegionID values for item or shipping locations is no longer supported in listing APIs.
RegionOfOriginDetails Sellers can reference the ISO 3166 standard, or another tool, to get two-letter country codes.
ReturnPolicyDetails.Refund.Description Deprecated feature (no longer applicable). Only the enumerated refundMethods values are returned by getReturnPolicies.
ReturnPolicyDetails.ReturnsAccepted.Description Deprecated feature (no longer applicable). Superseded by the boolean returnsAcceptanceEnabled flag.
ReturnPolicyDetails.ReturnsWithin.Description Deprecated feature (no longer applicable). Only the structured returnPeriods (value/unit) values are returned.
ReturnPolicyDetails.ShippingCostPaidBy.Description Deprecated feature (no longer applicable). Only the enumerated returnShippingCostPayers values are returned.
ShippingCarrierDetails.ShippingCarrierID Superseded by the enumerated shippingCarrier string value returned by getShippingCarriers; a separate numeric ID is not returned.
ShippingPackageDetails Sellers can use the getShippingServices method to see supported package types, dimensions, and weight restrictions for each shipping service.
ShippingServiceDetails.CostGroupFlat Shipping cost type information is instead returned in the shippingCostTypes array of getShippingServices.
ShippingServiceDetails.DeprecationDetails Deprecated shipping services are simply excluded from the getShippingServices response, so deprecation timing details are not needed.
ShippingServiceDetails.DimensionsRequired Dimension requirements are now expressed through the packageLimits object for the applicable shipping service.
ShippingServiceDetails.ExpeditedService Use the shippingCategory value (for example, EXPEDITED) instead.
ShippingServiceDetails.MappedToShippingServiceID Deprecated shipping services are simply excluded from the getShippingServices response, so a persistent ID mapping is not needed.
ShippingServiceDetails.ShippingPackage See packageLimits on getShippingServices for the applicable size/weight constraints instead.
ShippingServiceDetails.ShippingServiceID Superseded by the shippingService string value returned by getShippingServices; a separate numeric ID is not returned.
ShippingServiceDetails.ShippingServicePackageDetails Superseded by the packageLimits object in the getShippingServices method.
ShippingServiceDetails.SurchargeApplicable A shipping surcharge can only be added in a seller’s Shipping Rate Table and cannot be set up directly in listing APIs.
ShippingServiceDetails.WeightRequired Weight requirements are now expressed through the packageLimits object for the applicable shipping service.
SiteDetails This metadata is not needed for REST APIs, which use marketplace enum values instead to identify eBay marketplaces.
TaxJurisdiction.JurisdictionName Only the jurisdiction identifier (salesTaxJurisdictionId) is returned by getSalesTaxJurisdictions.
Timestamp This field is a Trading API concept and was not carried over.
TimeZoneDetails This metadata will no longer be supported in REST APIs.
UpdateTime This field appears at the top level of the response, as well as in nearly every GeteBayDetails container, to indicate when that data was last updated. It is a Trading API concept that was not carried over to the Metadata API, so it is listed once here rather than repeated for each container.
URLDetails These URL stubs are no longer supported by eBay.
VariationDetails These variation constraint values are not being carried over. These constraints are consistent across all marketplaces and categories and do not vary.
Version This field is a Trading API concept and was not carried over.