759 Trading, Shopping, Merchant Data API Docs Now Available

Please remember to use a test environment when updating applications to use a new schema version.

To find out when a version of the API will be available, see the table at the top of the Release Notes for that API.

You can find the latest API documentation at the eBay Developer Documentation Center.

Trading

Trading Release Notes

Release Highlights

See the Trading API System Announcements for bug fixes included in this release.

Shopping

Shopping Release Notes

See the Shopping API System Announcements for bug fixes included in this release.

Merchant Data

Merchant Data Release Notes

See the Large Merchant Services API System Announcements for bug fixes included in this release.

Russell Hall
API Tech Docs

February 7, 2012 in Documentation, Shopping API, Trading API | Permalink

717 Trading, Shopping, Merchant Data API Docs Now Available

Please remember to use a test environment when updating applications to use a new schema version.

To find out when a version of the API will be available, see the table at the top of the Release Notes for that API.

You can find the latest API documentation at the eBay Developer Documentation Center.

Trading

Trading Release Notes

See the Trading API System Announcements for bug fixes included in this release.

Shopping

Shopping Release Notes

See the Shopping API System Announcements for bug fixes included in this release.

Merchant Data

Merchant Data Release Notes

See the Large Merchant Services API System Announcements for bug fixes included in this release.

Bradburn Young
API Tech Docs

April 18, 2011 in Developer Website, Documentation, Shopping API, Trading API | Permalink

Finding API Migration

The Developers Program launched the Finding API in July 2009. Today Finding API is successfully serving over 130 millions of requests daily. We are ready for our next critical milestone – support all developers to fully migrate to Finding API to take advantage of the eBay’s next generation search technology used to power the eBay site search ; and deprecate Trading APIs: GetSearchResults and GetCategoryListings, and Shopping APIs: FindItemsAdvanced and FindItems. These APIs will stop working after October 2011.

To better support developers’ migration, asks and needs, we have been focusing on Finding API for new and enhanced features, as well as technical support. Meanwhile the deprecation of Trading and Shopping Search APIs has started since January 2011. Although those four API calls are still working till October, developers should have noticed that the deprecated API calls and related schema have been removed from the public WSDL and XSD files. Related documentation has also been removed. These calls are also being removed from SDKs.  For adoption of newer version SDKs after April 2011, the deprecated types will no longer be accessible. A warning message will be returned by these API calls after June 2011, indicating the API is scheduled to be removed. Your application might be broken if it doesn’t follow eBay requirements for error handling. The search capabilities provided by these calls are supported in the Finding API. If you're building new search applications, start with the Finding API. If you have applications that use these calls, please migrate your item search functions to the Finding API.

 

Why Finding API?

The Finding API leverages eBay’s next generation search technology and have been designed to provide greater flexibility, better performance and scalability. Increased search relevancy and parity with the eBay site search features are some of the highlights of the new API. The latest Best Match and Fitment algorithms are available in Finding API. A series of benchmark testing has been conducted that shows on par performance of Finding API to the Shopping API (FindItemsAdvanced & FindItems); and significant improvement over the Trading API (GetSearchResults & GetCategoryListings).

The following are the functionalities and features added by Finding API for item searches:

1.       Retrieve aspect histograms and filter by aspects and/or domains – supply data by item attributes which enables eBay site alike left navigation as well as search refinement by applying constraints aligned with eBay search classification.

2.       Support new search capabilities:

  • Item Condition histogram and filters
  • Restrict searches to as many as 3 categories at a time
  • Expedited Shipping filters
  • Top-Rated Sellers Only filter
  • Returns Accepted Only filter

 

3.       Image Search API (findItemsByImage): expend eBay’s capabilities in fashion to developers for the “More Like This” functionality.

4.       Three sizes of gallery image: 140x140, 96x96, 80x80 that users can choose to use based on their application’s needs.

As our commitment to the Developer Community, we are always working continuously and diligently to enable the latest, high performance, world-class eBay search technology and features to Finding API. Enhancements to picture URL, Multi-variations, LocatedIn etc. filters and more will be released in May.

 

