Using Live Data in Production
Your application may need to go through the Compatible Application Check, in which we review and test applications to ensure that they comply with the Compatible Application Check Requirements.
Subtopics
Supporting Compatibility Levels
Compatible Application Check for Specific Calls
Additionally, new applications must support the latest schema version that is available in the Production environment at the time of the Compatible Application Check.
This process can take up to seven (7) business days if you design your application to comply with the requirements and you follow the steps of the Compatible Application Check process carefully. The process can take substantially longer if you do not. You may want to build time for this process into your project schedule.
The rules outlined in the Compatible Application Check requirements are not the sole criteria for judging an application. We modify the requirements based on observations of how developers use eBay APIs. Our intent is to ensure that your application is designed to communicate with eBay servers in an efficient and appropriate manner.
Compatible Application Check
Sections
Requirements for Compatible Application Check
Getting a Compatible Application Check
About the Compatible Application Check Timeline
Requirements for Compatible Application Check
As part of the Compatible Application Check process (see Getting a Compatible Application Check), eBay critically reviews all new applications for compliance with eBay's Compatible Application Check requirements at no cost.
The requirements are listed below. They identify performance criteria for each application. These criteria affect key operating functions: Error handling, simultaneous requests, and polling frequencies.
All Developers Program licensees are required to be in compliance with the Compatible Application Check requirements at all times. Occasionally, changes to the APIs require changes to the requirements. The eBay Developers Program makes all reasonable attempts to notify licensees when the requirements change. However, we strongly recommend that you review the Compatible Application Check requirements regularly.
Requirements for Specific Calls
Certain calls have special requirements to ensure that you use them most efficiently and effectively. Please see Compatible Application Check for Specific Calls for a summary of the Compatible Application Check requirements that apply to particular calls.
Requirements for Error Handling
Errors that are returned from calls include useful details and instructions for both end users and applications. The structure and granularity of the error messages are intended to help your application handle errors gracefully.
For details and guidelines, see Error Handling.
Multiple Items Returned per Single API Call
Some calls return multiple items in response from a single call. eBay reserves the right to change the maximum number of items returned per page (see Controlling the Amount of Data Returned for information about pagination).
Applications must be designed to recover gracefully when the number of items returned per page changes.
Polling Frequencies
eBay reserves the right to restrict an application's polling frequencies for any calls. This type of restriction typically occurs when eBay determines that an application is causing a negative operational impact to the eBay site.
Versions
New applications must comply with and use the latest schema version that is available in the production environment at the time of the Compatible Application Check.
We announce important changes for each version in release notes. Therefore, it's a good idea to be sure you review release notes regularly. See the All API documentation page for links for all eBay API release notes.
Getting a Compatible Application Check
The details of the Compatible Application Check process, and best practices, are detailed on the Compatible Application Check page of the eBay Developers Program site:
Compatible Application Check Page
https://developer.ebay.com/support/app-check
If you decide to go through the Compatible Application Check, ensure that your application complies with eBay policies:
https://www.ebay.com/help/policies/default/ebays-rules-policies
This section summarizes the Compatible Application Check process and includes some points you should keep in mind as you put together your project plan and milestones, and as you design, develop, and test your application.
These are the main steps in the Compatible Application Check process:
- Double-check that your application meets the Compatible Application Check requirements (see Requirements for Compatible Application Check). Conditions change and the requirements are updated on an ongoing basis.
- Navigate to the Compatible Application Check page on the eBay Developers Program site (see the link above).
- Support
- After you submit the document, Developer Technical Support will notify you of the status of your application.
- Your application must comply with the Compatible Application Check requirements at all times, so please be sure to review the requirements regularly to make sure your application remains in compliance.
This process is free.
If your application does not initially pass the compatibility check, Developer Technical Support will explain what you need to do to improve the application. Depending on the extent of the changes, we may need to close the case, and you may need to reapply when your application is ready.
About the Compatible Application Check Timeline
The Compatible Application Check process takes approximately 5-7 business days, provided your application meets the Compatible Application Check Requirements, and you are within the API Public License Agreement guidelines.
Supporting Compatibility Levels
When you send information to eBay, you need to specify which version of the API your application is using.
Compatible Application Check for Specific Calls
When using the Production environment, certain calls have additional Compatible Application Check requirements. See Compatible Application Check for general information about Compatible Application Check requirements.
The table below lists the Compatible Application Check Requirements for specific calls.
| Call Name | Description |
|---|---|
| GetCategories |
Execute GetCategories with no detail level and set the ViewAllNodes field to false in order to check the version of the eBay category hierarchy. This should be done at least once a day to ensure the locally cached category hierarchy is up to date.
If the version has changed from the version you have stored locally, then execute GetCategories and set the ViewAllNodes field to true to download the updates to the hierarchy. Should be done only when necessary (i.e., a new category tree version is indicated). |
| GeteBayDetails | As described in the API Logo Usage Requirements and your API License Agreement, if your application publicly displays eBay content, you must display the eBay Content Logo in conjunction with the eBay content. To retrieve the most current version of this logo, you must call GeteBayDetails at least once a day, and cache the logo locally. For more information on logo usage, please see https://developer.ebay.com/promote/logos on the Developer Web site. GeteBayDetails returns the eBay Content Logo URLs with other (optional) URL details. You can choose from one of three available sizes (small, medium, or large). |
| GetFeedback | When retrieving feedback, the application should only retrieve new feedback records. (A "new" feedback record is a record that your application has not retrieved previously.) Older feedback records should be cached. That is, the application should cache feedback records retrieved, and also store the FeedbackDetailItemTotal value, so that subsequent calls for already-retrieved records are unnecessary (GetFeedback returns the most recent records first). |
| GetItem | Only use GetItem when you cannot use GetSellerEvents, because GetSellerEvents is a more efficient call than GetItem. For example, for any given listing, you should only need to use GetItem when you have not yet stored the details of a particular listing locally. After you have stored the details locally, you should use GetSellerEvents when you want to know whether the status of any of a seller's listings has changed. |
| GetSellerEvents | When using GetSellerEvents, specify a time window (using EndTimeFrom and EndTimeTo, or ModTimeFrom and ModTimeTo) that matches the window of your calling frequency. For example, if you call GetSellerEvents every 30 minutes, use an EndTime window that also is 30 minutes. |
| GetSellerList | After you have imported a seller's items to your local application for the first time, only use GetSellerList if you cannot use GetSellerEvents. GetSellerEvents is a more efficient call than GetSellerList. |