Magento Search API


Search API

What is the Magento Search API?

The Magento Search extension API is a Magento extension that allows Magento Store owners to provide a SOAP Service for other websites/apps to do product search with just a few lines of code and get a list of products from within your magento store. This extension uses the default search functionality so results should be similar.

– Use from any third party store, site or app
– Extends Magento native SOAP API
– Search by keywords
– Extends Magento default search so functionality is similar to it
– Limit number of results
– Can be easily modified to return additional product data
– Return results as array or json format
– Style results as needed
– Simple install and setup
– Includes documentation and test script to help with third party implementation

What does this Search extension do?

The Magento Search API receives a search keyword(s) and returns a specified number of products that match the search keyword allowing you to provide quick access for clients/partner websites/apps to the products you offer. This extension is set to return the product details: name, image and link and can be easily modified to return additional product data. The Magento Search API extension is naturally integrated with Magento and therefore all search related statistics are preserved and available in the Magento admin.

Where can I use this search extension?

It is cross platform – any platform that can use SOAP can use the API. It is super easy, you make 2 calls, and voila – you get keyword related Magento products list. Magento comes with a native SOAP Server and the Magento Search API uses all the Magento native calls so all Major programming languages that can do SOAP calls(PHP, JAVA, C#, C++, …), can use and integrate the Magento Search API in any website/application.

What Magento Versions Are Supported?

The extension has been tested on 1.6.0, 1.6.1, 1.6.2, 1.7.0, 1.8, 1.8.1.

Is there support for this extension?

Yes, you can visit us at our website: to get help.

How does the Search API extension work?

The following is the code used to make the Web Service Call:

$proxy = new SoapClient(‘http://YOUR_DOMAIN/index.php/api/soap/?wsdl’); // enter your magento path
$mag_api_user = ‘username’; // enter Web Service username
$mag_api_pass = ‘password’; // enter Web Service password
$queryString = ‘sony’; // this is for manual testing, enter search string here
$limit = 3; // limit results to x amount
$ret = ‘json’; // valid values are ‘json’ and ‘array’

try {
$sessionId = $proxy->login($mag_api_user, $mag_api_pass);
$results = $proxy->call($sessionId, ‘catalogSearchApi.getResults’, array($queryString, $limit, array(‘format’ => $ret)));
catch (Exception $e) {
echo “Error: “.$e->getMessage();

echo ‘<div class=”demo_search_results_wrapper”>’;

foreach ($results as $v){
echo ‘<div class=”demo_search_results”>’;
echo ‘<div class=”demo_search_results_image”><img src=”‘.$v[‘imageurl’].'” width=”135″ height=”135″ border=”0″ /></div>’;
echo ‘<div class=”demo_search_results_title”><a href=”‘.$v[‘url’].'”>’.$v[‘title’].'</a></div>’;
echo ‘</div>’;

echo ‘</div>’;


Leave a Reply

Your email address will not be published. Required fields are marked *