Search

Search…
PA’s Search API provides near real-time (less than 100ms) search results for your website. Before you get started, please check with your PA Account Manager that search is approved for your account.
New features will be introduced to the latest API version as we upgrade our Search API. Currently, the latest version is v1.4. You can also find the previous API versions listed below.
Search v1.4 
post
https://search.api.similarinc.com
/v1.4/search
Example Request
As PA does all the complex computation in the background, the API interface for receiving search results is simple.
1
curl --request POST 'https://search.api.similarinc.com/1.4/Search' \
2
--header 'Content-Type: application/json' \
3
--data-raw '{
4
   "customerId": "CUSTOMER_ID",
5
   "websieId": "WEBSITE_ID",
6
   "q": "chair",
7
   "client": "xyz",
8
   "personalise": false,
9
   "search_fields": {
10
        "title": {},
11
        "brand": {
12
            "fuzziness": "auto"
13
        },
14
        "brand.text_keyword": {
15
            "fuzziness": "auto"
16
        },
17
        "product_category": {},
18
        "description": {}
19
    },
20
   "fuzzy": false,
21
   "null_checks":["title"],
22
   "start": 0,
23
   "image_link": "",
24
   "scope": {"sale_price":{"min": 10}},
25
   "sort_fields": [
26
        {"org_price": "ASC"},
27
        {"sale_price": "ASC"}
28
    ],
29
    "aggregations": [
30
        "product_type",
31
        "brand"
32
    ],
33
    "rules": [
34
        {
35
            "name": "sale_price",
36
            "values": {
37
                "gte": 250,
38
                "lte": 300
39
            },
40
            "boost": 3
41
        }
42
    ],
43
    "range_fields": ["sale_price"],
44
    "size": 1,
45
    "weights": {"image": 10, "text": 5},
46
    "exclude_ids":[],
47
    "availability": "in stock"
