Version 3.7
Chapter 1: Using the REST API 1
Introductory Samples
Chapter 1
Using the REST API
Chapter 1
With the eBay REST API, you can use an URL for simple or complex searches of millions of item
listings. Moreover, you can use an URL to get detailed information about individual item listings.
Most calls to the REST API are from a Web page, application, or script. You can use the REST API to
integrate eBay functionality into your Web sites and applications. For the calls available in the REST
API, please see “Calls Available in the REST API” on page 2.
The System Announcements page is the primary resource for checking the status of issues relating to
the Sandbox and the Production servers. Please check the System Announcements page before
reporting urgent production system issues to eBay. Typical issues we announce on this page are
latency, unavailability, known errors, and known call failures.
eBay Developers Program System Announcements Forum
http://developer.ebay.com/forums
General information about the unified schema, on which the REST API is based, is available at the
following location:
http://developer.ebay.com/support/docs/
To learn about the eBay Affiliate Program, please see http://affiliates.ebay.com. If this link or other
links in this guide do not function, please close any open browser windows before using them. For
information about affiliate parameters in call requests, see “Affiliate Parameters” on page 5.
Introductory Samples
This sample shows how to use a Query parameter to search eBay:
http://rest.api.ebay.com/
restapi?CallName=GetSearchResults&RequestToken=UserToken&RequestUserId=UserName&Query=toy
%20boat&Version=491&UnifiedInput=1
This sample shows how to use a Query parameter to search eBay Express:
http://rest.api.ebay.com/
restapi?CallName=GetSearchResultsExpress&RequestToken=UserToken&RequestUserId=UserName&Que
ry=garmin+gps&EntriesPerPage=3&Version=491
Note
: The REST API can receive unified schema input parameters for GetSearchResults. The samples in this document have
been updated to show the unified schema input parameters (except in the section “Legacy REST GetSearchResults Input” on
page 23). For information about using unified schema input parameters for GetSearchResults, please see “Find Items with
GetSearchResults” on page 9.