How to Migrate to Finding API?

The following migration guides map input and output fields for GetSearchResults in the Trading API and FindItemsAdvanced in the Shopping API to the corresponding input and output fields in findItemsAdvanced in the Finding API:

Please contact us for questions or more information on Finding API or migration.

 

 

April 7, 2011 in Affiliates, Critical Notes from Tech Support, Developer Website, Documentation, Finding API, Shopping API, Trading API | Permalink

715 Trading, Shopping, Merchant Data API Docs Now Available

Please remember to use a test environment when updating applications to use a new schema version.

To find out when a version of the API will be available, see the table at the top of the Release Notes for that API.

You can find the latest API documentation at the eBay Developer Documentation Center.

Trading

Trading Release Notes

Release Highlights

See the Trading API System Announcements for bug fixes included in this release.

Shopping

Shopping Release Notes

Release Highlights

See the Shopping API System Announcements for bug fixes included in this release.

Merchant Data

Merchant Data Release Notes

See the Large Merchant Services API System Announcements for bug fixes included in this release.

Bradburn Young
API Tech Docs

April 5, 2011 in Developer Community, Developer Website, Documentation, Shopping API, Trading API | Permalink

713 Trading, Shopping, Merchant Data API Docs Now Available

Please remember to use a test environment when updating applications to use a new schema version.

To find out when a version of the API will be available, see the table at the top of the Release Notes for that API.

You can find the latest API documentation at the eBay Developer Documentation Center.

Trading

Trading Release Notes

Release Highlights

See the Trading API System Announcements for bug fixes included in this release.

Shopping

Shopping Release Notes

See the Shopping API System Announcements for bug fixes included in this release.

Merchant Data

Merchant Data Release Notes

See the Large Merchant Services API System Announcements for bug fixes included in this release.

Bradburn Young
API Tech Docs

March 21, 2011 in Developer Community, Documentation, Large Merchant Services, Shopping API, Trading API | Permalink

709 Trading, Shopping, Merchant Data API Docs Now Available

Please remember to use a test environment when updating applications to use a new schema version.

To find out when a version of the API will be available, see the table at the top of the Release Notes for that API.

You can find the latest API documentation at the eBay Developer Documentation Center.

Trading

Trading Release Notes

Release Highlights

See the Trading API System Announcements for bug fixes included in this release.

Shopping

Shopping Release Notes

See the Shopping API System Announcements for bug fixes included in this release.

Merchant Data

Merchant Data Release Notes

See the Large Merchant Services API System Announcements for bug fixes included in this release.

Bradburn Young
API Tech Docs

February 25, 2011 in Developer Website, Documentation, Shopping API, Trading API | Permalink

Rate Limit Changes to Shopping, Finding, and Merchandising API

To manage your call limits better, eBay is changing the basis for rate limiting API usage for the Shopping, Finding and Merchandising APIs. Starting March 1, 2011, call usage will be measured by application instead of IP address. The call counts will be aggregated for your application based on the AppID used to make the request, rather than the IP address from which the request is coming.

What does this mean to you?

If your application is making more than 5,000 calls a day, go through the compatible application check to get your call limits increased to prevent any disruption to your application.

January 7, 2011 in Best Practices, Critical Notes from Tech Support, Developer Community, Finding API, Merchandising API, Shopping API | Permalink

Developer Impact: Fall 2010 Changes

Today, Dinesh Lathi posted an important announcement about the Fall 2010 Seller Update (SR10.3). Here is the developer impact for those features. More details will follow in the documentation as each feature is released. Most Fall 2010 changes will go live the week of September 7, 2010.