48
}'
49
​
Copied!
Example Response
For all our search APIs, the output is standardised to ensure that our clients have the smoothest experience in integrating different algorithms for different use cases.
1
{
2
    "payload": {
3
        "total_results": 1,
4
        "next_cursor": null,
5
        "aggregations": {
6
        "product_type": [
7
           {
8
                "key": "Furniture > Dining Room > Dining tables",
9
                "doc_count": 173
10
            },
11
        "brand": [
12
           {
13
                "key": "HAY",
14
                "doc_count": 20
15
            },
16
        ]
17
        }
18
        "results": [
19
            {
20
                "attributes": {
21
                    "colour": "Walnut",
22
                    "price": 1200.0,
23
                    "sale_price": 1100.0,
24
                    "size": ["8 Seater"],
25
                    "product_type": "Furniture > Dining Room > Dining tables",
26
                    "product_category": "Furniture",
27
                    "brand": "HAY"
28
                    
29
                },
30
                "image_url": "https://XXXX.jpg",
31
                "link": "https://XXXX.uk",
32
                "item_group_id": 21260,
33
                "sku_id": 268262,
34
                "title": "8 Seater Oval Walnut Dining Table",
35
                "product_type": "Furniture > Dining Room > Dining tables",
36
                "score": 0.9670957669803361,
37
                "product_category_id": 677,
38
                "object_types": [
39
                    "tableware"
40
                ],
41
               "personalized": false,
42
               "availability": "in stock"
43
            }
44
       ],
45
       "website_id": "D6EB943D-CCCCCCXXXXXX-A093EF"
46
    },
47
    "type": 1,
48
    "code": 0
49
}
Copied!
Search v1.3
post
https://search.api.similarinc.com
/v1.3/search
Example Request
1
curl --request POST 'https://search.api.similarinc.com/1.3/Search' \
2
--header 'Content-Type: application/json' \
3
--data-raw '{
4
   "customerId": "CUSTOMER_ID",
5
   "websiteId": "WEBSITE_ID",
6
   "q": "chair",
7
   "client": "xyz",
8
   "personalise": false,
9
   "search_fields": {
10
        "title": {},
11
        "brand": {
12
            "fuzziness": "auto"
13
        },
14
        "brand.text_keyword": {
15
            "fuzziness": "auto"
16
        },
17
        "product_category": {},
18
        "description": {}
19
    },
20
   "fuzzy": false,
21
   "null_checks":["title"],
22
   "start": 0,
23
   "image_link": "",
24
   "scope": {"sale_price":{"min": 10}},
25
   "sort_fields": [
26
        {"org_price": "ASC"},
27
        {"sale_price": "ASC"}
28
    ],
29
    "aggregations": [
30
        "product_type",
31
        "brand"
32
    ],
33
    "range_fields": ["sale_price"],
34
    "size": 1,
35
    "weights": {"image": 10, "text": 5},
36
    "exclude_ids":[],
37
    "availability": "in stock"
38
}'
Copied!
Example Response
1
{
2
    "payload": {
3
        "total_results": 1,
4
        "next_cursor": null,
5
        "aggregations": {
6
           "product_type": [
7
               {
8
                    "key": "Furniture > Dining Room > Dining tables",
9
                    "doc_count": 173
10
                },
11
            "brand": [
12
               {
13
                    "key": "HAY",
14
                    "doc_count": 20
15
                },
16
            ]
17
        }
18
        "results": [
19
            {
20
                "attributes": {
21
                    "colour": "Walnut",
22
                    "price": 1200.0,
23
                    "sale_price": 1100.0,
24
                    "size": ["8 Seater"],
25
                    "product_type": "Furniture > Dining Room > Dining tables",
26
                    "product_category": "Furniture",
27
                    "brand": "HAY"
28
                    
29
                },
30
                "image_url": "https://XXXX.jpg",
31
                "link": "https://XXXX.uk",
32
                "item_group_id": 21260,
33
                "sku_id": 268262,
34
                "title": "8 Seater Oval Walnut Dining Table",
35
                "product_type": "Furniture > Dining Room > Dining tables",
36
                "score": 0.9670957669803361,
37
                "product_category_id": 677,
38
                "object_types": [
39
                    "tableware"
40
                ],
41
               "personalized": false,
42
               "availability": "in stock"
43
            }
44
       ],
45
       "website_id": "D6EB943D-CCCCCCXXXXXX-A093EF"
46
    },
47
    "type": 1,
48
    "code": 0
49
}
Copied!
Search v1.2
post
https://search.api.similarinc.com
/v1.2/search
Example Request
1
curl --request POST 'https://search.api.similarinc.com/1.2/Search' \
2
--header 'Content-Type: application/json' \
3
--data-raw '{
4
   "customerId": "CUSTOMER_ID",
5
   "websiteId": "WEBSITE_ID",
6
   "q": "chair",
7
   "client": "xyz",
8
   "personalise": false,
9
   "search_fields": {
10
        "title": {},
11
        "brand": {
12
            "fuzziness": "auto"
13
        },
14
        "brand.text_keyword": {
15
            "fuzziness": "auto"
16
        },
17
        "product_category": {},
18
        "description": {}
19
    },
20
   "fuzzy": false,
21
   "null_checks":["title"],
22
   "start": 0,
23
   "image_link": "",
24
   "scope": {"sale_price":{"min": 10}},
25
    "aggregations": [
26
        "product_type",
27
        "brand"
28
    ],
29
    "range_fields": ["sale_price"],
30
    "size": 1,
31
    "weights": {"image": 10, "text": 5},
32
    "exclude_ids":[],
33
    "availability": "in stock"
34
}'
Copied!
Example Response
1
{
2
    "payload": {
3
        "total_results": 1,
4
        "next_cursor": null,
5
        "aggregations": {
6
           "product_type": [
7
               {
8
                    "key": "Furniture > Dining Room > Dining tables",
9
                    "doc_count": 173
10
                },
11
            "brand": [
12
               {
13
                    "key": "HAY",
14
                    "doc_count": 20
15
                },
16
            ]
17
        }
18
        "results": [
19
            {
20
                "attributes": {
21
                    "colour": "Walnut",
22
                    "price": 1200.0,
23
                    "sale_price": 1100.0,
24
                    "size": ["8 Seater"],
25
                    "product_type": "Furniture > Dining Room > Dining tables",
26
                    "product_category": "Furniture",
27
                    "brand": "HAY"
28
                    
29
                },
30
                "image_url": "https://XXXX.jpg",
31
                "link": "https://XXXX.uk",
32
                "item_group_id": 21260,
33
                "sku_id": 268262,
34
                "title": "8 Seater Oval Walnut Dining Table",
35
                "product_type": "Furniture > Dining Room > Dining tables",
36
                "score": 0.9670957669803361,
37
                "product_category_id": 677,
38
                "object_types": [
39
                    "tableware"
40
                ],
41
               "personalized": false,
42
               "availability": "in stock"
43
            }
44
       ],
45
       "website_id": "D6EB943D-CCCCCCXXXXXX-A093EF"
46
    },
47
    "type": 1,
48
    "code": 0
49
}
Copied!
Search v1.1
post
https://search.api.similarinc.com
/v1.1/search
Example Request
1
curl --request POST 'https://search.api.similarinc.com/1.1/Search' \
2
--header 'Content-Type: application/json' \
3
--data-raw '{
4
   "customerId": "CUSTOMER_ID",
5
   "websiteId": "WEBSITE_ID",
6
   "q": "chair",
7
   "client": "xyz",
8
   "personalise": false,
9
   "search_fields": ["title", "brand"]
10
   "fuzzy": false,
11
   "null_checks":["title"],
12
   "start": 0,
13
   "image_link": "",
14
   "scope": {"sale_price":{"min": 10}},
15
    "aggregations": [
16
        "product_type",
17
        "brand"
18
    ],
19
    "range_fields": ["sale_price"],
20
    "size": 1,
21
    "weights": {"image": 10, "text": 5},
22
    "exclude_ids":[],
23
    "availability": "in stock"
24
}'
Copied!
Example Response
1
{
2
    "payload": {
3
        "total_results": 1,
4
        "next_cursor": null,
5
        "aggregations": {
6
           "product_type": [
7
               {
8
                    "key": "Furniture > Dining Room > Dining tables",
9
                    "doc_count": 173
10
                },
11
            "brand": [
12
               {
13
                    "key": "HAY",
14
                    "doc_count": 20
15
                },
16
            ]
17
        }
18
        "results": [
19
            {
20
                "attributes": {
21
                    "colour": "Walnut",
22
                    "price": 1200.0,
23
                    "sale_price": 1100.0,
24
                    "size": ["8 Seater"],
25
                    "product_type": "Furniture > Dining Room > Dining tables",
26
                    "product_category": "Furniture",
27
                    "brand": "HAY"
28
                    
29
                },
30
                "image_url": "https://XXXX.jpg",
31
                "link": "https://XXXX.uk",
32
                "item_group_id": 21260,
33
                "sku_id": 268262,
34
                "title": "8 Seater Oval Walnut Dining Table",
35
                "product_type": "Furniture > Dining Room > Dining tables",
36
                "score": 0.9670957669803361,
37
                "product_category_id": 677,
38
                "object_types": [
39
                    "tableware"
40
                ],
41
               "personalized": false,
42
               "availability": "in stock"
43
            }
44
       ],
45
       "website_id": "D6EB943D-CCCCCCXXXXXX-A093EF"
46
    },
47
    "type": 1,
48
    "code": 0
49
}
Copied!
Search v1.0
post
https://search.api.similarinc.com
/v1.0/search
Example Request
1
curl --request POST 'https://search.api.similarinc.com/1.0/Search' \
2
--header 'Content-Type: application/json' \
3
--data-raw '{
4
   "customerId": "CUSTOMER_ID",
5
   "websiteId": "WEBSITE_ID",
6
   "q": "chair",
7
   "client": "xyz",
8
   "personalise": false,
9
   "search_fields": ["title", "brand"]
10
   "fuzzy": false,
11
   "null_checks":["title"],
12
   "start": 0,
13
   "image_link": "",
14
   "scope": {"sale_price":{"min": 10}},
15
    "aggregations": [
16
        "product_type",
17
        "brand"
18
    ],
19
    "size": 1,
20
    "weights": {"image": 10, "text": 5},
21
    "exclude_ids":[],
22
    "availability": "in stock"
23
}'
Copied!
Example Response
1
{
2
    "payload": {
3
        "total_results": 1,
4
        "next_cursor": null,
5
        "aggregations": {
6
           "product_type": [
7
               {
8
                    "key": "Furniture > Dining Room > Dining tables",
9
                    "doc_count": 173
10
                },
11
            "brand": [
12
               {
13
                    "key": "HAY",
14
                    "doc_count": 20
15
                },
16
            ]
17
        }
18
        "results": [
19
            {
20
                "attributes": {
21
                    "colour": "Walnut",
22
                    "price": 1200.0,
23
                    "sale_price": 1100.0,
24
                    "size": ["8 Seater"],
25
                    "product_type": "Furniture > Dining Room > Dining tables",
26
                    "product_category": "Furniture",
27
                    "brand": "HAY"
28
                    
29
                },
30
                "image_url": "https://XXXX.jpg",
31
                "link": "https://XXXX.uk",
32
                "item_group_id": 21260,
33
                "sku_id": 268262,
34
                "title": "8 Seater Oval Walnut Dining Table",
35
                "product_type": "Furniture > Dining Room > Dining tables",
36
                "score": 0.9670957669803361,
37
                "product_category_id": 677,
38
                "object_types": [
39
                    "tableware"
40
                ],
41
               "personalized": false,
42
               "availability": "in stock"
43
            }
44
       ],
45
       "website_id": "D6EB943D-CCCCCCXXXXXX-A093EF"
46
    },
47
    "type": 1,
48
    "code": 0
49
}
Copied!
Recommendation API - Previous
Sample Response
Next - Managed Services
Google Tag Manager
Last modified 8d ago