The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
| Q2 2009 | Q1 2009 | Q4 2008 | Q3 2008 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 623 | 2009-6-24 | 609 | 2009-3-18 | 597 | Not Released | 583 | 2008-9-17 | ||||
| 621 | 2009-6-10 | 607 | 2009-3-4 | 595 | 2008-12-10 | 581 | 2008-9-3 | ||||
| 619 | 2009-5-27 | 605 | 2009-2-18 | 593 | Not Released | 579 | 2008-8-20 | ||||
| 617 | 2009-5-13 | 603 | 2009-2-4 | 591 | 2008-11-12 | 577 | 2008-8-6 | ||||
| 615 | 2009-4-29 | 601 | 2009-1-21 | 589 | 2008-10-29 | 575 | 2008-7-23 | ||||
| 613 | 2009-4-15 | 599 | 2009-1-7 | 587 | 2008-10-15 | 573 | 2008-7-9 | ||||
| 611 | 2009-4-1 | 585 | 2007-10-3 | ||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 623
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
ExpressDetailsType |
Complex type | Removed |
ExpressHistogramAisleType |
Complex type | Removed |
ExpressHistogramDepartmentType |
Complex type | Removed |
ExpressHistogramDomainDetailsType |
Complex type | Removed |
ExpressHistogramProductType |
Complex type | Removed |
ExpressPreferencesType |
Complex type | Removed |
ExpressProductType |
Complex type | Removed |
ExpressSellerRequirementsType |
Complex type | Removed |
WishListEntryType |
Complex type | Removed |
ExpressSellingPreferenceCodeType |
Enumerated type | Removed |
FetchTokenRequestType.IncludeRESTToken |
Element | Removed |
UserType.RESTToken |
Element | Removed |
AuthTokenTypeCodeType.RESTToken |
Enumeration | Removed |
FeatureEligibilityType |
Complex type | New |
InventoryFeesType |
Complex type | New |
CountryDetailsType.DetailVersion |
Element | New |
CountryDetailsType.UpdateTime |
Element | New |
CurrencyDetailsType.DetailVersion |
Element | New |
CurrencyDetailsType.UpdateTime |
Element | New |
DispatchTimeMaxDetailsType.DetailVersion |
Element | New |
DispatchTimeMaxDetailsType.UpdateTime |
Element | New |
GetCategoryFeaturesRequestType.AllFeaturesForCategory |
Element | New |
GetUserRequestType.IncludeFeatureEligibility |
Element | New |
IntegratedMerchantCreditCardInfoType.SupportedSite |
Element | New |
ItemSpecificDetailsType.DetailVersion |
Element | New |
ItemSpecificDetailsType.UpdateTime |
Element | New |
ListingStartPriceDetailsType.DetailVersion |
Element | New |
ListingStartPriceDetailsType.UpdateTime |
Element | New |
PaymentOptionDetailsType.DetailVersion |
Element | New |
PaymentOptionDetailsType.UpdateTime |
Element | New |
RegionDetailsType.DetailVersion |
Element | New |
RegionDetailsType.UpdateTime |
Element | New |
RegionOfOriginDetailsType.DetailVersion |
Element | New |
RegionOfOriginDetailsType.UpdateTime |
Element | New |
ReturnPolicyDetailsType.DetailVersion |
Element | New |
ReturnPolicyDetailsType.UpdateTime |
Element | New |
ReviseInventoryStatusResponseType.Fees |
Element | New |
SellerType.FeatureEligibility |
Element | New |
ShippingCarrierDetailsType.DetailVersion |
Element | New |
ShippingCarrierDetailsType.UpdateTime |
Element | New |
ShippingLocationDetailsType.DetailVersion |
Element | New |
ShippingLocationDetailsType.UpdateTime |
Element | New |
ShippingPackageDetailsType.DetailVersion |
Element | New |
ShippingPackageDetailsType.UpdateTime |
Element | New |
ShippingServiceDetailsType.DetailVersion |
Element | New |
ShippingServiceDetailsType.UpdateTime |
Element | New |
SiteBuyerRequirementDetailsType.DetailVersion |
Element | New |
SiteBuyerRequirementDetailsType.UpdateTime |
Element | New |
SiteDetailsType.DetailVersion |
Element | New |
SiteDetailsType.UpdateTime |
Element | New |
TaxJurisdictionType.DetailVersion |
Element | New |
TaxJurisdictionType.UpdateTime |
Element | New |
TimeZoneDetailsType.DetailVersion |
Element | New |
TimeZoneDetailsType.UpdateTime |
Element | New |
URLDetailsType.DetailVersion |
Element | New |
URLDetailsType.UpdateTime |
Element | New |
UnitOfMeasurementDetailsType.DetailVersion |
Element | New |
UnitOfMeasurementDetailsType.UpdateTime |
Element | New |
UserType.QualifiesForSelling |
Element | New |
FeedbackRatingStarCodeType.GreenShooting |
Enum | New |
FeedbackRatingStarCodeType.SilverShooting |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 623.
ReviseInventoryStatus now returns fees for each item that was modified in the call. Please note that increasing a listing's price can result in changes to the insertion fee. ReviseInventoryStatus also now allows you to change the quantity or start price of a variation in a multi-variation listing.
The RedShooting Star used to appear when feedback scores were 100,000 and above. However, since eBay has so many sellers with very high feedback, two new ratings have been added. Now the RedShooting Star appears for feedback scores from 100,000 to 499,999; a new GreenShooting Star appears for feedback scores from 500,000 to 999,999; and a new SilverShooting Star appears for feedback scores that are 1,000,000 and above.
This release includes new DetailVersion and UpdateTime fields as part of the GeteBayDetails response, so that you can download the data plus the version and time and cache them locally.
Then, you can make the GeteBayDetails call again to see whether the version or time has changed in the latest response. If these values have changed for any of the details, you can update your cache with those details and the new version/time. If the version and time have not changed for some details, you can skip updating those fields.
The ListingDuration field has been added as a item list option for ActiveList. Therefore, you will now see the ListingDuration field in the ActiveList container of the GetMyeBaySelling response.
The GetUser call contains a new IncludeFeatureEligibility container in the request, so you can choose whether to include seller or platform-based features. Information about whether the user making the request qualifies as a seller, or is qualified for specific features, is included in the response. New fields include: QualifiesForSelling, QualifiesForBuyItNow, QualifiesForBuyItNowMultiple, and QualifiedForFixedPriceOneDayDuration.
You can now use the AllFeaturesForCategory field in the GetCategoryFeatures call to retrieve all features for a given category. Information for child categories is not included.
In other words:
All platform notifications will now include the user's EIASToken to identify the subscriber. This token will be returned only to the subscriber. (The EIAS value for a given user does not change, even if the user's eBay user name changes.)
This doesn't change the basic nature of the individual notifications. Note that the unique user identifier returned in the EIASToken property has nothing to do the authentication token that you pass in API calls.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Formerly, GetUser returned the following to indicate a site on which a seller has a payment gateway account (and thus a site on which the seller can use the IntegratedMerchantCreditCard payment method): User.SellerInfo.IntegratedMerchantCreditCardInfo.AvailableSite. Now, instead of that deprecated field, the following new field should be used: User.SellerInfo.IntegratedMerchantCreditCardInfo.SupportedSite.
The FetchToken and GetUser calls still returned the RESTToken field. Since REST calls have been deprecated for over a year now, these fields are being removed to close a bug.
The MemberMessage.Body field in the AddMemberMessageRTQ call can now accept up to 2000 characters. The previous limit was 1000 characters, but now you can enter and retrieve 2000-character messages.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 623 and Changed Functionality - 623.
None for this release.
Documentation Changes and Errata - 621
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
Until late June, 2009, the current API version will remain at version 621.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 621.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 621 and Changed Functionality - 621.
The schema input section of the AddItemFromSellingManagerTemplate topic was updated to indicate that only the following can be specified as children of the Item container: payment methods and the PayPal email address.
The documentation of the PlaceOffer topic was updated to indicate that in the case of multi-quantity, fixed price listings, SellingStatus.HighBidder is returned only if there is just one transaction.
In GetSellerTransactions, Item.Quantity and Item.SellingStatus.QuantitySold are returned in the context of Transaction, so if the transaction was for a listing with variations, then Quantity is the total quantity for the specified variation, and QuantitySold is the quantity sold in that transaction.
In ReviseFixedPriceItem, when you revise multiple variations in the same listing at the same time (i.e, within a very short period), the best practice is to use a single ReviseFixedPriceItem request that includes all the variation revisions in the same request.
Please note that if your application design requires you to revise each variation individually, you should avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.
Documentation Changes and Errata - 619
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
NameValueListType.VariationSpecificPictures |
Element | Removed |
NameValueListType.VariationsEnabled |
Element | Removed |
BrandMPNType |
Complex type | New |
TicketListingDetailsType |
Complex type | New |
GetSellerListRequestType.IncludeVariations |
Element | New |
ProductListingDetailsType.BrandMPN |
Element | New |
ProductListingDetailsType.EAN |
Element | New |
ProductListingDetailsType.ISBN |
Element | New |
ProductListingDetailsType.ListIfNoProduct |
Element | New |
ProductListingDetailsType.ReturnSearchResultOnDuplicates |
Element | New |
ProductListingDetailsType.TicketListingDetails |
Element | New |
ProductListingDetailsType.UPC |
Element | New |
ProductListingDetailsType.UseFirstProduct |
Element | New |
DisputeResolutionRecordTypeCodeType.FeatureFeeCredit |
Enum | New |
DisputeResolutionRecordTypeCodeType.FeatureFeeNotCredit |
Enum | New |
DisputeResolutionRecordTypeCodeType.ReverseFeatureFeeCredit |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 619.
With a request version of 619 or higher, PromotionalDiscount can be returned in Fees.Fee for the AddItem family of calls. (eBay will not actually start returning this element until mid-June, but you can begin coding to account for this element with version 619.) PromotionalDiscount is returned whenever a discount has been applied to the respective listing fee and is the amount of money the seller saved due to the promotion that was in effect at the time they submitted their listing.
Starting with request version 619, the meaning of Fee for VerifyAddItem matches that of Fee in AddItem: it is the actual cost of the particular listing feature (e.g. bold title, highlight), thus reflecting any discounts that applied. Note that with a request version lower than 619, Fee in VerifyAddItem reflects the pre-discount cost of the listing feature and does not match the meaning of Fee in AddItem.
For more information, see the topic "Promotional Discounts" in "Fees Resulting from Listing an Item".
Now Power Sellers can receive a refund or credit of their Final Value Fee as part of the resolution of a dispute. The FVF is known as the Feature Fee when it is refunded. Developers can use the GetDisputes or GetUserDisputes calls to determine if a refund or credit has been granted. The new enumeration values that were added for this feature are part of the DisputeResolutionRecordTypeCodeType and are: FeatureFeeCredit, FeatureFeeNotCredit, and ReverseFeatureFeeCredit.
AddItem and related calls now support external product IDs in ProductListingDetails for listing with ISBN, UPC, EAN, Brand+MPN, and ticket keywords. ProductListingDetails also now supports the ePID value that is displayed on the eBay Web site (using the ProductReferenceID field).
ProductListingDetails also supports new fields that let you control how eBay handles your listing request when no product matches are found or when multiple product matches are found.
The new fields in ProductListingDetails are enabled for all catalog-enabled categories (not just Media categories).
ExternalProductID will be deprecated in a future release.
In AddItem and related calls, LookupAttributeArray is now enabled for all catalog-enabled categories that support the notion of a condition (e.g., not Tickets). The condition values (e.g., "New" and "Used") are not normalized across categories. The name and value must match the attribute name and value defined in GetAttributesCS or GetProductSellingPages. (For example, on the US site, you would use "Brand New" for books, or "New, Never Opened" for cameras.)
GetSellerList now returns details for mult-variation listings. Pass IncludeVariations in the request to retrieve the Variations node. Only the variation specifics, price, quantity, quantity sold, and SKU are returned (not the pictures, etc.).
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The API has been updated to allow you to omit DispatchTimeMax (or set it to 0) in AddItem and related calls when ShippingService=Pickup or ShipToLocations=None.
Reminder: When GetCategoryFeatures returns HandlingTimeEnabled=false, it means that a handling time is required when flat or calculated shipping services are specified. (This rule does not apply when the listing only offers local pickup or freight.)
eBay is deprecating Dutch (multi-listing) competitive-bid item listings. Version 619 represents the Third Phase in the deprecation process. This is the final deprecation phase.
Phase III, version 619: On all sites globally, eBay throws an error
if you attempt to create a Dutch auction with AddItem or
VerifyAddItem. If you attempt to create a Dutch auction with
RelistItem, eBay generates a warning and resets
Quantity to 1.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 619 and Changed Functionality - 619.
None for this release.
Documentation Changes and Errata - 617
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
FreeGalleryPlusEnabledDefinitionType |
Complex type | New |
FreePicturePackEnabledDefinitionType |
Complex type | New |
MaximumBuyerPolicyViolationsDetailsType |
Complex type | New |
MaximumItemRequirementsDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesCountDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesDurationDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesInfoDetailsType |
Complex type | New |
MinimumFeedbackScoreDetailsType |
Complex type | New |
NumberOfPolicyViolationsDetailsType |
Complex type | New |
PolicyViolationDurationDetailsType |
Complex type | New |
SiteBuyerRequirementDetailsType |
Complex type | New |
VerifiedUserRequirementsDetailsType |
Complex type | New |
CategoryFeatureType.FreeGalleryPlusEnabled |
Element | New |
CategoryFeatureType.FreePicturePackEnabled |
Element | New |
FeatureDefinitionsType.FreeGalleryPlusEnabled |
Element | New |
FeatureDefinitionsType.FreePicturePackEnabled |
Element | New |
GeteBayDetailsResponseType.BuyerRequirementDetails |
Element | New |
SiteDefaultsType.FreeGalleryPlusEnabled |
Element | New |
SiteDefaultsType.FreePicturePackEnabled |
Element | New |
DetailNameCodeType.BuyerRequirementDetails |
Enum | New |
FeatureIDCodeType.FreeGalleryPlusEnabled |
Enum | New |
FeatureIDCodeType.FreePicturePackEnabled |
Enum | New |
SellingManagerSoldListingsPropertyTypeCodeType.ResponseRequiredForReturnCase |
Enum | New. Reserved for future use. |
Until late May, 2009, the current API version will remain at version 615. Therefore, most changes to calls in the 617 schema version will not be enabled until late May 2009, at the earliest.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 617.
As of June 2009, in certain categories, if a seller adds a picture (or pictures) to a listing, the seller gets free, automatic upgrades. The free upgrades are Gallery Plus, which enhances pictures in search results, and Picture Pack, a discount package that includes super-sizing of pictures. To determine the categories that support the free upgrades, see recent changes to GetCategoryFeatures.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Site-specific buyer requirements are now returned in the GeteBayDetails response. Sellers can now choose from site-specific buyer requirements that are returned in the response to limit the number of policy violations or non-payment strikes that a buyer can have if they want to bid on an item that the seller is listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 617 and Changed Functionality - 617.
In the AddItem documentation, the PictureURL section states, "On the main eBay site, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 6 picture URLs hosted by a third-party vendor. If you specify multiple vendor-hosted pictures in listing calls, PhotoDisplay must be set to VendorHostedPictureShow."
However, the VendorHostedPictureShow option is no longer available. Now a listing can only have one vendor-hosted picture. The documentation will be updated to reflect this in the next release.
Documentation Changes and Errata - 615
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
ItemSpecificsRecommendationsType |
Complex type | Removed |
CategoryItemSpecificsType.Updated |
Element | Removed |
FeeType.DiscountedFee |
Element | Removed |
FeeType.RelatedDiscountedFeeName |
Element | Removed |
GetCategorySpecificsResponseType.CategoryItemSpecifics |
Element | Removed |
GetRecommendationsResponseContainerType.ItemSpecificsRecommendations |
Element | Removed |
AddFixedPriceItemRequestType |
Complex type | New |
AddFixedPriceItemResponseType |
Complex type | New |
AttributeConversionEnabledFeatureDefinitionType |
Complex type | New |
EndFixedPriceItemRequestType |
Complex type | New |
EndFixedPriceItemResponseType |
Complex type | New |
PicturesType |
Complex type | New |
RelistFixedPriceItemRequestType |
Complex type | New |
RelistFixedPriceItemResponseType |
Complex type | New |
ReviseFixedPriceItemRequestType |
Complex type | New |
ReviseFixedPriceItemResponseType |
Complex type | New |
SellingManagerProductSpecificsType |
Complex type | New |
VariationKeyType |
Complex type | New |
VariationSpecificPictureSetType |
Complex type | New |
VariationType |
Complex type | New |
VariationsEnabledDefinitionType |
Complex type | New |
VariationsType |
Complex type | New |
VerifyAddFixedPriceItemRequestType |
Complex type | New |
VerifyAddFixedPriceItemResponseType |
Complex type | New |
AttributeConversionEnabledCodeType |
Enumerated type | New |
VariationPictureRuleCodeType |
Enumerated type | New |
VariationSpecificPicturesCodeType |
Enumerated type | New |
VariationSpecificsRuleCodeType |
Enumerated type | New |
AddSellingManagerProductRequestType.SellingManagerProductSpecifics |
Element | New |
AddToWatchListRequestType.VariationKey |
Element | New |
CategoryFeatureType.AttributeConversionEnabled |
Element | New |
CategoryFeatureType.VariationsEnabled |
Element | New |
FeatureDefinitionsType.AttributeConversionEnabled |
Element | New |
FeatureDefinitionsType.VariationsEnabled |
Element | New |
FeeType.PromotionalDiscount |
Element | New |
GetItemRequestType.VariationSKU |
Element | New |
GetItemRequestType.VariationSpecifics |
Element | New |
ItemType.Variations |
Element | New |
NameValueListType.VariationSpecificPictures |
Element | New |
NameValueListType.VariationsEnabled |
Element | New |
PlaceOfferRequestType.VariationSpecifics |
Element | New |
RecommendationValidationRulesType.VariationPicture |
Element | New |
RecommendationValidationRulesType.VariationSpecifics |
Element | New |
RemoveFromWatchListRequestType.VariationKey |
Element | New |
ReviseSellingManagerProductRequestType.SellingManagerProductSpecifics |
Element | New |
SellingManagerProductType.SellingManagerProductSpecifics |
Element | New |
SellingManagerSoldTransactionType.Variation |
Element | New |
ShipmentType.Notes |
Element | New |
SiteDefaultsType.AttributeConversionEnabled |
Element | New |
SiteDefaultsType.VariationsEnabled |
Element | New |
TransactionType.Variation |
Element | New |
FeatureIDCodeType.AttributeConversionEnabled |
Enum | New |
FeatureIDCodeType.VariationsEnabled |
Enum | New |
ShippingServiceCodeType.UPSWorldwideSaver |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 615.
In the CompleteSale call, in ShipmentType.Notes, a Half.com seller can include shipment-related notes to the buyer. Thus, Half.com sellers can use ShipmentType.Notes in conjunction with the following existing fields available to all sellers: ShipmentTrackingNumber and ShipmentCarrierUsed.
The AddFixedPriceItem, EndFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem calls are now available in the Trading API. Unlike the way they are used in the Large Merchant Services solution, the calls do not have to be included within a data file. You can make each call the way you ordinarily make Trading API calls. For instance, an AddFixedPriceItem call would look very similar to an AddItem call. You can review the parameters for each call in the Trading API Call Reference.
AddFixedPriceItem and related calls are nearly identical to the AddItem family of calls. Here are the main differences with the fixed-price calls:
These calls are still available for use within Large Merchant Services data files. In other words, the way these calls work with the LMS Solution has not changed.
Multi-variation listings contain items that are logically the same product, but that vary in their manufacturing details (such as color), and optionally price and quantity. For example, you could create one listing with shirts that are all the same brand and style, and then organize them into a variation (a subset) with 20 large, blue shirts for $20.00 each and another variation with 15 medium, black shirts for $9.99 each. A listing can include up to 120 variations over its lifetime.
This feature will be available soon in the Sandbox, and then available in production in a subsequent release. Keep an eye on the eBay Developers Program newsletter for details.
To create multi-variation lisings, you use the AddFixedPriceItem family of calls. In AddFixedPriceItem and related calls, see the following fields for changes or additions related to multi-variation listings:
Also see new and changed fields in the following calls:
API calls that support orders, My eBay, and category metadata have also been updated.
Please note the following behavioral changes, in case you need to make adjustments to how your application currently interprets data returned by eBay:
In GetItem and related calls:
GetMyeBayBuying and related calls also support activities related to variations.
GetSearchResults returns each variation as a separate item result. This means multiple results can have the same ItemID, EndTime, and TimeLeft in the same response. When this occurs, the ViewItemURL links to a view of the View Item page that is configured to show you the relevant variation.
See Multi-Variation Listings for details about API support for this feature.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
eBay is deprecating Dutch (multi-listing) competitive-bid item listings in three phases. Version 615 represents the Second Phase in the deprecation process.
Phase II, version 615: On the US (0), CA (2), FRCA (210), UK (3),
and DE (77) sites; eBay throws an error if you attempt to create a Dutch auction with
AddItem or VerifyAddItem. If you attempt to create
a Dutch auction with RelistItem, eBay generates a warning and resets
Quantity to 1.
Phase III, version 619: On all sites globally, eBay will throw an error
if you attempt to create a Dutch auction with AddItem or
VerifyAddItem. If you attempt to create a Dutch auction with
RelistItem, eBay generates a warning and resets
Quantity to 1.
PromotionalDiscount, while available in the 615 schema, will not be returned until version 619. In 619, PromotionalDiscount will be returned in all Fee containers where a discount has been applied to the fee. This will work with the entire AddItem family of calls.
The following shows an example of the current Fee container, returned with a request version lower than 619:
<Fee>
<Name>Bold</Name>
<Fee currencyID="USD">2.0</Fee>
</Fee>
With a request version of 619 or higher, the AddItem family of calls can return a Fee container similar to the following:
<Fee>
<Name>Bold</Name>
<Fee currencyID="USD">0.5</Fee>
<PromotionalDiscount currencyID="USD">1.5</PromotionalDiscount>
</Fee>
Starting with version 619, a change will occur in the way VerifyAddItem returns Fee values. Currently, VerifyAddItem returns Fee values that represent the pre-discount cost of the fee, regardless of any promotional discounts. Starting with version 619, VerifyAddItem will return the discounted fee price (discounts will be subtracted from the original cost of the fee), matching how AddItem currently behaves.
As previously announced, eBay is beginning to convert some categories that previously supported ID-based attributes to only support custom Item Specifics instead.
GetCategoryFeatures now returns AttributeConversionEnabled to identify categories that eBay has fully converted from ID-based attributes to custom Item Specifics.
Here are examples of converted categories on the US eBay site (site ID 0), if you need to test this use case:
If a category has been converted, you can pass either ID-based attributes (Item.AttributeSetArray) or custom Item Specifics Item.ItemSpecifics) in the AddItem family of calls, but you can't pass both formats in the same AddItem request.
For a transition period,
AttributeConversionEnabled will return a value of Enabled for converted
categories. In these categories, if you pass in ID-based attributes in AddItem,
eBay converts them to custom Item Specifics on your behalf.
Once this transition period has ended, AttributeConversionEnabled will
begin to return a value of Disabled (or GetCategory2CS won't return category-to-characteristic set
mappings at all), and AddItem requests with ID-based attributes
will fail. Keep an eye on the eBay Developers Program newsletter for information about the
length of the transition period.
If the category is flagged as CatalogEnabled in GetCategory2CS, the attribute conversion flag in GetCategoryFeatures is also a hint that you can use GetItemRecommendations to retrieve product details in the custom Item Specifics format (instead of using GetProductSellingPages to retrieve product details in the ID-based attributes format).
If a category has not yet been converted, you may be able to pass ID-based attributes (such as Item Condition)
and custom Item Specifics in the same AddItem request. For example, this would work for
categories where GetCategory2CS returns AttributeSetID and
GetCategoryFeatures returns ItemSpecificsEnabled, but
AttributeConversionEnabled is not set to Enabled or Disabled.
With request version 607 and lower, GetCategorySpecifics does not return recommendations for categories that have been converted from ID-based attributes to custom Item Specifics. For all versions, GetCategorySpecifics does return recommendations for other categories. (This change has been made to discourage sellers from selecting values in both formats (in converted categories) and then passing them together in AddItem. This does not prevent you from passing custom Item Specifics in AddItem in these categories. You just won't see recommendations.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 615 and Changed Functionality - 615.
General updates have been made in the Trading API Guide and Trading API Call Reference to information about the calls related to Selling Manager and Selling Manager Pro.
The Platform Notifications Guide erroneously added the prefix "UPI" to the names of the following notifications:
WebHelp has been changed to refer to these notifications by their correct names.
Documentation Changes and Errata - 613
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No schema changes in this release.
Please see the recent announcements for sellers on the eBay Developers Program blog.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 613.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 613 and Changed Functionality - 613.
The Application Settings tool, introduced in 577, has passed its Beta phase and is now the standard tool for managing user tokens. The old Authentication & Authorization chapter, which described application configuration processes made obsolete by the Application Settings tool, has been removed. The replacement chapter, Getting a Token, describes how to use the Application Settings tool to manage authentication and authorization.
PrivateNotes is no longer documented as being supported for the AddItem call.
Documentation Changes and Errata - 611
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetCategorySpecificsRequestType.CategorySpecificsFileInfo |
Element | New |
GetCategorySpecificsResponseType.FileReferenceID |
Element | New |
GetCategorySpecificsResponseType.TaskReferenceID |
Element | New |
EndReasonCodeType.Sold |
Enum | New |
SearchFlagCodeType.WorldOfGood |
Enum | New |
eBay is deprecating Dutch (multi-listing) competitive-bid item listings in three phases.
Phase I, Release 611: eBay generates a warning when you create a Dutch Auction listing with AddItem, VerifyAddItem, or RelistItem.
The GetHighBidders call and the ListingTypeCodeList.Dutch type are deprecated in this phase. GetHighBidders will continue to work until no Dutch Auction listings remain on the site.
Phase II, Release 615: In sites US, CAFR, CA, UK, and DE; ebay will throw an error if you attempt to create a Dutch auction with AddItem or VerifyAddItem. For RelistItem, eBay will generate a warning and reset Quantity value to 1.
Phase III, Release 619: In all sites globally, ebay will throw an error if you attempt to create a Dutch Auction with AddItem or VerifyAddItem. For RelistItem, eBay will generate a warning and reset Quantity to 1.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 611.
You can now use the downloadFile call in the File Transfer API to download a single GetCategorySpecifics response that contains custom Item Specific recommendations (if any) for all categories on a specified site. The GetCategorySpecifics response is returned as a .zip file attachment. It uses the new Recommendations node (introduced with version 609).
The Trading API normally enables you to retrieve recommendations for 250-275 leaf categories at a time. For applications that support a very wide variety of categories, the new file download approach may be more convenient.
| Note: You don't need to learn about (or use) Large Merchant Services or the Bulk Data Exchange API in order to use downloadFile call in the File Transfer API. |
Here's how it works:
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Starting with this release, sellers adding items to the India site (site ID 203) will no longer be able to charge a value added tax (VAT) in addition to the price of their items. Instead, sellers must include any VAT charges as part of the item price. The sellers are solely responsible for compliance relating to tax legislation in India.
Note that the eBay APIs have not changed; you can still add items to the India site that include VAT values (Item.VATDetails). If you do add an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a StartPrice value that includes the VAT.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 611 and Changed Functionality - 611.
None for this release.
Documentation Changes and Errata - 609
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
NameRecommendationType |
Complex type | New |
NameValueRelationshipType |
Complex type | New |
RecommendationValidationRulesType |
Complex type | New |
RecommendationsType |
Complex type | New |
ValueRecommendationType |
Complex type | New |
ValueTypeCodeType |
Enumerated type | New |
GetCategorySpecificsRequestType.CategorySpecific |
Element | New |
GetCategorySpecificsRequestType.ExcludeRelationships |
Element | New |
GetCategorySpecificsRequestType.IncludeConfidence |
Element | New |
GetCategorySpecificsResponseType.Recommendations |
Element | New |
GetRecommendationsRequestContainerType.ExcludeRelationships |
Element | New |
GetRecommendationsRequestContainerType.IncludeConfidence |
Element | New |
GetRecommendationsResponseContainerType.ProductListingDetails |
Element | New |
GetRecommendationsResponseContainerType.Recommendations |
Element | New |
GetRecommendationsResponseContainerType.Title |
Element | New |
ProductListingDetailsType.DetailsURL |
Element | New |
ProductListingDetailsType.ProductDetailsURL |
Element | New |
ProductListingDetailsType.ProductReferenceID |
Element | New |
SelectionModeCodeType.FreeText |
Enum | New |
SelectionModeCodeType.Prefilled |
Enum | New |
SelectionModeCodeType.SelectionOnly |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 609.
Starting in 2009, some categories that support ID-based Attributes may be converted to support custom Item Specifics instead. Use GetCategoryFeatures to determine which categories support the custom Item Specifics format (see ItemSpecificsEnabled).
Keep an eye on the eBay Developers Program newsletter and blog for details about category changes.
This release note entry describes the anticipated API behavior after a category has been converted from Attributes to custom Item Specifics. More details and examples will be provided in a future release.
To maintain backward compatibility, and to give you more time to migrate your listing templates, you can still pass Item.AttributeSetArray in AddItem, ReviseItem, RelistItem, and VerifyAddItem even after a category has been converted to custom Item Specifics. In these cases, eBay automatically moves the relevant Attribute data into the Item.ItemSpecifics node on your behalf when we receive your request.
| Note: When a category still supports ID-based attributes (i.e., it hasn't been converted), there is no change to AddItem and related calls, no mapping occurs, and there is no need to change listing templates. |
To support catalog and historical Attribute details, GetCategory2CS, GetAttributesCS, and GetProductSellingPages may continue to indicate that categories are Attribute-enabled even after they have been converted. If this occurs, you can assume the settings in GetCategoryFeatures take precedence over the settings in GetCategory2CS when you are choosing how to specify Item Specifics in listing requests.
You use the usual catalog product search process (GetProductSearchResults, etc.) for converted categories. However, if you list with Item.ProductListingDetails or Item.ExternalProductID, and the category supports custom Item Specifics, then GetItem returns the product Item Specifics in Item.ItemSpecifics instead of Item.AttributeSetArray.
If you use GetItem to read Item Specifics data, it is a good idea to check for both Item.ItemSpecifics and Item.AttributeSetArray in the response.
Note: The way GetItem returns Item Specifics depends on whether the category currently supports ID-based Attributes or custom Item Specifics:
|
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
When you specify version 609 or higher in a GetCategorySpecifics request, the response returns Recommendations (a new node) instead of CategoryItemSpecifics.
Recommendations includes relevant Item Specific names and values (if any). In addition, it includes listing rules, such as whether you can specify more than one value for a name in listing requests. It also may include relationships (if any) between Item Specifics (e.g., City usually only makes sense when State is also specified). In 2009, you might only start seeing relationship details after certain categories are converted from ID-based Attributes to custom Item Specifics.
In addition, you can iteratively pass in Item Specific names and values to refine and improve the precision of the recommendations.
When you specify version 609 or higher in a GetItemRecommendations request, and you use the Item Specifics recommendation engine, the response returns Recommendations (a new node) instead of ItemSpecificsRecommendations.
Recommendations includes relevant Item Specific names and values (if any). In addition, it includes listing rules, such as whether you can specify more than one value for a name in listing requests. It also may include relationships (if any) between Item Specifics (e.g., City usually only makes sense when State is also specified). In 2009, you might only start seeing relationship details after certain categories are converted from ID-based Attributes to custom Item Specifics.
In addition, you can iteratively pass in Item Specific names and values to refine and improve the precision of the recommendations.
With request version 609 and higher, you can also use GetItemRecommendations instead of GetProductSellingPages to render product details for categories that support custom Item Specifics. If you pass a product ID in the GetItemRecommendations request (by using Item.ProductListingDetails or Item.ExternalProductID), and you use the Item Specifics recommendation engine, then Recommendations includes the product's Item Specifics (marked as prefilled) in addition to the custom Item Specific recommendations (if any). In addition, the response includes a Title recommendation (based on the product title), and ProductListingDetails with other details from the catalog.
In preparation for Picture Manager retirement in late 2009, new subscriptions and subscription upgrades have been disabled as of this release. UploadSiteHostedPictures has new functionality which will allow a user to retrieve a picture from a URL on an external Web server. Once retrieved, the picture will be copied to eBay Picture Services (EPS).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 609 and Changed Functionality - 609.
None for this release.
Documentation Changes and Errata - 607
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
AddSellingManagerTemplateRequestType.SellingManagerDetails |
Entity | Removed |
GetSellingManagerTemplatesRequestType.IncludeCrossPromotion |
Entity | Removed |
SellingManagerDetailsType |
Entity | Removed |
AddSellingManagerTemplateRequestType.ProductID |
Element | New |
AddSellingManagerTemplateRequestType.SaleTemplateName |
Element | New |
ShippingServiceCodeType.DE_DHLPaeckchenPackstation |
Enum | New |
ShippingServiceCodeType.DE_DHLPaketPackstation |
Enum | New |
ShippingServiceCodeType.DE_DHLStarPaeckchen |
Enum | New |
ShippingServiceCodeType.DE_HermesPaketShop2Shop |
Enum | New |
ShippingServiceCodeType.DE_HermesPaketShop2ShopKaeufer |
Enum | New |
ShippingServiceCodeType.DE_eBayDHLPaeckchen |
Enum | New |
ShippingServiceCodeType.DE_eBayHermesPaketShop2Shop |
Enum | New |
ShippingServiceCodeType.DE_eBayHermesPaketShop2ShopKaeufer |
Enum | New |
ShippingServiceCodeType.UK_OtherCourier3Days |
Enum | New |
ShippingServiceCodeType.UK_OtherCourier5Days |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 607.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Several new shipping services have been added, including two new USPS services for a small, flat- rate box (added in release 605), and new UK and DE shipping services.
See Schema Changes for a list of new UK and DE shipping services added in this release.
A couple unused schema elements and a related type have been removed from Selling Manager calls. These calls were made available for Open eBay participants building applications related to Selling Manager only. The affected calls, AddSellingManagerTemplate and GetSellingManagerTemplates, are unsupported for general use.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 607 and Changed Functionality - 607.
None for this release.
Documentation Changes and Errata - 605
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
AddLiveAuctionItemRequestType |
Entity | Removed |
AddLiveAuctionItemResponseType |
Entity | Removed |
ApproveLiveAuctionBiddersRequestType |
Entity | Removed |
ApproveLiveAuctionBiddersResponseType |
Entity | Removed |
BidApprovalArrayType.LiveAuctionBid |
Entity | Removed |
BidderDetailType.LiveAuctionBidResult |
Entity | Removed |
GetLiveAuctionBiddersRequestType |
Entity | Removed |
GetLiveAuctionBiddersResponseType |
Entity | Removed |
GetLiveAuctionCatalogDetailsRequestType |
Entity | Removed |
GetLiveAuctionCatalogDetailsResponseType |
Entity | Removed |
ItemType.LiveAuctionDetails |
Entity | Removed |
ItemType.NowAndNew |
Entity | Removed |
LiveAuctionApprovalStatusArrayType |
Entity | Removed |
LiveAuctionApprovalStatusType |
Entity | Removed |
LiveAuctionBidArrayType |
Entity | Removed |
LiveAuctionBidType |
Entity | Removed |
LiveAuctionCatalogType |
Entity | Removed |
LiveAuctionDetailsType |
Entity | Removed |
ReviseLiveAuctionItemRequestType |
Entity | Removed |
ReviseLiveAuctionItemResponseType |
Entity | Removed |
SellerType.LiveAuctionAuthorized |
Entity | Removed |
FeedbackTypeCodeType |
Enumerated type | New |
FeeType.DiscountedFee |
Element | New |
FeeType.RelatedDiscountedFeeName |
Element | New |
GetFeedbackRequestType.FeedbackType |
Element | New |
GetMyeBayBuyingRequestType.BuyingSummary |
Element | New |
GetMyeBaySellingRequestType.SellingSummary |
Element | New |
TransactionType.BuyerCheckoutMessage |
Element | New |
UploadSiteHostedPicturesRequestType.ExternalPictureURL |
Element | New |
UserType.BillingEmail |
Element | New |
BuyerSatisfactionStatusCodeType.Excellent |
Enum | New |
BuyerSatisfactionStatusCodeType.VeryPoor |
Enum | New |
DisputeRecordTypeCodeType.HalfDispute |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailInternationalSmallFlatRateBox |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailSmallFlatRateBox |
Enum | New |
eBay is no longer offering eBay Live Auctions. All Live Auction API functionality has been retired as of this release.
As previously announced, Now & New (Sofort & Neu) has been retired as of this release. This retirement includes the deprecation of Now & New enums for search in GetSearchResults and GetMyeBayBuying.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 605.
Previously, the only way to retrieve comments left by buyers during checkout was via the UI or
an email. This was often a tedious process that could cause shipping delays. Now the Transaction
container in the responses for GetItemTransactions and GetSellerTransactions includes a
BuyerCheckoutMessage field.
When a user has their billing option set to 'email', they can include the new BillingEmail element in a GetUser request to retrieve their own email bills.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
You can now retrieve feedback that you received as a buyer, feedback you received as a seller, or feedback you left for others (as either a buyer or a seller). Specify FeedbackReceivedAsSeller, FeedbackReceivedAsBuyer, FeedbackLeft, or use the default option of FeedbackReceived, with the GetFeedback call to use these new options.
With this release, you no longer need to include ItemID in an AddMemberMessageRTQ request, if the request includes a RecipientID in the MemberMessage container.
Example:
<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessageRTQRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<ItemID>190001385789</ItemID--> <-- No longer required
<MemberMessage>
<Body>This should contain the answer to a question that
an eBay user asks you (the seller) about an active listing.</Body>
<ParentMessageID>5140381</ParentMessageID>
<RecipientID>braggybuyer@yahoo.com</RecipientID> <-- if this tag is present
</MemberMessage>
<RequesterCredentials>
<eBayAuthToken>ABC...123</eBayAuthToken>
</RequesterCredentials>
</AddMemberMessageRTQRequest>
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 605 and Changed Functionality - 605.
Documentation incorrectly stated that PaidTime would be the transaction time if the seller was not a Selling Manager Pro user. This statement was removed.
Documentation Changes and Errata - 603
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
IntegratedMerchantCreditCardInfoType |
Complex type | Reserved for future use |
CheckoutStatusType.IntegratedMerchantCreditCardEnabled |
Element | Reserved for future use |
ItemType.IntegratedMerchantCreditCardEnabled |
Element | Reserved for future use |
OrderType.IntegratedMerchantCreditCardEnabled |
Element | Reserved for future use |
SellerType.IntegratedMerchantCreditCardInfo |
Element | Reserved for future use |
SellingManagerOrderStatusType.IntegratedMerchantCreditCardEnabled |
Element | Reserved for future use |
TransactionStatusType.IntegratedMerchantCreditCardEnabled |
Element | Reserved for future use |
BuyerPaymentMethodCodeType.IntegratedMerchantCreditCard |
Enum | Reserved for future use |
BuyerPaymentMethodCodeType.Moneybookers |
Enum | New |
BuyerPaymentMethodCodeType.Paymate |
Enum | New |
As announced, eBay will retire Now & New (Sofort & Neu) by March 2009. This retirement includes the deprecation of Now & New enums for search in GetSearchResults and GetMyeBayBuying.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 603.
Schema changes have been done for the Integrated Merchant Credit Card feature in preparation for Payflow registration becoming available to users as of the end of February 2009. Please see upcoming release notes for more details on the functionality and availability of this feature.
On the US site, you can list items with the Paymate and Moneybookers payment methods. These payment methods, which have been added to BuyerPaymentMethodCodeType, also are available in the Parts and Accessories category of the US eBay Motors site.
For more information about Paymate and Moneybookers, see this announcement.
The Trading API now includes support for eBay Motors fee changes, that are designed to draw new sellers into the vehicles market. These changes are back-end calculation adjustments that do not affect existing API calls or behavior.
The new pricing includes no Insertion Fees for the first 4 vehicles sold within a 12-month period. For five or more vehicle listings in one year, an Insertion Fee applies, but the Successful Listing Fees are lower. You can see the fee structure in the eBay Motors online help.
Every year at the seller's anniversay date (the date of the seller's first vehicle listing after September 2, 2008), the Insertion Fee will return to zero and the Successful Listing fee will be slightly higher.
Note that the Trading API does not include a specific call to find out if you have sold more than four vehicles, but you can use existing calls, such as GetMyeBaySelling to see your sales information.
Note also that re-listing a vehicle does not increase your total vehicle count.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The new item sorting enumeration values, HighestPricedPlusShipping and LowestPricedPlusShipping, which were enabled for the US site in the 601 release are now available to UK (3), CA (2), and CAFR (210) sites. These sorting values should be made available to all eBay sites by the end of February 2009.
For more information, see the Sorting Items by Price Plus Shipping Cost Supported for eBay Stores entry in the 601 release notes.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 603 and Changed Functionality - 603.
CompleteSale supports orders, so there is no need for you to call CompleteSale repeatedly for each transaction, as previously stated in CompleteSale documentation.
Documentation Changes and Errata - 601
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
TransactionPlatformType |
Entity | Removed |
TransactionType.TransactionPlatform |
Entity | Removed |
ListingStartPriceDetailsType |
Complex type | New |
GeteBayDetailsResponseType.ListingStartPriceDetails |
Element | New |
DetailNameCodeType.ListingStartPriceDetails |
Enum | New |
NotificationEventTypeCodeType.ItemMarkedPaid |
Enum | New |
NotificationEventTypeCodeType.ItemMarkedShipped |
Enum | New |
As announced, eBay will retire Now & New (Sofort & Neu) by March 2009. This retirement includes the deprecation of Now & New enums for search in GetSearchResults and GetMyeBayBuying.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 601.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Buy It Now can now be used for Adult Only listings. Thus, sellers can list Adult Only items in Buy It Now, Fixed Price and Store Inventory Format listings. Restrictions limiting the number of pictures have been removed.
Please see the Adult Only policy for complete information on listing in Adult Only categories: Adult Only Category Policy
This affects the AddItem family of calls.
The search results returned by GetSearchResults when Order is set to BestMatchSort now match eBay site search results sorted by Best Match. Similarly, results returned by GetCategoryListings when OrderBy is set to BestMatchSort now match eBay site results when browsing a category sorted by Best Match. Best Match sorting is the default setting for both the API and the site.
Two new item sorting enumeration values, HighestPricedPlusShipping and LowestPricedPlusShipping, have been enabled for specifying the default sort order for displaying store items. Store owners can use these new values with Store.ItemListSortOrder in SetStore to specify the default order for displaying their store items. Buyers can use SellerFavoriteItemPreferences.SearchSortOrder in SetUserPreferences to specify the default order items are displayed in the favorite seller email marketing they receive.
These values were added to the schema in the 589 release, but were disabled until now. These values are enabled for the US site only, initially, but will be available for eBay Stores on all eBay sites soon.
Sellers are now allowed to remove a number of listing enhancements with ReviseItem. This applies to fixed-price listings with Good Til Cancelled (GTC) durations only. This funtionality is available on the following sites only: AT (16), CA (2), CAFR (210), CH (193), DE (77), IE (205), IT (101), and UK (3).
When the seller removes the listing feature, the listing will immediately lose the search benefits associated with the feature. Seller do not get a full or partial refund (GTC renewal/billing is monthly). However, if the seller adds the feature back sometime after it was removed, but before the item renews for GTC, there is no additional charge. If the listing does not have the feature on it when the GTC listing is renewed (moves into the next billing period), then the seller will not get charged for it at that time. If the seller decides to add the feature after the listing has renewed, then seller is billed at the price for that feature as it pertains to that 30 day listing period.
If the seller removes a feature that is part of a bundle, and the seller had currently opted for the bundle, the bundle option is removed. No refund is given for the bundle, but if the seller opts for the bundle again before GTC renewal, then they will not be charged for it a second time.
For Featured First, note the differences due to the durations associated with the feature:
TransactionPlatformType and the TransactionPlatform field in TransactionType are being discontinued as of this release. If you were expecting to use the TransactionType.TransactionPlaform in your code, use TransactionType.Plaform instead.
You can now retrieve the minimum starting price for each listing type (such as 'Chinese', 'Dutch', 'AdType', 'FixedPriceItem', and others), using GeteBayDetails.ListingStartPriceDetails.
You can now receive ItemMarkedPaid and ItemMarkedShipped Platform Notifications when a seller sends a CompleteSaleRequest call with the 'Shipped' and 'Paid' elements set as 'true'.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 601 and Changed Functionality - 601.
The Trading API Guide contains preview information for calls related to Selling Manager and Selling Manager Pro. For more information about these calls, see Preview of Calls Related to Selling Manager and Selling Manager Pro.
Documentation Changes and Errata - 599
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No schema changes in this release.
The following Picture Manager calls will be deprecated by late 2009: GetPictureManagerDetails, GetPictureManagerOptions, and SetPictureManagerDetails.
As announced, eBay will retire Now & New (Sofort & Neu) by March 2009.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 599.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 599 and Changed Functionality - 599.
The following documentation sections have been modified to fix errors or clarify information:
No 597 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 595
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
ItemType.InventoryTrackingMethod |
Element | New |
As announced, starting December 31, 2008, eBay will no longer offer eBay Live Auctions. The corresponding functionality in the API also will be retired.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 595.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 595 and Changed Functionality - 595.
For additions to the Trading API Guide regarding affiliate commissions through use of PlaceOffer, please see the PlaceOffer Policies and Guidelines.
No 593 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 591
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
No schema changes in this release.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 591.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Updated Nov. 26: As recently announced in the eBay Developers Program blog, eBay's Large Merchant APIs are now in Beta. Large Merchant Services offer a powerful new way to list and manage items in bulk. These APIs can save developers processing power and bandwidth, and allow sellers to react quickly to marketplace dynamics.
The Trading API can be used in conjunction with eBay's Large Merchant Services (LMS) to complete your large merchant solution. The Merchant Data API (in LMS) defines two requests for creating new listings: AddFixedPriceItem and RelistFixedPriceItem. When you create a listing with these requests, you can optionally use an InventoryTrackingMethod field to choose whether you prefer to track the listing by item ID or by your own unique SKU. If you track by SKU, it means you can pass your SKU instead of the item ID in subsequent Merchant Data API requests, such as ReviseFixedPriceItem, and in several Trading API calls. The Trading API's AddItem and RelistItem calls do not offer the inventory tracking preference. However, you can use GetItem, GetSellerList, GetSellerTransactions, and other Trading API calls to retrieve data about these listings and transactions. ReviseInventoryStatus also supports tracking listings by SKU.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 591 and Changed Functionality - 591.
None for this release.
Documentation Changes and Errata - 589
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingPackageDetailsType.Default |
Entity | Removed |
AddItemFromSellingManagerTemplateRequestType |
Complex type | New |
AddItemFromSellingManagerTemplateResponseType |
Complex type | New |
AddSellingManagerInventoryFolderRequestType |
Complex type | New |
AddSellingManagerInventoryFolderResponseType |
Complex type | New |
AddSellingManagerProductRequestType |
Complex type | New |
AddSellingManagerProductResponseType |
Complex type | New |
AddSellingManagerTemplateRequestType |
Complex type | New |
AddSellingManagerTemplateResponseType |
Complex type | New |
DeleteSellingManagerInventoryFolderRequestType |
Complex type | New |
DeleteSellingManagerInventoryFolderResponseType |
Complex type | New |
DeleteSellingManagerItemAutomationRuleRequestType |
Complex type | New |
DeleteSellingManagerItemAutomationRuleResponseType |
Complex type | New |
DeleteSellingManagerProductRequestType |
Complex type | New |
DeleteSellingManagerProductResponseType |
Complex type | New |
DeleteSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
DeleteSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
DeleteSellingManagerTemplateRequestType |
Complex type | New |
DeleteSellingManagerTemplateResponseType |
Complex type | New |
GetSellingManagerAlertsRequestType |
Complex type | New |
GetSellingManagerAlertsResponseType |
Complex type | New |
GetSellingManagerEmailLogRequestType |
Complex type | New |
GetSellingManagerEmailLogResponseType |
Complex type | New |
GetSellingManagerInventoryFolderRequestType |
Complex type | New |
GetSellingManagerInventoryFolderResponseType |
Complex type | New |
GetSellingManagerInventoryRequestType |
Complex type | New |
GetSellingManagerInventoryResponseType |
Complex type | New |
GetSellingManagerItemAutomationRuleRequestType |
Complex type | New |
GetSellingManagerItemAutomationRuleResponseType |
Complex type | New |
GetSellingManagerSaleRecordRequestType |
Complex type | New |
GetSellingManagerSaleRecordResponseType |
Complex type | New |
GetSellingManagerSoldListingsRequestType |
Complex type | New |
GetSellingManagerSoldListingsResponseType |
Complex type | New |
GetSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
GetSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
GetSellingManagerTemplatesRequestType |
Complex type | New |
GetSellingManagerTemplatesResponseType |
Complex type | New |
InventoryStatusType |
Complex type | New |
MoveSellingManagerInventoryFolderRequestType |
Complex type | New |
MoveSellingManagerInventoryFolderResponseType |
Complex type | New |
ReviseInventoryStatusRequestType |
Complex type | New |
ReviseInventoryStatusResponseType |
Complex type | New |
ReviseSellingManagerInventoryFolderRequestType |
Complex type | New |
ReviseSellingManagerInventoryFolderResponseType |
Complex type | New |
ReviseSellingManagerProductRequestType |
Complex type | New |
ReviseSellingManagerProductResponseType |
Complex type | New |
ReviseSellingManagerSaleRecordRequestType |
Complex type | New |
ReviseSellingManagerSaleRecordResponseType |
Complex type | New |
ReviseSellingManagerTemplateRequestType |
Complex type | New |
ReviseSellingManagerTemplateResponseType |
Complex type | New |
SaveItemToSellingManagerTemplateRequestType |
Complex type | New |
SaveItemToSellingManagerTemplateResponseType |
Complex type | New |
SellingManagerAlertType |
Complex type | New |
SellingManagerAutoListAccordingToScheduleType |
Complex type | New |
SellingManagerAutoListMinActiveItemsType |
Complex type | New |
SellingManagerAutoListType |
Complex type | New |
SellingManagerAutoRelistType |
Complex type | New |
SellingManagerAutoSecondChanceOfferType |
Complex type | New |
SellingManagerDetailsType |
Complex type | New |
SellingManagerEmailLogType |
Complex type | New |
SellingManagerFolderDetailsType |
Complex type | New |
SellingManagerOrderStatusType |
Complex type | New |
SellingManagerProductInventoryStatusType |
Complex type | New |
SellingManagerProductType |
Complex type | New |
SellingManagerSearchType |
Complex type | New |
SellingManagerSoldOrderType |
Complex type | New |
SellingManagerSoldTransactionType |
Complex type | New |
SellingManagerTemplateDetailsArrayType |
Complex type | New |
SellingManagerTemplateDetailsType |
Complex type | New |
SellingManagerVendorDetailsType |
Complex type | New |
SetSellingManagerItemAutomationRuleRequestType |
Complex type | New |
SetSellingManagerItemAutomationRuleResponseType |
Complex type | New |
SetSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
SetSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
TimeRangeType |
Complex type | New |
VATRateType |
Complex type | New |
DayOfWeekCodeType |
Enumerated type | New |
SellingManagerAlertTypeCodeType |
Enumerated type | New |
SellingManagerAutoRelistOptionCodeType |
Enumerated type | New |
SellingManagerAutoRelistTypeCodeType |
Enumerated type | New |
SellingManagerAutoSecondChanceOfferTypeCodeType |
Enumerated type | New |
SellingManagerAutomationPropertyTypeCodeType |
Enumerated type | New |
SellingManagerEmailSentStatusCodeType |
Enumerated type | New |
SellingManagerEmailTypeCodeType |
Enumerated type | New |
SellingManagerGeneralPropertyTypeCodeType |
Enumerated type | New |
SellingManagerInventoryPropertyTypeCodeType |
Enumerated type | New |
SellingManagerPaidStatusCodeType |
Enumerated type | New |
SellingManagerPaisaPayPropertyTypeCodeType |
Enumerated type | New |
SellingManagerProductSortCodeType |
Enumerated type | New |
SellingManagerSearchTypeCodeType |
Enumerated type | New |
SellingManagerShippedStatusCodeType |
Enumerated type | New |
SellingManagerSoldListingsPropertyTypeCodeType |
Enumerated type | New |
SellingManagerSoldListingsSortTypeCodeType |
Enumerated type | New |
UnpaidItemStatusTypeCodeType |
Enumerated type | New |
GetItemRequestType.SKU |
Element | New |
GetSellerTransactionsRequestType.InventoryTrackingMethod |
Element | New |
ItemTransactionIDType.SKU |
Element | New |
ItemType.PaymentAllowedSite |
Element | New |
SellingManagerProductDetailsType.FolderID |
Element | New |
SellingManagerProductDetailsType.Note |
Element | New |
SellingManagerProductDetailsType.RestockAlert |
Element | New |
SellingManagerProductDetailsType.RestockThreshold |
Element | New |
SellingManagerProductDetailsType.VendorInfo |
Element | New |
SendInvoiceRequestType.SKU |
Element | New |
ShippingPackageDetailsType.DefaultValue |
Element | New |
FeatureIDCodeType.IntangibleEnabled |
Enum | New |
NotificationEventTypeCodeType.BulkDataExchangeJobCompleted |
Enum | New |
StoreItemListSortOrderCodeType.HighestPricedPlusShipping |
Enum | New |
StoreItemListSortOrderCodeType.LowestPricedPlusShipping |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 589.
This Trading API release contains a preview of calls related to Selling Manager and Selling Manager Pro. These calls will be available in 2009 for Open eBay participants who are building applications related to Selling Manager and Selling Manager Pro. For more information about Open eBay, please see http://developer.ebay.com/echo.
As stated in the description of each call in the Call Reference, these calls are unsupported and are currently available only to Open eBay pilot participants. These calls are subject to change without notice; the deprecation process is inapplicable to these calls.
For information about Selling Manager and Selling Manager Pro, please see http://pages.ebay.com/selling_manager_pro and http://pages.ebay.com/selling%5Fmanager.
More information about these calls will be provided in 2009. For the names of the new calls, please see the New Calls section, above.
The Item.PaymentAllowedSite field, which can be returned by GetItem, enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.
By March 2009, a Payflow account (obtainable in January 2009 in My eBay) will be required when sellers on the US site offer credit cards (Visa, MasterCard, American Express, and Discover).
For general information about specifying payment methods, see Payment Method Differences. For information on payment changes on the US site, see August Payments Policy Changes.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
When sellers first list fixed-price items, their search ranking is determined by seller qaulity (DSRs) and title relevance. Best Match search ranking also takes into account buyer activity. When items in a listing begin to sell, the Resent Sales History factors into search ranking. Items that sell the fastest are given a relative lift in search results.
Recent Sales history is tracked with a moving window to ensure it reflects the most recent activity. Due to the moving window, it is advantageous for sellers to maintain item availability for a GTC listing (that is, keep quanitity from dropping too low), or to relist as quickly as possible when an item ends (recent sales scores can be transferred to the relisted item). Refer to How the Moving Window Affects Recent Sales in the Developers Program Community Blog for more information.
ShippingPackageDetailsType.Default (returned by GeteBayDetails) was deprecated with version 589. DefaultValue is its replacement. The API returns only DefaultValue for versions greater than or equal to 589. The API returns both Default and DefaultValue for versions lower than 589. We recommend that you change your application to handle the return of DefaultValue.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 589 and Changed Functionality - 589.
In the Call Reference, the Item.PictureDetails.PictureURL field has been removed from the output of GetSearchResults, as a documentation correction.
Documentation Changes and Errata - 587
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
SellingManagerProductDetailsType.PartNumber |
Entity | Removed (unused by calls) |
SellingManagerProductDetailsType.ProductPartNumber |
Entity | Removed (unused by calls) |
ShippingPackageDetailsType.DimensionsSupported |
Element | New |
ShippingServiceDetailsType.ShippingServicePackageDetails |
Element | New |
ShippingServiceDetailsType.WeightRequired |
Element | New |
ShipmentDeliveryStatusCodeType.Error |
Enum | Reserved for future use |
ShipmentDeliveryStatusCodeType.Unconfirmed |
Enum | Reserved for future use |
ShipmentDeliveryStatusCodeType.Unknown |
Enum | Reserved for future use |
ShippingServiceCodeType.CA_PostExpeditedFlatRateBox |
Enum | New |
ShippingServiceCodeType.CA_PostExpeditedFlatRateBoxUSA |
Enum | New |
TransactionPlatformCodeType.WorldOfGood |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 587.
WorldOfGood has been added as a TransactionPlatformCodeType value. It is returned by GetItemTransactions, GetMyeBayBuying, GetMyeBaySelling, GetOrderTransactions, and GetSellerTransactions.
If you are still using Item.AttributeSetArray instead of Item.ReturnPolicy to specify a return policy, you can now pass -10 in ValueID and ReturnsNotAccepted in ValueLiteral to specify "Returns Not Accepted" in AddItem. This value was available on the US site in early October. It should be available on international sites in late October. See the eBay Developer Newsletter and blog for updates on when sellers will be required to specify a return policy.
Please note that GetAttributesCS has not been updated to mirror the latest changes to the Return Policy fields that each site supports. For example, GetAttributesCS does not return the -10 value for "Returns Not Accepted", but AddItem does accept this value. GetAttributesCS also may show return policy attributes or values that are no longer applicable on some sites. If you pass inapplicable attributes or values in AddItem, they will be dropped, and a warning may be returned.
Featured First is a paid feature that sellers may purchase for individual listings to get a chance to increase exposure. It is currently available for the following sites: US (0 - not Motors), Canada (2), Canada (French) (210), UK (3), Ireland (205), Germany (77), Austria (16), Switzerland (193), and Italy (101). Featured First gives you an opportunity, but no guarantee, to have your listing appear on the first page of search results in the Featured Items section.
With Featured First:
See the Featured First online help page for more information.
As part of this change, Featured Plus now behaves slightly differently for browse functionality. When browsing, instead of all Featured Plus items being shown prior to any non-featured items, Featured Plus items are now shown in real time, at the top of the page they would normally show up on. The behavior for keyword searching has not changed.
See the Featured Plus online help page for more information.
The Featured First option is selected by specifying Featured in the PictureDetails.GalleryType field. The behavior of your listing within the search results is determined as follows:
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
eBay has simplified (reduced) the list of package types for the shipping calculator. If a seller relists or revises an item with a deprecated package type, eBay will automatically map the deprecated package type to an appropriate active package type. Simplification of the package types only applies to the shipping calculator for the eBay US site and eBay Motors Parts and Accessories.
In the future, eBay will require sellers to provide package dimensions for the shipping calculator when it is used for large packages, irregular sized packages, and all the UPS air services for packages.
If a seller provides package dimensions for a service that does not require dimensions, eBay will use the dimensions to more accurately calculate shipping rates. We encourage sellers to provide package dimensions whenever possible so that shipping rates are more accurate for buyers. (If dimensions are omitted, eBay uses a set of default values for rate calculations.)
Developer impact
587:
In the future:
Affected calls: GeteBayDetails and the AddItem family of calls.
To learn about the shipping calculator, see GetItemShipping documentation.
The shipping mechanisms discussed in the 585 Release Notes will go into effect for eBay DE around November 4. eBay DE is currently the only site for which the GroupN style of elements apply.
See Schema Changes for a list of new shipping services.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 587 and Changed Functionality - 587.
None for this release.
Documentation Changes and Errata - 585
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
BuyerPaymentMethodCodeType.Moneybookers |
Entity | Removed |
BuyerPaymentMethodCodeType.allpay |
Entity | Removed |
AddItemRequestContainerType |
Complex type | New |
AddItemResponseContainerType |
Complex type | New |
AddItemsRequestType |
Complex type | New |
AddItemsResponseType |
Complex type | New |
EndItemRequestContainerType |
Complex type | New |
EndItemResponseContainerType |
Complex type | New |
EndItemsRequestType |
Complex type | New |
EndItemsResponseType |
Complex type | New |
Group1MaxFlatShippingCostDefinitionType |
Complex type | New |
Group2MaxFlatShippingCostDefinitionType |
Complex type | New |
Group3MaxFlatShippingCostDefinitionType |
Complex type | New |
MaxFlatShippingCostCBTExemptDefinitionType |
Complex type | New |
MaxFlatShippingCostDefinitionType |
Complex type | New |
PaymentMethodDefinitionType |
Complex type | New |
ShippingServicePackageDetailsType |
Complex type | New |
CostGroupFlatCodeType |
Enumerated type | New |
CategoryFeatureType.Group1MaxFlatShippingCost |
Element | New |
CategoryFeatureType.Group2MaxFlatShippingCost |
Element | New |
CategoryFeatureType.Group3MaxFlatShippingCost |
Element | New |
CategoryFeatureType.PaymentMethod |
Element | New |
FeatureDefinitionsType.Group1MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.Group2MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.Group3MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.MaxFlatShippingCostCBTExempt |
Element | New |
FeatureDefinitionsType.PaymentMethod |
Element | New |
FeedbackDetailType.FeedbackRevised |
Element | New |
ShippingServiceDetailsType.CostGroupFlat |
Element | New |
SiteDefaultsType.Group1MaxFlatShippingCost |
Element | New |
SiteDefaultsType.Group2MaxFlatShippingCost |
Element | New |
SiteDefaultsType.Group3MaxFlatShippingCost |
Element | New |
SiteDefaultsType.PaymentMethod |
Element | New |
FeatureIDCodeType.Group1MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.Group2MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.Group3MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.MaxFlatShippingCostCBTExempt |
Enum | New |
FeatureIDCodeType.PaymentMethods |
Enum | New |
ShippingServiceCodeType.CA_PriorityWorldwide |
Enum | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
As announced in Version 583, eBay is imposing limits on shipping costs for selected categories.
Starting October 8, this cost threshold applies to items listed on the eBay US site (regardless of whether shipping within or shipping into the US) for items in the Books, Movies & DVDs, Music, and Video Games categories. (Items listed on other sites yet shipped into the US are not limited by these thresholds.)
For details, see Maximum Flat Rate Shipping Cost in the Specifying Shipping Costs portion of the Shipping documentation. (If you read the Version 583 documentation, please note that there is no MaxFlatShippingCostEnabled element and that the *Cost elements may be returned in both the SiteDefaults and Category containers.)
Rollout schedule:
Affected calls: GetCategoryFeatures, GeteBayDetails, the AddItem family of calls.
Beginning in late October 2008, you can use ProPay as a payment method for listings on the US site. You also can use PayOnPickup for cases of cash on pickup.
For general information about specifying payment methods, see Payment Method Differences. For information on payment changes on the US site, see August Payments Policy Changes.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 585.
As previously announced, changes are occurring in the allowed payment methods for listings. Please use GetCategoryFeatures to determine the available payment methods for a site or category. For more information, see Payment Method Differences. Please also note that, as previously announced, you can use GetCategoryFeatures to determine if a listing must include PayPal as a payment method.
AddItems is a new batch listing call. It will list up to five(5) items per request.
EndItems is another new batch call. It will end up to ten(10) items early.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 585 and Changed Functionality - 585.
ShippedTime was added to ShipmentType on version 583. This was not mentioned in 583 release notes.
Documentation Changes and Errata - 583
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
InventoryTrackingMethodCodeType |
Enumerated type | New |
AbstractResponseType.ExternalUserData |
Element | New |
CategoryFeatureType.MaxFlatShippingCost |
Element | New |
NotificationUserDataType.ExternalUserData |
Element | New |
ShipmentType.ShippedTime |
Element | New |
SiteDefaultsType.MaxFlatShippingCost |
Element | New but deprecated (Do not use) |
SiteDefaultsType.MaxFlatShippingCostCBTExempt |
Element | New |
BuyerPaymentMethodCodeType.Moneybookers |
Enum | New |
BuyerPaymentMethodCodeType.PayOnPickup |
Enum | New |
BuyerPaymentMethodCodeType.ProPay |
Enum | New |
BuyerPaymentMethodCodeType.allpay |
Enum | New |
QuestionTypeCodeType.None |
Enum | New |
ShippingCarrierCodeType.Nacex |
Enum | New |
As previously announced, starting in September 2008, on the Australia site, sellers and bidders will be unable to retrieve each other's email addresses unless they are in a transactional relationship.
The Bid Assistant feature will be removed from the eBay site, and related API elements such as BidAssistantList and BidGroupArrayType that are used in the GetMyeBayBuying call, as well as BidGroupItemStatusCodeList, BidGroupItemType, BidGroupStatusCodeList, BidGroupType, and BidRangeType, will be decremented in the beginning of October.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 583.
"Total flat rate shipping cost" is the sum of the seller's base flat rate shipping charge and the cost of insurance (if insurance is required by the seller). Starting in October, there will be certain categories in which a listing with flat rate shipping can be created only if the total cost of shipping matches or is below the maximum shipping cost set by eBay for the category that the listing is in.
This cost threshold will initially apply only to items listed on the eBay US site (regardless of whether shipping within or shipping into the US) for items in the Books, Movies & DVDs, Music, and Video Games categories. (Items listed on other sites yet shipped into the US are not limited by these thresholds.)
You can start learning about the future API mechanism now by reading Maximum Flat Rate Shipping Cost in the Specifying Shipping Costs portion of the Shipping documentation.
Rollout schedule:
A new field, HideDuplicateItems, has been added to GetCategoryListings, GetProducts, and GetSearchResults to suppress duplicate item listings from search results. When HideDuplicateItems is set to true in the request, duplicate item listings will not be returned in the response. If duplicate items were filtered from the search results, then DuplicateItems will be returned in the response with a value of true.
Items are considered duplicates when all of the following conditions are met:
The listing format for the duplicate and the original item listing must both fall into the same basic type of listing:
HideDuplicateItems is optional and defaults to false if not specified.
In the 565 release, changes were made to treat Store Inventory Format (StoresFixedPrice)items as basic fixed price (FixedPriceItem) items on the Italy site. This change is now extended to many more eBay sites. Starting mid-September, these changes will be available on the following eBay sites: US, US Motors, CA and CA-FR. Use GetCategoryFeatures with FeatureID set to CombinedFixedPriceTreatment to determine whether a given site or category are affected.
Additional changes for fixed price listings include:
FixedPriceItem) listings and Store inventory format (StoresFixedPrice) listings on the eBay Italy site. Listing durations of 30 days and "Good Til Cancelled" (GTC) are being allowed for store subscribers and non-store subscribers for basic fixed price and Store inventory format listings on additional sites and categories. Use GetCategoryFeatures with FeatureID set to ListingDurations to determine the standard listing durations allowed for a given site or category. Set FeatureID set to StoreOwnerExtendedListingDurationsEnabled to determine whether a given site or category supports extended listing durations for store owners. Set FeatureID to StoreOwnerExtendedListingDurations to get any extended durations.FixedPriceItem and StoresFixedPrice) listings. Use GetCategoryFeatures with FeatureID set to PayPalRequiredForStoreOwner to determine whether store owners must offer PayPal as a payment method for fixed price listings on a given site or category.ReviseQuantityAllowed or RevisePriceAllowed to determine whether quantity or price for fixed price listings can be revised at any time, despite standard restrictions.Please refer to the 565 release notes for additional information for these changes.
In the 565 release, the ability for sellers to specify the duration for Featured First (known as Gallery Featured on other eBay sites) was made available on the eBay Italy site. Starting in October, this feature will be supported by additional eBay sites. Use GetCategoryFeatures with FeatureID set to GalleryFeaturedDurations to determine whether a given site or category are affected. Please refer to the 565 release notes for additional information for these changes.
The new SetSellingManagerFeedbackOptions call allows Selling Manager and Selling Manager Pro subscribers to store up to ten comments that can be left as feedback to buyers. Selling Manager Pro subscribers can use AutomatedLeaveFeedbackEvent to specify an event that will trigger automated feedback to buyers.
A new field, ExternalUserData, is added to NotificationUserDataType in Set/GetNotificationPreferences requests, and to AbstractResponseType. The field is an XML-compliant string, not to exceed 256 characters. An example use case for this field is to set a third-party user-identifier string that will be returned with each notification payload. Please use due caution and encryption if you are passing any sensitive information
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Nacex and Correos were added to ShippingCarrierCodeType for domestic shipping for eBay Spain.
As previously announced, eBay will require all listings to specify a return policy and handling time (dispatch time) in Q1 2009. As some sellers may need to modify existing GTC (Good 'Til Canceled) listings to support these requirements, you can now use ReviseItem to add a return policy and/or dispatch time to an existing GTC listing, even when it has sales.
When Messages.Message.MessageType isn't set to AskSellerQuestion, a new value of None (in Message.QuestionType) is returned.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 583 and Changed Functionality - 583.
None for this release.
Documentation Changes and Errata - 581
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
FeedbackCommentArrayType |
Complex type | New |
HandlingTimeEnabledDefinitionType |
Complex type | New |
PayPalRequiredForStoreOwnerDefinitionType |
Complex type | New |
RefundDetailsType |
Complex type | New |
ReturnPolicyDetailsType |
Complex type | New |
ReturnPolicyEnabledDefinitionType |
Complex type | New |
ReturnPolicyType |
Complex type | New |
ReturnsAcceptedDetailsType |
Complex type | New |
ReturnsWithinDetailsType |
Complex type | New |
RevisePriceAllowedDefinitionType |
Complex type | New |
ReviseQuantityAllowedDefinitionType |
Complex type | New |
SetSellingManagerFeedbackOptionsRequestType |
Complex type | New |
SetSellingManagerFeedbackOptionsResponseType |
Complex type | New |
ShippingCostPaidByDetailsType |
Complex type | New |
StoreOwnerExtendedListingDurationsDefinitionType |
Complex type | New |
StoreOwnerExtendedListingDurationsEnabledDefinitionType |
Complex type | New |
StoreOwnerExtendedListingDurationsType |
Complex type | New |
WarrantyDurationDetailsType |
Complex type | New |
WarrantyOfferedDetailsType |
Complex type | New |
WarrantyTypeDetailsType |
Complex type | New |
AutomatedLeaveFeedbackEventCodeType |
Enumerated type | New |
RefundOptionsCodeType |
Enumerated type | New |
ReturnsAcceptedOptionsCodeType |
Enumerated type | New |
ReturnsWithinOptionsCodeType |
Enumerated type | New |
ShippingCostPaidByOptionsCodeType |
Enumerated type | New |
WarrantyDurationOptionsCodeType |
Enumerated type | New |
WarrantyOfferedCodeType |
Enumerated type | New |
WarrantyTypeOptionsCodeType |
Enumerated type | New |
CategoryFeatureType.HandlingTimeEnabled |
Element | New |
CategoryFeatureType.PayPalRequiredForStoreOwner |
Element | New |
CategoryFeatureType.ReturnPolicyEnabled |
Element | New |
CategoryFeatureType.RevisePriceAllowed |
Element | New |
CategoryFeatureType.ReviseQuantityAllowed |
Element | New |
CategoryFeatureType.StoreOwnerExtendedListingDurations |
Element | New |
CategoryFeatureType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
FeatureDefinitionsType.HandlingTimeEnabled |
Element | New |
FeatureDefinitionsType.PayPalRequiredForStoreOwner |
Element | New |
FeatureDefinitionsType.ReturnPolicyEnabled |
Element | New |
FeatureDefinitionsType.RevisePriceAllowed |
Element | New |
FeatureDefinitionsType.ReviseQuantityAllowed |
Element | New |
FeatureDefinitionsType.StoreOwnerExtendedListingDurations |
Element | New |
FeatureDefinitionsType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
GetCategoryListingsRequestType.HideDuplicateItems |
Element | New |
GetCategoryListingsResponseType.DuplicateItems |
Element | New |
GetProductsRequestType.HideDuplicateItems |
Element | New |
GetProductsResponseType.DuplicateItems |
Element | New |
GetSearchResultsRequestType.HideDuplicateItems |
Element | New |
GetSearchResultsResponseType.DuplicateItems |
Element | New |
GeteBayDetailsResponseType.ReturnPolicyDetails |
Element | New |
ItemType.ReturnPolicy |
Element | New |
SiteDefaultsType.HandlingTimeEnabled |
Element | New |
SiteDefaultsType.PayPalRequiredForStoreOwner |
Element | New |
SiteDefaultsType.ReturnPolicyEnabled |
Element | New |
SiteDefaultsType.RevisePriceAllowed |
Element | New |
SiteDefaultsType.ReviseQuantityAllowed |
Element | New |
SiteDefaultsType.StoreOwnerExtendedListingDurations |
Element | New |
SiteDefaultsType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
UserType.EnterpriseSeller |
Element | Reserved for future use |
DetailNameCodeType.ReturnPolicyDetails |
Enum | New |
FeatureIDCodeType.HandlingTimeEnabled |
Enum | New |
FeatureIDCodeType.PayPalRequiredForStoreOwner |
Enum | New |
FeatureIDCodeType.ReturnPolicyEnabled |
Enum | New |
FeatureIDCodeType.RevisePriceAllowed |
Enum | New |
FeatureIDCodeType.ReviseQuantityAllowed |
Enum | New |
FeatureIDCodeType.StoreOwnerExtendedListingDurations |
Enum | New |
FeatureIDCodeType.StoreOwnerExtendedListingDurationsEnabled |
Enum | New |
As announced in the eBay Developers Program blog, eBay has added or will soon be adding a number of new requirements for eBay listings. These include:
In the new View Item page, the user description is hosted by eBay on a different domain and loaded into an iFrame for display on the View Item page. This helps eBay to separate user content from eBay content, and protects users from content that could be harmful. With this change, your scripts will only be allowed to modify and control your item description and the area it occupies.
eBay has implemented this in a way that will not impact your SEO.
Here are some steps you can take to make sure your content appears as expected inside an iFrame.
Content Dimensions
File Linking
Content Validity
See also the blog post and commentary on the View Item page domain split.
For details on sizing pictures in the new View Item page, see this blog post.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 581.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
As previously announced in the blog, on the US site starting in October 2008, only four payment methods will be permitted in most categories. See the blog post on Paperless Payments for preliminary details. For general information about specifying payment methods, see Payment Method Differences.
By October 2008, most categories will require the seller to specify how long it will take the seller to ship an item after receiving cleared payment. This handling time (dispatch time) does not not include the shipping time itself (the time in transit). Use GetCategoryFeatures to determine which categories require a handling time. See Handling Time and Estimated Delivery Time.
In Q1 2009, most categories will require the seller to specify a return policy. Use GetCategoryFeatures to determine which categories require a return policy, and use GeteBayDetails to determine the return policy options each site supports. See Offering a Clear Return Policy.
To make return policies easier to specify, we have added a new ReturnPolicy node in the AddItem and GetItem families of calls. The new node will be functional in mid-September 2008.
You will no longer need to use the Attribute API to specify return policy details. However, the Attribute format will still be supported as input to the AddItem family of calls until after the 2008 holiday season. Please note that some sites have added a new "Return shipping will be paid by" attribute (3993) with two values: Buyer (81120) and Seller (81121). Some sites have also added an "Item must be returned within" value of 60 days (95148). GetItem no longer returns the Return Policy attributes, regardless of your request version.
As previously announced, sellers on the US site now are required to specify at least one domestic shipping service (exception: freight shipping). For those who intend to not ship an item (that is, local pickup only), a special "shipping service" has been created for the purpose of local pickup only. For more information, see Specifying Shipping Costs.
France joins several other European Union countries where users who have sold more than 2000 EUR a month over a period of three months will have to update their account type from 'personal' to 'business'. They will receive an error message if they try to use one of the AddItem family of API calls if their account is not defined or if it has been flagged as 'business required'.
For business accounts, a return policy is required.
See Changes for Business Sellers in Release 549 for more information.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 581 and Changed Functionality - 581.
None for this release.
Documentation Changes and Errata - 579
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
AuthenticationEntryArrayType |
Entity | Removed |
AuthenticationEntryType |
Entity | Removed |
CartItemArrayType |
Entity | Removed |
CartType |
Entity | Removed |
CheckoutCompleteRedirectType |
Entity | Removed |
ConditionSelectionCodeType |
Entity | Removed |
DomainHistogramType |
Entity | Removed |
ExpressDetailLevelCodeType |
Entity | Removed |
ExpressHistogramSortCodeType |
Entity | Removed |
ExpressItemSortCodeType |
Entity | Removed |
ExpressProductSortCodeType |
Entity | Removed |
GetCartRequestType |
Entity | Removed |
GetCartResponseType |
Entity | Removed |
GetExpressWishListRequestType |
Entity | Removed |
GetExpressWishListResponseType |
Entity | Removed |
GetItemRequestType.IncludeExpressRequirements |
Entity | Removed |
GetSearchResultsExpressRequestType |
Entity | Removed |
GetSearchResultsExpressResponseType |
Entity | Removed |
GetUserPreferencesResponseType.ExpressPreferences |
Entity | Removed |
ItemType.ExpressDetails |
Entity | Removed |
ItemType.ExpressOptOut |
Entity | Removed |
ListingDetailsType.ExpressItemRequirements |
Entity | Removed |
ListingDetailsType.ExpressListing |
Entity | Removed |
ProductArrayType |
Entity | Removed |
SellerType.ExpressEligible |
Entity | Removed |
SellerType.ExpressSellerRequirements |
Entity | Removed |
SellerType.ExpressWallet |
Entity | Removed |
SetCartRequestType |
Entity | Removed |
SetCartResponseType |
Entity | Removed |
SetUserPreferencesRequestType.ExpressPreferences |
Entity | Removed |
WishListSortCodeType |
Entity | Removed |
WishListType |
Entity | Removed |
CharityInfoType.DisplayNameInCheckout |
Element | New |
By the end of September 2008, US eBay Express will be shut down. Any eBay Fixed Price and/or Store Inventory listings that appear on both eBay and US eBay Express will be removed from US eBay Express. These listings will remain active on eBay.com. The UK and Germany eBay Express sires were shut down in April 2008.
The following eBay Express-specific API calls (and related schema) have been deprecated as of release 579:
With request versions lower than 579, the calls will continue to work. However, regardless of the request version specified, the calls will stop working when the site is closed.
Please refer to the release notes and the respective Express sites for more information.
Please see the Developers Program Blog for information about recent announcements aimed at satisfying buyers and lowering upfront costs for sellers.
Starting in September 2008 on the Australia eBay site, sellers and bidders will not be able to retrieve each other's email addresses unless they are in a transactional relationship. If a listing is active, sellers will not be able to view the bidder's email address when using the following calls: GetHighBidders, GetBidderList, GetAllBidders. Please see the Anonymization of Email Addresses in Member to Member Communication section in the 573 release notes for more information.
Starting in September 2008, GetMyMessages API changes will be made available for the Australia Site. Please see the GetMyMessages Returns More Data section of the 573 release notes for details about the changes.
Also starting in September 2008 on the Australia site, the AddMemberMessageAAQToBidder call can be used for all categories and is not limited to Motors and Business & Industrial categories only.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 579.
Now you can set the DisplayNameInCheckout flag in CharityInfoType to display a nonprofit company name on the Review Your Purchase checkout page. If the user hovers the mouse over the nonprofit company name, the company's mission statement will be displayed. The value for the DisplayNameInCheckout field is returned with the GetCharities response.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Starting in late August 2008, GetAttributesCS will start returning more item condition choices for US Media listings (Books, DVDs & Movies, Music, and Video Games).
At time of this writing, we expect to support the following value names and IDs for the Condition attribute (10244) in Media-related characteristic sets:
with the following exceptions:
In general, we are reusing the previous "New" (including "New in Box" and "New, Never Opened") value IDs for "Brand New", and the previous "Used" value IDs for "Acceptable". If you leave the item condition as unspecified for Media listings, we will also map it to "Acceptable". This means that if you are using the old conditions in your listing templates, they will still work. But the value names will be different on eBay and in GetItem (as described above). To help your sellers describe their items more accurately to buyers, we recommend that you use GetAttributesCS to get the latest values and to keep them up to date.
Please note that the LookupAttribute field in AddItem does not support the new condition values. You can only specify "New" or "Used". eBay will map those values to "Brand New" or "Acceptable" as appropriate.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 579 and Changed Functionality - 579.
None for this release.
Documentation Changes and Errata - 577
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
AdFormatLeadType.FirstName |
Entity | Removed |
AdFormatLeadType.LastName |
Entity | Removed |
AdFormatLeadType.Phone |
Entity | Removed |
AdFormatLeadType.Phone2 |
Entity | Removed |
ConfirmIdentityRequestType |
Complex type | New |
ConfirmIdentityResponseType |
Complex type | New |
CompleteSaleRequestType.OrderID |
Element | New |
SellerType.StoreSite |
Element | New |
GetReturnURL |
Call | Removed |
GetRuName |
Call | Removed |
SetReturnURL |
Call | Removed |
AuthenticationEntryType |
Complex type | Removed |
AuthenticationEntryArrayType |
Complex type | Removed |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
We have made several improvements to the User Token retrieval process, and made it even easier for developers to configure and maintain their application level settings.
New features of the token retrieval process include:
Enhanced User Consent Page: the User Consent Page now supports the ability for an application to upload their Application Name, Logo, Description, and URL for display to the end user on the User Consent Page. This improvement makes the User Consent Page more friendly to new users, and provides a way for users to find out more information about the application they are authorizing. For more information, please see http://developer.ebay.com/DevZone/XML/docs/WebHelp/GettingTokens-.html.
eBay UserID Verification Option: An ID Verification option has been added to the User Consent flow, for applications that only need to confirm an eBay UserID. This option is supported at the RuName level, and allows an application to confirm an eBay UserID by taking the user through the standard User Consent Flow [also known as the Auth & Auth flow]. The application can use the ConfirmIdentity call to verify the UserID that was provided at login time. For more information, please see http://developer.ebay.com/DevZone/XML/docs/WebHelp/GettingTokens-Getting_Tokens_for_Applications_with_Multiple_Users.html.
A new configuration tool is now available on developer.ebay.com for developers to view their stored user token, manage application level Platform Notification and Client Notification settings, and customize the User Consent Page. Please try out the new tool at https://developer.ebay.com/devzone/account/appsettings/ (requires login).
With the introduction of the improved token retrieval process, the following calls are deprecated: SetReturnURL, GetReturnURL, and GetRuName.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 577.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
You can now use the CompleteSale call to designate that a multiple-item order is complete. When an OrderID is used in the CompleteSaleRequest, ItemID and TransactionID are ignored by the call. The CompleteSale status applies to the order as well as to all of the child transactions of that order.
The AddMemberMessageAAQToPartner call could previously only be used after the end of an auction/sale, which made it difficult for sellers with GTC (Good 'Til Closed) listings. Now you can use this call to contact a buyer during the active listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 577 and Changed Functionality - 577.
The documentation for GetAdFormatLeads has been updated to reflect the actual call behavior with respect to returning phone numbers for leads. For request versions 561 and later, lead phone numbers, Phone and Phone2, are returned in AdFormatLead.Address. Similarly, FirstName and FirstName are returned in AdFormatLead.Address. Phone, Phone2, FirstName, and LastName in AdFormatLeadType have been deprecated.
The schema and documentation for GetUser have been updated to include StoreSite.
Documentation Changes and Errata - 575
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetAttributesCSRequestType.DigitalDelivery |
Entity | Removed |
OrderType.DigitalDelivery |
Entity | Removed |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 575.
The GetSearchResults call returns more information. It returns the seller's UserID (Item.Seller.UserID) if IncludeFeedback is set to true in GetSearchResultsRequest.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
As of March 2008, all digital listings (downloadable goods) selling on eBay US are required to be listed in a Classified Ad format within the Everything Else > Information Product category. The previous digital delivery feature is disabled as of March 28, 2008. AddItem and related calls using the DigitalDeliveryDetails fields will fail. Remaining digital delivery fields, such as GetAttributesCSRequestType.DigitalDelivery and OrderType.DigitalDelivery, have been removed from the schema.
For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 575 and Changed Functionality - 575.
The description of this notification has been corrected to include "fixed price": "An AuctionCheckoutComplete notification is sent when a buyer completes the checkout process for an auction item or for a fixed price item."
When you call GetItemsAwaitingFeedback as a Seller, you receive a list of the items you are selling that have not received feedback, and the Buyer associated with each item. Likewise, when you call GetItemsAwaitingFeedback as a Buyer, you receive a list of the items you have purchased, and the Seller associated with each item. The Seller information, which was missing from the documentation for the GetItemsAwaitingFeedback response, is now included.
Documentation Changes and Errata - 573
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
CategoryFeatureType.DigitalDeliveryEnabled |
Entity | Removed |
DigitalDeliveryDetailsType |
Entity | Removed |
DigitalDeliveryEnabledCodeType |
Entity | Removed |
DigitalDeliveryEnabledDefinitionType |
Entity | Removed |
DigitalDeliveryMethodCodeType |
Entity | Removed |
ExpressItemRequirementsType.NoDigitalDelivery |
Entity | Removed |
FeatureDefinitionsType.DigitalDeliveryEnabled |
Entity | Removed |
GetSearchResultsRequestType.DigitalDelivery |
Entity | Removed |
ItemType.DigitalDeliveryDetails |
Entity | Removed |
SiteDefaultsType.DigitalDeliveryEnabled |
Entity | Removed |
AnnouncementMessageType |
Complex type | New |
MyMessagesExternalMessageIDArrayType |
Complex type | New |
AnnouncementMessageCodeType |
Enumerated type | New |
GetMyMessagesRequestType.ExternalMessageIDs |
Element | New |
GetMyeBayBuyingRequestType.DeletedFromLostList |
Element | New |
GetMyeBayBuyingRequestType.DeletedFromWonList |
Element | New |
GetMyeBayBuyingResponseType.DeletedFromLostList |
Element | New |
GetMyeBayBuyingResponseType.DeletedFromWonList |
Element | New |
GetMyeBaySellingRequestType.BidList |
Element | New |
GetMyeBaySellingRequestType.DeletedFromSoldList |
Element | New |
GetMyeBaySellingRequestType.DeletedFromUnsoldList |
Element | New |
GetMyeBaySellingResponseType.BidList |
Element | New |
GetMyeBaySellingResponseType.DeletedFromSoldList |
Element | New |
GetMyeBaySellingResponseType.DeletedFromUnsoldList |
Element | New |
MyMessagesMessageType.Content |
Element | New |
MyMessagesMessageType.ListingStatus |
Element | New |
MyMessagesMessageType.MessageType |
Element | New |
MyMessagesMessageType.QuestionType |
Element | New |
ShippingServiceDetailsType.DeprecationDetails |
Element | New |
ShippingServiceDetailsType.MappedToShippingServiceID |
Element | New |
ShippingServiceCodeType.BEFR_LaPosteCertifiedShipping |
Enum | New |
ShippingServiceCodeType.BEFR_LaPosteStandardShipping |
Enum | New |
ShippingServiceCodeType.BEFR_LaPosteTaxipost24h |
Enum | New |
ShippingServiceCodeType.BEFR_LaPosteTaxipostLLS |
Enum | New |
ShippingServiceCodeType.BEFR_LaPosteTaxipostSecur |
Enum | New |
ShippingServiceCodeType.BEFR_PostInternationalRegistered |
Enum | New |
ShippingServiceCodeType.BEFR_PostInternationalStandard |
Enum | New |
ShippingServiceCodeType.BEFR_TNTInternational |
Enum | New |
ShippingServiceCodeType.BENL_DePostCertifiedShipping |
Enum | New |
ShippingServiceCodeType.BENL_DePostStandardShipping |
Enum | New |
ShippingServiceCodeType.BENL_DePostTaxipost24h |
Enum | New |
ShippingServiceCodeType.BENL_DePostTaxipostLLS |
Enum | New |
ShippingServiceCodeType.BENL_DePostTaxipostSecur |
Enum | New |
ShippingServiceCodeType.BENL_OtherShippingMethods |
Enum | New |
ShippingServiceCodeType.BENL_PostInternationalRegistered |
Enum | New |
ShippingServiceCodeType.BENL_PostInternationalStandard |
Enum | New |
ShippingServiceCodeType.BENL_TNTInternational |
Enum | New |
ShippingServiceCodeType.DE_DHLPaket |
Enum | New |
ShippingServiceCodeType.DE_DHLPaketInternational |
Enum | New |
ShippingServiceCodeType.DE_DPBriefInternational |
Enum | New |
ShippingServiceCodeType.DE_DPBuecherWarensendung |
Enum | New |
ShippingServiceCodeType.DE_DPD |
Enum | New |
ShippingServiceCodeType.DE_DPDInternational |
Enum | New |
ShippingServiceCodeType.DE_Einschreiben |
Enum | New |
ShippingServiceCodeType.DE_Express |
Enum | New |
ShippingServiceCodeType.DE_ExpressInternational |
Enum | New |
ShippingServiceCodeType.DE_GLS |
Enum | New |
ShippingServiceCodeType.DE_GLSInternational |
Enum | New |
ShippingServiceCodeType.DE_HermesPaket |
Enum | New |
ShippingServiceCodeType.DE_HermesPaketInternational |
Enum | New |
ShippingServiceCodeType.DE_IloxxTransport |
Enum | New |
ShippingServiceCodeType.DE_IloxxTransportInternational |
Enum | New |
ShippingServiceCodeType.DE_Nachname |
Enum | New |
ShippingServiceCodeType.DE_Paket |
Enum | New |
ShippingServiceCodeType.DE_PaketInternational |
Enum | New |
ShippingServiceCodeType.DE_SonstigeDomestic |
Enum | New |
ShippingServiceCodeType.DE_SonstigeInternational |
Enum | New |
ShippingServiceCodeType.DE_SpecialDelivery |
Enum | New |
ShippingServiceCodeType.DE_UPS |
Enum | New |
ShippingServiceCodeType.DE_UPSInternational |
Enum | New |
As previously announced, sellers on the Germany (DE) and Spain (ES) sites must specify at least one domestic shipping service. In August, US sellers will likewise be required to specify at least one domestic shipping service (exception: freight shipping). For those who intend to not ship an item (that is, local pickup only), a special "shipping service" has been created for the purpose of local pickup only. For more information, see Specifying Shipping Costs.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 573.
If a particular shipping service will be or has been deprecated, the ShippingServiceDetails container (something that can be returned by GeteBayDetails) includes a DeprecationDetails container and a MappedToShippingServiceID.
How you use this deprecation information in your application is up to you. For example, you may choose to display a to-be-deprecated shipping service for the seller to select, or you may choose to only offer the service identified in MappedToShippingServiceID.
Response to a user selecting a deprecated service is different in the API version of the Sell/Revise/Relist Your Item flows than it is in the eBay Web site version.
For details, see Deprecated Shipping Services in the Shipping documentation.
Starting in September 2008, sellers and bidders will not be able to retrieve each other's email addresses unless they are in a transactional relationship. If a listing is active, sellers will not be able to view the bidder's email address when using the following calls: GetHighBidders, GetBidderList,GetAllBidders. This change is applicable to the Sandbox environment starting Mid-July 2008.
A seller can still view the email address of the winning bidder after the listing ends.
BidArray.Offer.User.Email will contain invalid request if an item is active and for users who are neither the winning bidder nor the seller of that item.
MemberMessage.HideSendersEmailAddress will be deprecated in sandbox environment starting mid-July 2008 and in production in September 2008.
The GetMyMessages call returns more information. It returns the status of a listing (Messages.Message.ListingStatus) when the member-to-member email question is formed. It also returns the type of message retrieved using Messages.Message.MessageType, and the context of the question sent in the email that corresponds to the subject of the message (Messages.Message.QuestionType).
The GetMyMessages call also returns the External message ID (in the Messages.Message.ExternalMessageID), which uniquely identifies a message.
Additionally, a new Content tag is returned (Messages.Message.Content). It contains the message body in plain text format.
Starting in mid July 2008, you can use GetMyeBaySelling.BidList to obtain a seller's BidList from My eBay. The BidList includes all listings with at least one bid from a seller's Active Selling view or Items I'm Selling list in My eBay.
Also, BidLists returned using GetMyeBayBuying and GetMyeBaySelling will now include FeedbackScore and FeedbackRatingStar in BidList.ItemArray.Item.Seller and BidList.ItemArray.Item.SellingStatus.HighBidder.
GetMyeBayBuying can now return a buyer's DeletedFromWonList and DeletedFromLostList which contain items won or lost and deleted from the buyer's My eBay. Furthermore, GetMyeBaySelling can now return a seller's DeletedFromSoldList and DeletedFromUnsoldList. These lists contain items that sold and items that did not sell (or were ended by the seller) which the seller has deleted from My eBay. You can use DurationInDays to return items that have been deleted up to 90 days before the present date.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
See Schema Changes for a list of new shipping services.
As of March 2008, all digital listings (downloadable goods) selling on eBay US are required to be listed in a Classified Ad format within the Everything Else > Information Product category. The previous digital delivery feature is disabled as of March 28, 2008. AddItem and related calls using the DigitalDeliveryDetails fields will fail. Most of the digital delivery fields, such as ItemType.DigitalDeliveryDetails, have been removed from the schema. All remaining digital delivery related fields will be removed in the subsequent release.
For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
Sellers who wish to continue to use the Trading API to offer digital goods can do so by setting the value of Item.ListingType to LeadGeneration and Item.ListingSubtype2 to ClassifiedAd instead (and list in the Everything Else > Information Product category). Using the Classified Ads format, sellers receive a 30-day ad at a fixed price. This solution enables sellers to continue to market their digital goods on eBay; however, because Classified Ad listings are a lead generation tool and do not result in transactions that go through eBay, Feedback cannot be exchanged between buyer and seller.
See Selling Digital Items in the eBay site help for more information and requirements for listing digitally delivered items.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 573 and Changed Functionality - 573.
None for this release.
Documentation Changes and Errata - 625
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
placeholder |
Element | New |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 625.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 625 and Changed Functionality - 625.
None for this release.
© 2005–2009 eBay Inc. All rights reserved.