New shopping experience for iPod/MP3 players, GPS, and DVDs highlight s great eBay values on these hot holiday products. Starting mid-September, listing with the eBay catalog will be required in these subcategories (Auction-style and Fixed Price, including Good 'Til Cancelled). Pay no Insertion Fees when you list or relist with the catalog.

Developer Impact:

eBay will be providing a 100% product-based shopping experience in three categories. These categories are:

  • iPod & MP3 Players (subcategory # 73839) [US, CA, UK, IE, DE, AT]
  • GPS Devices (subcategory # 156955) [US, CA, UK, IE, DE, AT]
  • DVDs, HD DVDs & Blu-ray (subcategory # 617) [US, CA]

This means that sellers will need to list using a product ID in those categories if a product ID is available for that item. If no product ID is available, sellers should list the usual way in that category.

Items listed with a product ID will show up on the improved product page. The best-value item will appear in an easy to use "value box" at the top of the page. Several factors go into determining who gets this placement, including eTRS status and competitive pricing.

Items that have an available product ID, but are not listed with that product ID will not be eligible for prominent placement on the product page, and will not get the insertion fee discount. However, the AddItem call will not fail.

More Catalogs Available

To support this requirement, eBay has increased the number of items that it provides pre-filled item information for. You may find product IDs for items that did not have product IDs in the past.

Code to Support Even More Future Catalogs

eBay is bringing more catalogs on as they become available. We suggest as a best practice that you build into your listing process for all items an initial search for a product ID. As a convenience, you can search for product ID by UPC and by product title. Then if a product ID is not available, list without the product ID.

This ensures items can take advantage of the additional information provided with pre-filled information, the improved product experience, and will be eligible for prominent placement.

For more information, see:

Release Date:

Enforcement: September 13 September 7

Site Support:

US, CA, UK, IE, DE, AT

eBay Listing Analytics application gives you new insight into how your listings are performing: impressions, clicks, sales.

eBay is replacing the Search Visibility tool with the Listing Analytics application to provide more information on listing performance. At the same time, the corresponding BestMatchItemDetails API is being updated.

Get answers to key seller questions:

  • How do my listings rank for a given search?
  • What does my sales funnel (impressions, clicks, views, and sold items) look like for my active and completed listings?
  • How do my listings compare to the top five listings showing up on the first page of search results (impressions, average views) for a given query?
  • What are best practices for getting more buyers to click on my listings and buy after they click them?

While every effort is made to ensure that API changes are backward compatible, the new version of the BestMatchItemDetails API may not be compatible with the previous version of the API.

For more information, see:

Release Date (Application and API):

US and Motors: Week of September 7

International: Early October

Site Support:

US, Motors, CA, CAFR, UK, IE, DE, AT, CH, FR, IT

Bulk-edit more fields, revise up to 500 listings at once with new functionality in the eBay bulk edit and relist flow.

Developer Impact:

With this release, the new on-site bulk listing management flow becomes generally available on the site. The underlying API that drives the flow will be made available in early 2011. It is a new API that is optimized for bulk editing and relisting.

The new API is robust and flexible and off-loads many listing tool functions like business logic validation to the API itself. Developers may want to consider this as an alternative to the Trading API.

The new API will be released early next year. There are currently no plans to deprecate the Trading API.

For more information, see:

Release Date:

Bulk listing management flow: General release week of September 7

New API: Early 2011

Site Support:

All sites

Get your unpaid items re-listed and back in front of buyers fast with auto-relist option in Unpaid Item Assistant. Choose to exempt some customers from the automated process.

Developer Impact:

Starting in September, Unpaid Item Assistant will be turned on automatically for all PowerSellers and above. The UPI Assistant will automatically open unpaid item cases 16 days after a buyer hasn't paid. This duration can be changed in the seller's My eBay Site Preference Settings (My eBay > My Account > Site Preferences > Unpaid Item Assistant Preferences).

eBay is also offering the option to automatically relist the item when the UPI case closes without a payment. Sellers must opt-in to this feature.

In addition, you can create a list of preferred customers for whom cases will not automatically be created.

Unpaid Item Assistant is available for eBay Checkout items and those that offer only approved electronic payment methods (for example, PayPal, Paymate, Integrated Merchant Credit Cards, and so on).

The UPI Assistant is not directly available via the API. Some developers may already provide similar functionality using the Trading API call AddDispute. You may want to turn that feature off for PowerSellers and above to avoid duplication. Or, your sellers may wish to opt out of UPI Assistant.

For sellers who opt into the auto-relist feature, there is currently no way to determine via the API if an item has been automatically relisted. You may wish to keep a careful eye on any UPI cases and see if GetSellerTransactions starts returning any unexpected RelistedItemID values. Sellers may prefer not to opt into the auto-relist feature.

For more information, see:

Release Date:

The week of September 7

Site Support:

All sites

Industry-standard shipping terms —Economy, Standard, Expedited, and One-day—used to describe domestic shipping services. Shipping options displayed prominently along with estimated delivery time on the item page and in checkout.

Developer Impact:

To reduce shipping-related questions—including confusion about the carrier services offered and time of delivery— we will be displaying the shipping options offered, along with estimated delivery, more prominently throughout the buying process. The existing generic shipping service (e.g. Standard Flat Rate, Expedited Flat Rate, Overnight Flat Rate, and Other) will be automatically renamed with one of the new Industry-standard shipping terms and the corresponding delivery estimates will be automatically added as shown in this table:

Current service name

New service classification

Shipping time used for estimated delivery

Other (see description)

Economy shipping

1 - 10 business days

Standard Flat Rate Shipping Service

Standard shipping

1 - 5 business days

Expedited Flat Rate Shipping Service

Expedited shipping

1 - 3 business days

Overnight Flat Rate Shipping Service

One-day shipping

1 business day

In addition, we are adding three new generic shipping services for sellers who ship into the U.S. from abroad. These services have longer shipping estimates to better account for international shipping and customs clearing times.

New service name

Shipping time

Economy Shipping from outside U.S.

11 - 20 business days

Standard Shipping from outside U.S.

5 - 10 business days

Expedited Shipping from outside U.S.

1 - 4 business days

At the top of the item page and during checkout, four familiar industry-standard service level terms will be used:

  • Economy (1-10 business days)
  • Standard (1-5 business days)
  • Expedited (1-3 business days)
  • One-day (1 business day)

As always, the estimated delivery displayed to buyers will be the shipping time plus your handling time. If the sellers selects a branded shipping service (e.g. UPS Ground, or USPS Priority Mail) this information will continue to be available on the shipping details section of the item page and during checkout.

If a seller currently lists with any of the UPS or USPS services or the "Overnight Flat Rate Shipping Service," their listings won't require any changes.

If a seller currently uses "Standard Flat Rate Shipping", "Expedited Flat Rate Shipping" or "Other (see description)", they should make sure their carrier's published delivery estimates match the shipping times eBay will be using for estimated delivery (See the table above). They may want to change their listings—and possibly their services or handling time to stay competitive and set the right expectations for their buyers.

For more information, see:

Release Date:

The week of September 7

Site Support:

US, UK, DE

Shipping to Alaska and Hawaii, APO/FPO addresses, and special US areas such as Guam and Puerto Rico: Exclude these buyers or show exact charges based on their location.

Developer Impact:

Sellers set the new special shipping rates in their My eBay. There is no way to specify this with the API. Developers should pass a flag in AddItem to indicate that the special shipping rates should be used for a particular listing.

For more information, see:

Release Date:

The week of September 7

Site Support:

DE, UK, North America, Asia-Pacific

Pass on your shipping discounts to buyers with the Shipping Calculator: Specify one domestic and one international discount.

Developer Impact:

Sellers set the shipping discounts in their My eBay. There is no way to specify this with the API.

For more information, see:

Release Date:

The week of September 7

Site Support:

US, CA, AU

Low-cost shipping insurance: Available exclusively with eBay label printing.

Developer Impact:

This feature is only available on the eBay site as part of the label printing process. There is no API equivalent.

For more information, see:

Release Date:

The week of September 7

Site Support:

US

Updates to reduce and manage buyer contacts: Ask a question link moved down on item page; Automated Answers turned on for all sellers.

Developer Impact:

No new API changes for this feature.

For more information, see:

Release Date:

Early August.

Enhancements to My Messages: Use it as your central inbox for buyer email with out-of-office reply, customized email signatures, and message filtering.

Developer Impact:

Newly available in the Sandbox, a preview version of upcoming changes to MyMessages allows you to set selected messages as high priority, retrieve only high priority messages, and get counts of high priority messages.

For more information, see:

Release Date:

Preview currently available in the Sandbox

Available in Production the week of September 7

Site Support:

All sites

Category and Item Specifics changes consolidated with other updates. Find out if your listings are impacted.

Developer Impact:

Please refresh your cached categories and item specifics when the changes go live.

For more information, see:

Get complete details about all these important updates.
See the Seller Checklist for more information about how these updates affect you.

Sellers and developers will benefit from reviewing this information.

For more insight, you're also invited to:
Take part in an upcoming webinar on Thursday, July 15.
Join me and other leaders from eBay in a Town Hall meeting on Wednesday, July 14. Check the Announcement Board for more details coming soon.
Talk with members of my staff during the next two days on a special discussion board we've set up for this purpose.
As always, thank you for selling on eBay.

We recommend taking advantage of the resources that Dinesh mentions above. More developer impact details will follow in the documentation as each feature is released.

July 13, 2010 in Categories and Item Specifics, Finding API, Product News, Sandbox, Seller Releases, Shopping API, Trading API | Permalink

Deprecation Deadline Extended: Selected Trading and Shopping API Calls

As part of our ongoing commitment to the Developer Community, we are pleased to announce that the we are extending the previously announced date of June 2010 for deprecation of Shopping APIs calls (FindItems, FindItemsAdvanced) and Trading API Calls (GetSearchResults and GetCategoryListings).  The new date for deprecation of these APIs will be announced shortly.

This extension is being granted in response to requests received from several members of eBay Developers Program. The extension will provide additional time for all developers who are in the process of migration or are in early stages of their migration process to successfully complete their migration process. 

We do strongly encourage all developers to prioritize and expedite their efforts in upgrading to Finding APIs. The Finding APIs leverage eBay's next generation search technology and have been designed to provide greater flexibility, better performance and scalability. For more information on Finding APIs, please visit  http://developer.ebay.com/products/finding/

For more information on Shopping APIs or migration please send your requests to http://developer.ebay.com/contactus/

June 2, 2010 in Finding API, Product News, Shopping API, Trading API | Permalink

Developer Impact: Summer 2010 Announcements

Today, Dinesh Lathi posted an important announcement about the Summer 2010 Release (SR10.2). Here is the developer impact for those features. More details will follow in the documentation as each feature is released.

We're making updates this summer and fall to help increase your profitability with more satisfied buyers and more efficient selling. As promised, we're continuing to consolidate changes that impact your selling into two or three releases per year with lead time to adapt. This is the second release for 2010.

Clearly defined item conditions set buyer expectations, reduce questions
To make it easier for sellers to specify item condition, we're introducing more descriptive values in many categories. In some categories, specifying item condition will be required for new listings, revised listings and sell similar starting on July 27, 2010 and for Good Til' Canceled listings in the spring of 2011.

Developer Impact:
As mentioned previously, we are making these changes to item condition:

  • Changing the way that you specify item condition in the API
  • Making item condition values more granular
  • Making item condition mandatory in some categories

Starting early May, we recommend you use GetCategoryFeatures and GeteBayDetails to determine if item condition is required for your category, and what the possible values are. Before early May, you can use the Item Condition Lookup table.

Timeline
March 22: New item condition values available in two categories in the Sandbox:

End of April: New item condition values roll to eBay.com for a single category, Cell Phones. During the migration period, you can continue to use the old way or the new way of specifying item condition.

Early May: New item condition values roll to eBay.com for the remaining applicable categories.

End of July: Only the new way of specifying item condition will be supported. If you continue to use only the old methods of specifying item condition, your call will fail.

More Information
For more information, see:

Keeping buyers on eBay, rewarding sellers for great service
Opening a case through the eBay or PayPal Buyer Protection program—especially when the  buyer tries and is not able to work out an issue directly with the seller—is  clear indication of dissatisfaction. That's why starting in September, along with low DSRs, eBay will consider buyer cases for item not received and item not as described to evaluate seller performance.

Developer Impact:
No new API changes for this feature. Sellers can go to their seller dashboard in My eBay to view their claims data. There is currently no way to retrieve this info using the API.

Sellers will be able to opt out of the automated eBay Payment Reminder emails if they prefer to send their own communications instead.

Developer Impact:
This opt out preference can be set via the Trading API call SetUserPreferences and retrieved with GetUserPreferences. Sellers can also opt out via My eBay. Developers who send reminder emails on behalf of sellers may want to encourage their sellers to opt out of automated eBay Payment Reminders. This will minimize the amount of email that is sent to a buyer about a given transaction.

eBay will send a standardized Feedback Reminder email. Sellers will no longer be able to automate their own Feedback Reminder email through Selling Manager or Selling Manager Pro.

Developer Impact:
No new API changes for this feature.

Email communication between buyers and sellers will be even more secure with anonymous email addresses and improved documentation of email conversations in My Messages.

Developer Impact:

Overview
Every user account on eBay will be assigned an anonymous email address which will be used during email conversations with other eBay users. Users will be able to reply to email messages using the anonymous email address directly from their email clients or from eBay developer tools. When users become transaction partners with each other, they can see the real email address.

API Changes
In most cases, in addition to the email address you already get, you will start seeing a new field in the call response that contains the eBay member's anonymized email address. Specifically:

  • GetSellerTransactions: Transaction.Buyer.Email will be supplemented by Transaction.Buyer.StaticAlias.
  • GetItemTransactions: Transaction.Buyer.Email will be supplemented by Transaction.Buyer.StaticAlias.
  • GetOrderTransactions: Order.TransactionArray.Transaction.Buyer.Email will be supplemented by Order.TransactionArray.Transaction.Buyer.StaticAlias.
  • GetMyeBaySelling: Transaction.Buyer.Email will be supplemented by Transaction.Buyer.StaticAlias.

In GetMemberMessages, the email address that is currently returned will be replaced by the anonymized email address, in the following field: MemberMessage.MemberMessageExchange.Question.SenderEmail.

Timeline
A few sellers (who have been notified) will see the GetMemberMessages changes in a controlled, mid-April beta release. But most sellers will see the changes in June 2010.

More Information
For more information, see:

To highlight the most relevant listings from sellers providing great value and service, Featured First—the listing upgrade that allows items to be featured in the top two spots of Best Match search results—will be discontinued.

Developer Impact:
After June 29, 2010, for the US (site ID 0) only, when listing with GalleryType = Featured, the listing enhancement will be dropped from the listing with a warning. The listing will not fail. The feature will automatically expire from any existing listings on July 29, 2010.

Easier, more profitable selling
To help you stay on top in a dynamic marketplace, we're introducing new functionality and tools to make it faster and easier to edit, list, and relist in bulk—up to 5,000 listings at once.

Developer Impact:
No new API changes for this feature. Listing-tool developers are encouraged to support bulk revision of listings in their applications.

Starting in July, when one of your product photos is selected for the eBay catalog, you'll receive five free Subtitle credits.

Developer Impact:
No new API changes for this feature.

Category and Item Specifics changes are included with this release. Check to see whether your categories are impacted.

Developer Impact:
Please refresh your cached categories and item specifics when the changes go live.

Get complete details about all these important updates.
For more insight, you're also invited to:

  • Take part in an upcoming webinar on Thursday, April 29.
  • Join me and other leaders from eBay and PayPal in a Town Hall meeting on Wednesday, April 28. Check the Announcement Board for more details coming soon.
  • Talk with members of my staff during the next two days on a special discussion board we've set up for this purpose.

Developer Impact:
We recommend taking advantage of the resources that Dinesh mentions above. eBay developers can also get their questions answered:

April 27, 2010 in Product News, Seller Releases, Shopping API, Trading API | Permalink