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:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
The lowest supported version is 603.
To learn how versioning works in the Trading API, see eBay's Schema Versioning Strategy.
Documentation Changes and Errata - 761
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.
None for this release.
Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. The Business Policies Management API will allow sellers to create (and manage) multiple payment, shipping, and return policy profiles. Once these policy profiles are created, then sellers can just reference these profiles (using unique IDs and/or names for the profile) in the Trading API's Add/Revise/Relist family of calls, instead of passing this policy information each time they create, revise, or relist an item. By adopting and using the new Business Policy API, sellers can reduce the time they spend managing listings and can react quickly to eBay policy changes.
Overview of Business Policies Management API
There are four operations available to sellers in the Business Policies Management API: one operation to create one or more business policy profiles (addSellerProfile); one operation to modify one or more business policy profiles (setSellerProfile); one operation to retrieve one or more business policy profiles (getSellerProfiles); and one operation to delete one business policy profile (removeProfile).
For more information on the Business Policies API, see Business Policies API Users Guide
Changes to Trading API Listing Calls
In the Add/Revise/Relist family of Trading API calls, the following containers can now be used in call requests to reference and use the values of existing business policy profiles:
As part of Business Policies project, the ShippingPackageDetails container is also being introduced with Version 763. The ShippingPackageDetails container is only applicable if calculated shipping is used by the seller, however, field values are saved if this container (and its child fields) are included in a call request.
The Business Policies Management API and related Trading API containers/fields will go live to production in May 2012. At that time, the 18-month process of deprecating existing legacy Trading API containers/fields will begin. The containers/fields of the Trading API listing calls scheduled to begin this deprecation are shown below:
As of Version 763, Item.ShippingDetails.CalculatedShippingRate.OriginatingPostalCode is being hard deprecated. Sellers should use Item.PostalCode instead.
See the AddItem Call Reference (and other Add/Revise/Relist calls) for documentation on the new containers related to business policy profiles.
Retrieving Business Policy Profile Information
The business policy profiles set up for a seller's account can be retrieved by calling GetUserPreferences. In the call request, the seller includes and sets the ShowSellerProfilePreferences flag to 'true'. The SellerProfilePreferences container returned in the response will contain a SellerProfileOptedIn flag that indicates whether or not the seller has opted into Business Policies, as well as a separate SupportedSellerProfile node (containing profile ID, profile name, profile type, etc.) for each business policy profile set up for the seller's account.
The folowing Trading "Get" calls will return any payment, shipping, or return policy profiles set for the item listing:
Future Business Profiles Enhancements
The following two enhancements are scheduled for a future release of Business Policies:
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 761.
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 - 761 and Changed Functionality - 761.
None for this release.
Documentation Changes and Errata - 759
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
NonProfitAddressType |
Complex type | New |
NonProfitSocialAddressType |
Complex type | New |
AddressTypeCodeType |
Enumerated type | New |
SocialAddressTypeCodeType |
Enumerated type | New |
CharityInfoType.EIN |
Element | New |
CharityInfoType.NonProfitAddress |
Element | New |
CharityInfoType.NonProfitSecondName |
Element | New |
CharityInfoType.NonProfitSocialAddress |
Element | New |
CharityInfoType.PopularityIndex |
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 - 759.
New fields are returned in the GetCharities response, including the address of the charity organization, any social networking sites associated with the organization, the Popularity Index rating of the charity, and the EIN (Employment Identification Number).
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, eBay will complete the deprecation of ID-based attributes worldwide in 2012. Last October, we stopped supporting ID-based attributes in a number of categories that already supported custom item specifics.
We will deprecate the remaining ID-based attributes in the API according to the following schedule. (Use the newer custom item specifics format instead.)
| Date | Categories | Environment | Change | ||
|---|---|---|---|---|---|
| January 30 2012 | Vehicles | Sandbox | Custom item specifics for vehicles are available in Sandbox. See eBay Motors moving to Custom Item Specifics Framework in eBay Developer Product Updates. | ||
| Early February 2012 | Vehicles | Production | The new VIN, VINLink, VRM, VRMLink, SellerProvidedTitle, DepositType, and DepositAmount fields replace the corresponding ID-based attributes for motors vehicles on the US eBay Motors, CA, CAFR, UK, and AU sites. When you pass the older ID-based attributes for VIN, VRM, Subtitle, Deposit Type, and Deposit Amount in the AddItem family of calls (i.e., calls that list, relist, and/or revise items), eBay will migrate your listing to use the new fields instead. Until the remaining vehicle attributes are migrated to custom item specifics in Production, GetItem will continue to return both the ID-based attributes and the new fields. (The VINLink and VRMLink fields will also be returned.) |
||
| Mid-February 2012 | Various | Production | The following categories will block ID-based attributes in the AddItem family of calls on all sites. Please use custom item specifics instead (which are already supported in these categories). Existing listings in these categories have already been migrated to use custom item specifics: Cameras & Photo Cell Phones Coins Computers & Networking Consumer Electronics In addition, we plan to remove attribute metadata for the categories that were blocked in October. (Previously deprecated Return Policy attributes will also be removed starting in February.)
Attribute Documentation Changes: In the Trading API Guide, we will begin removing details about listing with ID-based attributes. The information will continue to be available in archived documents for your reference. Newer applications should use custom item specifics instead of ID-based attributes. See Working with Custom Item Specifics. |
||
| March 30, 2012 | Vehicles | Production | Motor vehicle categories on the US, CA, CAFR, UK, and AU sites will begin to support custom item specifics in Production. When you pass the older ID-based vehicle attributes in the AddItem family of calls, eBay will migrate your listing to use custom item specifics instead (or the appropriate vehicle fields described above, such as SellerProvidedTitle). Once this full migration has occurred for a listing, GetItem will only return the custom item specifics (not the attributes you passed in). Motors dealer 30-day auto-renewed listings will be migrated at the time of auto-renewal. Attribute Documentation Changes: In or near release 767, we will make the following documentation changes:
|
||
| May 15, 2012 | Vehicles | Production | Migration will be completed. All vehicle listings will use the vehicle fields and custom item specifics. The AddItem family of calls will continue to convert ID-based attributes that you pass in listing requests, but we strongly recommend that you update your applications to use the vehicle fields and custom item specifics as soon as possible. | ||
| June 2012 | All categories | Production | ID-based attributes will no longer be used in any listings on any eBay site. The Trading API's sell-side product metadata and product search calls will continue to be supported for product ID searches for now. However, we may remove attributes in categories where they have been deprecated. This means some metadata from GetCategory2CS and GetProductSellingPages may be removed at any time. We recommend that you stop relying on product metadata and search calls in the Trading API as soon as possible:
|
||
| TBD | All categories | Production | In the future, we will block ID-based attributes for additional categories, as we did in October 2011 and February 2012. Applications that still use ID-based attributes should convert to custom item specifics as soon as possible. |
Beginning with Version 759, a warning message will be returned if a listing is created or revised in Sandbox (using Add/Revise/Relist family of API calls) with RefundOption and/or ReturnsWithinOption values that are being deprecated in 2012. And starting with the Spring Seller Release in early May 2012, listings created with these same values will be blocked.
For RefundOption, the values being deprecated are MerchandiseCredit and Exchange. GeteBayDetails already stopped returning these options in Sandbox, and these values will stop being returned in Production in May 2012. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.
For ReturnsWithinOption, the values being deprecated are Days_3 and Days_7. GeteBayDetails already stopped returning these options in Sandbox, and these values will stop being returned in Production in May 2012. Instead of these deprecated values, the seller must offer a 10-day, 14-day, 30-day, or 60-day return window.
We'll continue to support ReturnsNotAccepted as a policy. However, even if you specify ReturnsNotAccepted, buyers may still return an item if the item is significantly not as described (SNAD) in the listing. Buyers in the US, UK, and Germany can open an eBay Buyer Protection case for SNAD items.
Here is the current timeline for warning messages and blocked listings:
| Date | Environment | Change |
|---|---|---|
| February 6, 2012 | Sandbox | Warning message returned if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| February 20, 2012 | Sandbox | Listings are blocked if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| February 29, 2012 | Production | Warning message returned if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| May 2, 2012 | Production | Listings are blocked if deprecated RefundOption and/or ReturnsWithinOption values are used. |
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 759 and Changed Functionality - 759.
Added a note about new DE and AT sellers not being able to use ReviseCheckoutStatus to change the status of orders subject to the new payment process.
Previously, the GetBestOffers documentation stated that you only needed the BestOfferID to retrieve details about a Best Offer, but you actually need the BestOfferID and the ItemID.
Documentation Changes and Errata - 757
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.
| Name | Part of Schema | Type of Change | Note |
|---|---|---|---|
ItemType.VINLink |
Element | New | Not operational |
ItemType.VRMLink |
Element | New | Not operational |
Beginning with version 759, a warning message will be returned if a listing is created or revised (using Add/Revise/Relist family of API calls) with RefundOption and/or ReturnsWithinOption values that are being deprecated in 2012. And starting with the Spring Seller Release in early May 2012, listings created or revised with these same values will be blocked. Later in 2012, if any GTC listings still have non-compliant options, eBay will convert them during auto-renewal to use the default options (e.g., 14 days).
For RefundOption, the values being deprecated are MerchandiseCredit and Exchange. GeteBayDetails already stopped returning these options in Sandbox, and these values will stop being returned in Production in February. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.
For ReturnsWithinOption, the values being deprecated are Days_3 and Days_7. GeteBayDetails already stopped returning these options in Sandbox, and these values will stop being returned in Production in February. Instead of these deprecated values, the seller must offer a 10-day, 14-day, 30-day, or 60-day return window.
We'll continue to support ReturnsNotAccepted as a policy. However, even if you specify ReturnsNotAccepted, buyers may still return an item if the item is significantly not as described (SNAD) in the listing. Buyers in the US, UK, and Germany can open an eBay Buyer Protection case for SNAD items.
Here is the current timeline for warning messages and blocked listings:
| Date | Environment | Change |
|---|---|---|
| February 6, 2012 | Sandbox | Warning message returned if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| February 20, 2012 | Sandbox | Listings are blocked if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| February 29, 2012 | Production | Warning message returned if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| May 2, 2012 | Production | Listings are blocked if deprecated RefundOption and/or ReturnsWithinOption values are used. |
| TBD in 2012 | Production | Convert non-compliant GTC auto-renewed listings to use supported values |
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 - 757.
eBay has added four new fields (VIN, VINLink,
VRM, and VRMLink) to AddItem and related calls. These fields will soon replace the corresponding ID-based attributes for motor vehicle categories on the US eBay Motors site, and the CA, CAFR, UK, and AU sites.
Once these new fields become functional, you should begin migrating your vehicle listing templates to use these fields instead of the attributes. For a short period, eBay will convert VIN and VRM attribute values (along with the vehicle subtitle, deposit type, and deposity amount attribute values) to the corresponding first-class fields in AddItem and related requests, After the migration period, these attributes will be ignored. If you are still only passing in the attributes at that time, some of your vehicle listing requests will fail (depending on the model year) if your request is missing the new VIN field.
Once the migration has occurred for a given listing, GetItem will only return the new fields (not the attributes).
Keep an eye on these release notes for an update on when the new fields become functional and the duration of the migration period.
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 maximum number of parts compatibilities that may be specified by application (i.e., Item.ItemCompatibilityList.Compatibility) in an AddItem or related call has been increased for the eBay Motors US site (site ID 100). Use GetCategoryFeatures with the feature ID set to CompatibilityEnabled to determine the parts compatibility settings supported for the given site and category.
The domain of the StoreURL URL returned in GetUser is now based on the SITEID header passed in the request and not the seller's registration site. So, the eBay Stores URL for a UK seller will be returned as stores.ebay.fr if 71 (France) is passed in as the SITEID value.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 757 and Changed Functionality - 757.
Updated the description for the Item.PrivateListing boolean field. This field can be set with Add/Revise/Relist calls, and it is returned by GetItem and other API calls that return the Item object. If this field is set to 'true', the item title, item ID, and item price is obscured in all post-order Feedback comments left by buyers.
Documentation Changes and Errata - 753
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
DiscountPriceInfoType.MadeForOutletComparisonPrice |
Element | New |
PricingTreatmentCodeType.MFO |
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 - 753.
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 - 753 and Changed Functionality - 753.
None for this release.
Documentation Changes and Errata - 747
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
NotificationEventTypeCodeType.FixedPriceEndOfTransaction |
Enumeration | Removed |
QuantityInfoType |
Complex type | New |
ItemType.QuantityInfo |
Element | New |
ShippingServiceOptionsType.LocalPickup |
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 - 747.
The LocalPickup flag indicates whether the buyer has selected local pickup as the shipping option or the seller has made local pickup available as a shipping option.
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 maximum number of times that an item can be revised per month is 2,000. This affects the ReviseItem, ReviseFixedPriceItem, and ReviseInventoryStatus calls.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 747 and Changed Functionality - 747.
Added a note about the best practice of including all original shipping details fields when using the ReviseItem and ReviseFixedPriceItem calls.
Documentation Changes and Errata - 745
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
PaymentStatusCodeType.Paid |
Enumeration | Removed |
SellingStatusType.SoldAsBin |
Element | New |
UnpaidItemAssistancePreferencesType.AutoOptDonationRefund |
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 - 745.
New SoldAsBin flag in GetItem call indicates when an auction listing has ended before the stated auction end time due to a buyer using the Buy It Now option to purchase the item.
New AutoOptDonationRefund flag in SetUserPreferences call allows a seller to request that eBay automatically request eBay Giving Works donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This preference is only applicable to charity listings.
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 - 745 and Changed Functionality - 745.
Added a note in GetOrders documentation about using and setting the CreateTimeTo filter back two minutes from current time. It is possible that GetOrders will return incomplete/inaccurate data for a multiple line item order if that order is created within a minute or so of that GetOrders call.
Added more detailed information about shipping categories in the GeteBayDetails documentation. Specifically, updates were made to the ShippingServiceDetails and ShippingCategoryDetails containers.
Documentation Changes and Errata - 743
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ItemType.SellerProvidedTitle |
Element | New |
PaymentDetailsType.DepositAmount |
Element | New |
PaymentDetailsType.DepositType |
Element | New |
MessageTypeCodeType.ClassifiedsBestOffer |
Enum | New |
MessageTypeCodeType.ClassifiedsContactSeller |
Enum | New |
Samuel Au, a Manager of Software Development in eBay's Shipping team, gave a great demo at Innovate that previewed a new, unified shipping solution on eBay. See Fun and Commerce with eBay's Shipping Platform for information about what's coming! There's a link to a video of the full presentation there, too!
When something goes wrong with an order, sellers need apps that offer efficient and effective processes to turn the customer experience back around and make it right. At Innovate, Bijal Shah, an eBay product manager, walked us through the kinds of apps that sellers need, and the APIs that are available to help developers help sellers manage their cases effectively. See Help Sellers Protect Their ROI with Proactive Claims Management for tips from Bijal (including a link to the video).
eBay offers an extensive library of well-known products, which you can use to include product details in your listings. But sometimes the catalog doesn't contain the product you're looking for. So, eBay recently opened up the ability to add products to the eBay catalog. See APIs for eBay Catalogs for a summary of these APIs from Bala Parthasarathy, Sr. Product Manager, eBay Catalogs. You'll find a link to the presentation video at the end.
If you're a new eBay developer, check out these two intro sessions from Innovate 2011 to learn more about how to get started with our APIs, and your options for selling! Read the summaries here, and go to the end of the summaries for links to the presentation videos!
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 - 743.
eBay has added three new fields (SellerProvidedTitle, DepositAmount, and DepositType) to AddItem and related calls. These fields will soon replace the US and Canada eBay Motors Subtitle attribute (10246), and the US eBay Motors deposit amount and type attributes (10733 and 10734). The attributes will continue to work for a period of time to give developers time to migrate to the new fields. Keep an eye on these release notes for information about when the new fields will be functional.
ClassifiedsContactSeller and ClassifiedsBestOffer added as new message types. ClassifiedsContactSeller indicates that an inquiry has been sent to the seller regarding the corresponding classified ad listing. ClassifiedsBestOffer indicates that a best offer has been made on the seller's corresponding classified ad listing.
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 - 743 and Changed Functionality - 743.
None for this release.
Documentation Changes and Errata - 741
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
DisputeExplanationCodeType.SellerRanOutOfStock |
Enum | New |
PaidStatusCodeType.Paid |
Enum | New |
PaymentStatusCodeType.Paid |
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 - 741.
A new value of "Paid" can now be returned in GetOrders (and other order retrieval calls) when checkout is complete and order has been paid for by the buyer. This value is returned in the CheckoutStatus.eBayPaymentStatus field. This value may also be returned in the MyeBaySelling and MyeBayBuying calls.
A new dispute explanation was added and available to use through the AddDispute call. The value is "SellerRanOutOfStock", and this value can be used by the seller when cancelling an order due to an item being out of stock.
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 - 741 and Changed Functionality - 741.
The docs will soon be updated to clarify that even if you previously set InventoryTrackingMethod to SKU in AddFixedPriceItem, you need to reset InventoryTrackingMethod to SKU if you relist the item. Otherwise, the listing will only use ItemID as the tracking method.
The docs will soon be updated to clarify that CategoryID is required when you use IncludeConfidence in GetCategorySpecifics. In effect, this means that IncludeConfidence cannot be used with CategorySpecificsFileInfo (assuming you are using CategorySpecificsFileInfo to download item specifics data for all categories).
Documentation Changes and Errata - 739
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
SellerDiscountType |
Complex type | New |
SellerDiscountsType |
Complex type | New |
TransactionType.SellerDiscounts |
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 - 739.
Information on one or more item or shipping discounts can now be retrieved using GetOrders and other order retrieval 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.
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 - 739 and Changed Functionality - 739.
None for this release.
Documentation Changes and Errata - 737
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
BrandMPNIdentifierEnabledDefinitionType |
Complex type | New |
EANIdentifierEnabledDefinitionType |
Complex type | New |
ISBNIdentifierEnabledDefinitionType |
Complex type | New |
UPCIdentifierEnabledDefinitionType |
Complex type | New |
CategoryFeatureType.BrandMPNIdentifierEnabled |
Element | New |
CategoryFeatureType.EANIdentifierEnabled |
Element | New |
CategoryFeatureType.ISBNIdentifierEnabled |
Element | New |
CategoryFeatureType.UPCIdentifierEnabled |
Element | New |
FeatureDefinitionsType.BrandMPNIdentifierEnabled |
Element | New |
FeatureDefinitionsType.EANIdentifierEnabled |
Element | New |
FeatureDefinitionsType.ISBNIdentifierEnabled |
Element | New |
FeatureDefinitionsType.UPCIdentifierEnabled |
Element | New |
SiteDefaultsType.BrandMPNIdentifierEnabled |
Element | New |
SiteDefaultsType.EANIdentifierEnabled |
Element | New |
SiteDefaultsType.ISBNIdentifierEnabled |
Element | New |
SiteDefaultsType.UPCIdentifierEnabled |
Element | New |
FeatureIDCodeType.BrandMPNIdentifierEnabled |
Enum | New |
FeatureIDCodeType.EANIdentifierEnabled |
Enum | New |
FeatureIDCodeType.ISBNIdentifierEnabled |
Enum | New |
FeatureIDCodeType.UPCIdentifierEnabled |
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 - 737.
Call GetCategoryFeatures to see if a site or category supports the ability to pass in Brand/MPN, EAN, ISBN, or UPC values in an Add/Revise/Relist call.
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 - 737 and Changed Functionality - 737.
None for this release.
Documentation Changes and Errata - 735
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
BuyerPaymentMethodCodeType.StandardPaymentMethod |
Enumeration | Removed |
RefundOptionsCodeType.MoneyBackOrExchange |
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 - 735.
As previously announced, eBay's new tickets catalog helps US and CA sellers specify key details about tickets and the event, including required custom item specifics (Number of Tickets and Venue State/Province).
To support these changes, eBay has made changes to the US and CA Tickets category structure. eBay will perform a one-time migration to move existing listings from the Event Tickets (16122) category into one of four new categories based on the Event Type item specific in the listing: Sports (173633), Concerts (173634), Theater (173635), or Other (1306). Listings in Experiences (16071) will be merged into Other (1306). After that, new listings need to use the new categories.
Sellers can now begin listing against the new tickets catalog. eBay will perform a one-time migration to convert old product details in existing listings to use the new catalog's product details instead.
Along with the above changes, eBay also now supports custom item specifics for US and CA ticket categories.
For more details about these changes and how they affect the API, see Ticket Listings in the Trading API Guide.
The following example shows how to add ticket details in AddItem with product details and custom item specifics:
<ProductListingDetails>
<TicketListingDetails>
<EventTitle>Toronto Argonauts vs Saskatchewan Roughriders</EventTitle>
<PrintedDate>20110818</PrintedDate>
<PrintedTime>7:30 PM</PrintedTime>
<Venue>Rogers Centre</Venue>
</TicketListingDetails>
<IncludeStockPhotoURL>true</IncludeStockPhotoURL>
<IncludePrefilledItemInformation>true</IncludePrefilledItemInformation>
<UseStockPhotoURLAsGallery>true</UseStockPhotoURLAsGallery>
</ProductListingDetails>
<ItemSpecifics>
<NameValueList>
<Name>Number of Tickets</Name>
<Value>4</Value>
</NameValueList>
<NameValueList>
<Name>Section</Name>
<Value>200</Value>
</NameValueList>
<NameValueList>
<Name>Row</Name>
<Value>12</Value>
</NameValueList>
<NameValueList>
<Name>Venue State/Province</Name>
<Value>ON</Value>
</NameValueList>
</ItemSpecifics>
As previously announced, the new payment process on DE/AT sites starts August 22. Beginning August 22, GetOrders and other order retrieval API calls will return relevant information to DE and AT sellers subject to the new payment process. Additionally, two new eBay notifications, ReadyToShip and ReadyForPayout have been created.
There is also a new Payout Details API available. The Payout Details API has two calls: getOrderPayoutDetails (available now) and getPayoutDetails (available in 737). Both of these calls can be tested in the Sandbox beginning September 1. The documentation for the Payout Details API can be found at: http://developer.ebay.com/DevZone/payout-details/CallRef/index.html
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.
GeteBayDetails returns MoneyBackOrExchange in RefundOption, and you can pass it in the AddItem family of calls.
See New Guidelines and Options for Return Policies) in the 729 release notes for additional information about changes that will go into effect in production in 2012.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 735 and Changed Functionality - 735.
None for this release.
Documentation Changes and Errata - 733
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ProductSuggestionType |
Complex type | New |
ProductSuggestionsType |
Complex type | New |
AddFixedPriceItemResponseType.ProductSuggestions |
Element | New |
AddItemResponseType.ProductSuggestions |
Element | New |
ItemType.UseRecommendedProduct |
Element | New |
RelistFixedPriceItemResponseType.ProductSuggestions |
Element | New |
RelistItemResponseType.ProductSuggestions |
Element | New |
ReviseFixedPriceItemResponseType.ProductSuggestions |
Element | New |
ReviseItemResponseType.ProductSuggestions |
Element | New |
VerifyAddItemResponseType.ProductSuggestions |
Element | New |
VerifyRelistItemResponseType.ProductSuggestions |
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 - 733.
Note: This feature is available to a small subset of eBay-selected sellers.
To facilitate the use of eBay catalogs for listing items, the AddItem family of calls will return product suggestions (ProductSuggestiion) in the response to indicate there is an item in the catalog that matches the item details in the request.
Sellers can set UseRecommendedProduct to true to allow eBay to list their item using a product from the eBay catalog when the product is a match for the seller's item. This is like using ProductListingDetails to list an item. Applies only to catalog-enabled categories.
Starting August 22, a new payment process begins for new sellers listing on the German and Austrian sites.
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.
Parts compatibility APIs are now fully supported on the eBay Germany site (site ID 77), in addition to the eBay US Motors Site (site ID 100). Parts Compatibility is supported in both the Sandbox and in the Production environments for these sites.
To identify categories in which you can list items with parts compatibility, submit a GetCategoryFeatures request to the given eBay site with the parts compatibility feature IDs (CompatibilityEnabled, MinCompatibleApplications, MaxCompatibleApplications) and ViewAllNodes set to true. See Listing Items with Parts Compatibility for more information.
When items are listed with parts compatibility by application on the eBay Germany site, users can use K type vehicle specification numbers to specify a compatibility:
<Compatibility>
<NameValueList>
<Name>KType</Name>
<Value>10006</Value>
</NameValueList>
<CompatibilityNotes>Passt alle ordnungen.</CompatibilityNotes>
</Compatibility>
K type is a vehicle specification numbering system provided by TecDoc Informations Systems. For more information about TecDoc and the K type numbering system, see the TecDoc Portal.
Note: One notable difference for Parts Compatibility on the eBay Germany site is the use of Production Period (a range of years in which the given vehicle was produced)instead of Year as a compatibility property. If the production period covers 4 years (see following examples), then the compatibility counts as 4 of the maximum allowed item compatibilities.
Example of Production Period values that describe a range of 4 years:
<Value>2008/07-</Value>: Vehicles produced from July of 2008 to the present
<Value>2003/04-2006/10</Value>: Vehicles produced from April of 2003 to October of 2006Although the maximum allowed number of item compatibilities has been increased to 1,000 for the eBay Germany site, it is important to implement a counter into your application to prevent sellers from specifying more than the maximum number of compatibilities for an item. An AddItem request will fail if the number of compatibilities specified exceeds the maximum allowed. GetItem returns ItemCompatibilityCount, which can help you monitor the number of compatibilities specified for an item.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 733 and Changed Functionality - 733.
None for this release.
Documentation Changes and Errata - 731
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
SellerPIStatusCodeType |
Enumerated type | New |
SellereBayPaymentProcessStatusCodeType |
Enumerated type | New |
NotificationEventTypeCodeType.ReadyForPayout |
Enum | New |
NotificationEventTypeCodeType.ReadyToShip |
Enum | New |
PaymentHoldStatusCodeType.ReleaseConfirmed |
Enum | New |
PaymentHoldStatusCodeType.ReleaseFailed |
Enum | New |
PaymentHoldStatusCodeType.ReleasePending |
Enum | New |
PaymentTypeCodeType.RentalBuyout |
Enum | New |
PaymentTypeCodeType.RentalExtension |
Enum | New |