Chapter 1: Using the REST API 11
Find Items with GetSearchResults
Version 3.7
Please make use of the unified schema input format and begin migrating all applications from legacy
input parameters to unified schema input parameters. To use the unified schema input format,
include the
UnifiedInput parameter and set it to 1 (UnifiedInput=1), as in the examples in this guide.
Descriptions of the
UnifiedInput parameter and the related Schema parameter are in the following
sections: “The UnifiedInput and Schema Parameters for GetSearchResults” on page 11 and
“Required Parameters” on page 4.
Input parameters for GetSearchResults are the same in the REST API as in the unified schema, except
for the REST-specific input parameters. For the REST-specific input parameters, see “Basic REST
Input Parameters” on page 3. For more information about using GetSearchResults, including
descriptions of the call-specific input and output parameters, see the following unified schema
document:
GetSearchResults
General information about the unified schema format is available at the following location:
http://developer.ebay.com/support/docs/
The following location contains additional information about using GetSearchResults in the unified
schema, as well as links to related topics:
http://developer.ebay.com/DevZone/XML/docs/WebHelp/
index.htm?context=eBay_XML_API&topic=SearchingItemsWithQuery
The UnifiedInput and Schema Parameters for GetSearchResults
For GetSearchResults, to use unified schema input, include the UnifiedInput parameter and set it to
1. All applications must be migrated from legacy input parameters to unified schema input
parameters.
If you do not include the
UnifiedInput parameter (and set it to 1), you must include the Schema
parameter and set it to 1. The
Schema parameter has the following characteristics:
Schema applies only to GetSearchResults.
Schema sets the output format to the unified schema format.
If the UnifiedInput parameter is omitted (or set to 0), and Schema is omitted or set to 0, output is
in the Legacy XML API format (unsupported as of June 1, 2006).
If you specify
UnifiedInput=1 in your input, then the Schema parameter is unnecessary; the output
format automatically will be in the unified schema format.
