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.
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
Content-Length: length
SOAPAction: "http://api.tradera.com/Search"
<?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:Header>
<AuthenticationHeader xmlns="http://api.tradera.com">
<AppId>int</AppId>
<AppKey>string</AppKey>
</AuthenticationHeader>
<ConfigurationHeader xmlns="http://api.tradera.com">
<Sandbox>int</Sandbox>
<MaxResultAge>int</MaxResultAge>
</ConfigurationHeader>
</soap:Header>
<soap:Body>
<Search xmlns="http://api.tradera.com">
<query>string</query>
<categoryId>int</categoryId>
<pageNumber>int</pageNumber>
<orderBy>string</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>
<TotalNumberOfItems>int</TotalNumberOfItems>
<TotalNumberOfPages>int</TotalNumberOfPages>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
</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:Header>
<AuthenticationHeader xmlns="http://api.tradera.com">
<AppId>int</AppId>
<AppKey>string</AppKey>
</AuthenticationHeader>
<ConfigurationHeader xmlns="http://api.tradera.com">
<Sandbox>int</Sandbox>
<MaxResultAge>int</MaxResultAge>
</ConfigurationHeader>
</soap12:Header>
<soap12:Body>
<Search xmlns="http://api.tradera.com">
<query>string</query>
<categoryId>int</categoryId>
<pageNumber>int</pageNumber>
<orderBy>string</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>
<TotalNumberOfItems>int</TotalNumberOfItems>
<TotalNumberOfPages>int</TotalNumberOfPages>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values xsi:nil="true" />
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
</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?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">
<TotalNumberOfItems>int</TotalNumberOfItems>
<TotalNumberOfPages>int</TotalNumberOfPages>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
</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
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">
<TotalNumberOfItems>int</TotalNumberOfItems>
<TotalNumberOfPages>int</TotalNumberOfPages>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Items>
<Id>int</Id>
<ShortDescription>string</ShortDescription>
<BuyItNowPrice>int</BuyItNowPrice>
<SellerId>int</SellerId>
<SellerAlias>string</SellerAlias>
<MaxBid>int</MaxBid>
<ThumbnailLink>string</ThumbnailLink>
<SellerDsrAverage>double</SellerDsrAverage>
<EndDate>dateTime</EndDate>
<NextBid>int</NextBid>
<HasBids>boolean</HasBids>
<IsEnded>boolean</IsEnded>
<ItemType>string</ItemType>
<ItemUrl>string</ItemUrl>
<CategoryId>int</CategoryId>
<BidCount>int</BidCount>
<ImageLinks>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
<ImageLink>
<Url>string</Url>
<Format>string</Format>
</ImageLink>
</ImageLinks>
<AttributeValues>
<TermAttributeValues>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
<TermAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<string>string</string>
<string>string</string>
</Values>
</TermAttributeValue>
</TermAttributeValues>
<NumberAttributeValues>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
<NumberAttributeValue>
<Id>int</Id>
<Name>string</Name>
<Values>
<decimal>decimal</decimal>
<decimal>decimal</decimal>
</Values>
</NumberAttributeValue>
</NumberAttributeValues>
</AttributeValues>
<LongDescription>string</LongDescription>
</Items>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
<Errors>
<Code>string</Code>
<Message>string</Message>
</Errors>
</SearchResult>