Search API

API change history

The Search API allows e-commerce websites to interact directly with the Faceted Search Engine.

Retrieve search results.

A simple GET call to retrieve search results matching the provided pattern from a preconfigured Search box identified by the box tracker.

Try it

Request

Request URL

Request parameters

  • string

    The unique identifier of the Search box. This is a constant (GUID). You can access the btr GUID via the Prefixbox Admin Portal on the Edit Search Box page, Integration tab, under Tracker.

  • integer

    Format - int32. Format - int32. Specifies the index of the result page to be retrieved in the request.

  • (optional)
    string

    The actual keyword text in the search input field. For example: Smart LED TV

  • (optional)
    integer

    Format - int32. Format - int32. Specifies the number of search results per page to be retrieved in the request. If left empty the default page size will be applied.

  • (optional)
    string

    OData filter expression to narrow down search results based on filterable fields. Field names in filter expressions are case sensitive and the exact field name should be used. You can access the available filterable field names via the Prefixbox Admin Portal on the Edit Suggestion List page, Field Mappings tab under Field Name column where the Facetable column value is set. A more detailed explanation of building OData filter expressions can be accessed in the official OData documentation page: https://www.odata.org/documentation/odata-version-2-0/uri-conventions/ For example: (category eq 'some category') and (brand eq 'some brand') and (price ge 500 and price le 1000)

  • (optional)
    string

    Order expression to sort the retrieved search results. You can access the availabe sortable field names via the Prefixbox Admin Portal on the Edit Suggestion List page, Field Mappings tab under Field Name column where the Sortable column value is set. For example: price asc

  • (optional)
    string

    Specifies the column names to be retrieved in the search results. All retrievable columns will be returned in case of an empty value. You can access the availabe retrievable field names via the Prefixbox Admin Portal on the Edit Suggestion List page, Field Mappings tab under Field Name column where the Retrievable column value is set. For example: displayText, price, category, brand

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns the search results.

Representations

{
  "documents": [
    {
      "score": 0.0,
      "document": {}
    }
  ],
  "filters": [
    {
      "name": "string",
      "displayName": "string",
      "type": "range",
      "order": 0,
      "count": 0,
      "ranges": [
        {
          "min": 0.0,
          "max": 0.0,
          "filteredMin": 0.0,
          "filteredMax": 0.0
        }
      ],
      "values": [
        {
          "count": 0,
          "name": "string",
          "disabled": false
        }
      ],
      "disabled": false
    }
  ],
  "resultStatus": "resultFound",
  "resultCount": 0,
  "resultPerPage": 0,
  "searchParameters": {
    "filters": {
      "rangeFilters": [
        {
          "name": "string",
          "min": 0.0,
          "max": 0.0
        }
      ],
      "termFilters": [
        {
          "name": "string",
          "values": [
            "string"
          ]
        }
      ]
    },
    "usedAdaptiveFaceting": true,
    "query": "string",
    "page": 0,
    "resultsPerPage": 0,
    "sorting": [
      {
        "name": "string",
        "order": "asc"
      }
    ]
  },
  "redirect": {
    "url": "string"
  },
  "banners": [
    {
      "position": "resultPageTop",
      "content": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "documents": {
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "score": {
            "format": "double",
            "type": "number"
          },
          "document": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          }
        }
      }
    },
    "filters": {
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "type": {
            "enum": [
              "range",
              "value"
            ],
            "type": "string"
          },
          "order": {
            "format": "int32",
            "type": "integer"
          },
          "count": {
            "format": "int32",
            "type": "integer"
          },
          "ranges": {
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "double",
                  "type": "number"
                },
                "max": {
                  "format": "double",
                  "type": "number"
                },
                "filteredMin": {
                  "format": "double",
                  "type": "number"
                },
                "filteredMax": {
                  "format": "double",
                  "type": "number"
                }
              }
            }
          },
          "values": {
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "count": {
                  "format": "int64",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "disabled": {
                  "default": false,
                  "type": "boolean"
                }
              }
            }
          },
          "disabled": {
            "default": false,
            "type": "boolean"
          }
        }
      }
    },
    "resultStatus": {
      "enum": [
        "resultFound",
        "resultNotFound",
        "errorOccured",
        "redirect"
      ],
      "type": "string"
    },
    "resultCount": {
      "format": "int64",
      "type": "integer"
    },
    "resultPerPage": {
      "format": "int64",
      "type": "integer"
    },
    "searchParameters": {
      "type": "object",
      "properties": {
        "filters": {
          "type": "object",
          "properties": {
            "rangeFilters": {
              "uniqueItems": false,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "min": {
                    "format": "double",
                    "type": "number"
                  },
                  "max": {
                    "format": "double",
                    "type": "number"
                  }
                }
              }
            },
            "termFilters": {
              "uniqueItems": false,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "values": {
                    "uniqueItems": false,
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "usedAdaptiveFaceting": {
          "type": "boolean"
        },
        "query": {
          "type": "string"
        },
        "page": {
          "format": "int64",
          "type": "integer"
        },
        "resultsPerPage": {
          "format": "int64",
          "type": "integer"
        },
        "sorting": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "order": {
                "enum": [
                  "asc",
                  "desc"
                ],
                "type": "string"
              }
            }
          }
        }
      }
    },
    "redirect": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        }
      }
    },
    "banners": {
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "position": {
            "enum": [
              "resultPageTop",
              "resultPageBottom",
              "filterTop",
              "filterBottom",
              "resultsAndControlsTop",
              "betweenResultsAndControlsTop",
              "betweenResultsAndControlsBottom",
              "resultsAndControlsBottom"
            ],
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

In case of invalid parameters.

Representations

string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.prefixbox.com/search/results?btr={btr}&page={page}?pattern={string}&top={integer}&filter={string}&orderby={string}&select={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["pattern"] = "{string}";
            queryString["top"] = "{integer}";
            queryString["filter"] = "{string}";
            queryString["orderby"] = "{string}";
            queryString["select"] = "{string}";
            var uri = "https://api.prefixbox.com/search/results?btr={btr}&page={page}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.prefixbox.com/search/results?btr={btr}&page={page}");

            builder.setParameter("pattern", "{string}");
            builder.setParameter("top", "{integer}");
            builder.setParameter("filter", "{string}");
            builder.setParameter("orderby", "{string}");
            builder.setParameter("select", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "pattern": "{string}",
            "top": "{integer}",
            "filter": "{string}",
            "orderby": "{string}",
            "select": "{string}",
        };
      
        $.ajax({
            url: "https://api.prefixbox.com/search/results?btr={btr}&page={page}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.prefixbox.com/search/results?btr={btr}&page={page}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"pattern={string}",
                         @"top={integer}",
                         @"filter={string}",
                         @"orderby={string}",
                         @"select={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.prefixbox.com/search/results?btr={btr}&page={page}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'pattern' => '{string}',
    'top' => '{integer}',
    'filter' => '{string}',
    'orderby' => '{string}',
    'select' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'pattern': '{string}',
    'top': '{integer}',
    'filter': '{string}',
    'orderby': '{string}',
    'select': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.prefixbox.com')
    conn.request("GET", "/search/results?btr={btr}&page={page}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'pattern': '{string}',
    'top': '{integer}',
    'filter': '{string}',
    'orderby': '{string}',
    'select': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.prefixbox.com')
    conn.request("GET", "/search/results?btr={btr}&page={page}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.prefixbox.com/search/results?btr={btr}&page={page}')

query = URI.encode_www_form({
    # Request parameters
    'pattern' => '{string}',
    'top' => '{integer}',
    'filter' => '{string}',
    'orderby' => '{string}',
    'select' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body