SearchService Web Service

Full documentation for this service is available at /documentation/search-service.

Search |WebMethod|

Search for items. Possible errors: "OrderByValidationError" - use of non-existing sort order (OrderBy). "SearchStringValidationError" - when searching for invalid search words. "InternalError" - internal error.

Parameters

query, The search query
categoryId, The Id of the category to search in (0 for all categories)
pageNumber, The page to return, starting with 1 for the first page.
orderBy, How the results should be ordered Possible values: "Relevance" - order by relevance (default). "BidsAscending" - order by bid amount ascending. "BidsDescending" - order by bid amount descending. "PriceAscending" - order by price ascending. "PriceDescending" - order by price descending. "EndDateAscending" - order by end date ascending. "EndDateDescending" - order by end date descending.

Returns

Filled SearchResult object

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/SearchService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://api.tradera.com/Search"
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Search xmlns="http://api.tradera.com">
      <query>query</query>
      <categoryId>categoryId</categoryId>
      <pageNumber>pageNumber</pageNumber>
      <orderBy>orderBy</orderBy>
    </Search>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SearchResponse xmlns="http://api.tradera.com">
      <SearchResult>Filled SearchResult object</SearchResult>
    </SearchResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/SearchService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Search xmlns="http://api.tradera.com">
      <query>query</query>
      <categoryId>categoryId</categoryId>
      <pageNumber>pageNumber</pageNumber>
      <orderBy>orderBy</orderBy>
    </Search>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SearchResponse xmlns="http://api.tradera.com">
      <SearchResult>Filled SearchResult object</SearchResult>
    </SearchResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3/SearchService.asmx/Search?appId=string&appKey=string&query=string&categoryId=string&pageNumber=string&orderBy=string HTTP/1.1
Host: api.tradera.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SearchResult xmlns="http://api.tradera.com">Filled SearchResult object</SearchResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3/SearchService.asmx/Search HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

appId=string&appKey=string&query=string&categoryId=string&pageNumber=string&orderBy=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SearchResult xmlns="http://api.tradera.com">Filled SearchResult object</SearchResult>