Get Search Config

Get Search Config

Get the all search information.

End Point

GET https://api.cartup.ai/v1/conf/search

‌

Query Parameters

Name	Type	Description
request*	String	Request Object (Refer below)

Headers

Name	Type	Description
Accept*	String	application/json
Content_type*	String	application/json
X-Cartup-Access-Token*	String	$CARTUP_API_KEY
X-Cartup-orgId*	String	$CARTUP_ORD_ID

200: OK The response contains the complete search configuration along with the ID

{
    "errMsg": null,
    "id": "fa673540-57ba-4e02-8c16-28ee0513ae38-searchconf",
    "orgId": "test-fa673540-57ba-4e02-8c16-28ee0513ae38",
    "docType": "searchconf",
    "spellcheck": true,
    "includeWidgets": [
        "crosssell",
        "recentviews"
    ],
    "facetList": [
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "price",
                    "repoFieldName": "price_d",
                    "displayName": "Price",
                    "value": [
                        {
                            "index": 0,
                            "alias": null,
                            "name": "0 - 20",
                            "value": "[0 TO 20]"
                        },
                        {
                            "index": 1,
                            "alias": null,
                            "name": "20 - 60",
                            "value": "[21 TO 60]"
                        },
                        {
                            "index": 2,
                            "alias": null,
                            "name": "60 - 100",
                            "value": "[61 TO 100]"
                        },
                        {
                            "index": 3,
                            "alias": null,
                            "name": "101 - *",
                            "value": "[101 TO 100]"
                        }
                    ],
                    "operator": "="
                }
            ],
            "category": "default"
        },
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "Gender",
                    "repoFieldName": "gender_ss",
                    "displayName": "Gender",
                    "value": null,
                    "operator": "="
                }
            ],
            "category": "Tops"
        },
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "color",
                    "repoFieldName": "color_s",
                    "displayName": "Color",
                    "value": null,
                    "operator": null
                },
                {
                    "displayType": "link",
                    "type": "size",
                    "repoFieldName": "pant_fit_s",
                    "displayName": "Pant Fit",
                    "value": null,
                    "operator": null
                }
            ],
            "category": "cloth"
        }
    ],
    "paginationCount": 20,
    "searchableFields": [
        {
            "repoFieldName": "namel_t",
            "displayName": "name",
            "order": 0,
            "orderBy": null
        },
        {
            "repoFieldName": "description_t",
            "displayName": "description",
            "order": 1,
            "orderBy": null
        }
    ],
    "searchSynonym": null,
    "sortEntity": {
        "sortEntities": [
            {
                "key": "Price High to Low",
                "value": "price desc",
                "type": "integer"
            }
        ]
    },
    "indexLang": "en",
    "queryLang": "en",
    "personalization": true,
    "reranking": true,
    "synonym": true,
    "stopWords": true-a6fe-49e4-88fc-874843279d66-searchconf"
}

400: Bad Request

{
    "errMsg": "request json is not present in request params",
    "id": null,
    "orgId": null,
    "docType": null,
    "spellcheck": false,
    "includeWidgets": null,
    "facetList": null,
    "paginationCount": null,
    "searchableFields": null,
    "searchSynonym": null,
    "sortEntity": null,
    "indexLang": null,
    "queryLang": null,
    "personalization": null,
    "reranking": null,
    "synonym": null,
    "stopWords": null
}

‌

Curl example

curl --request GET https://api.cartup.ai/v1/conf/search?request={"orgId":"850a8b8f-a6fe-49e4-88fc-874843279d66"}'
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'X-Cartup-Access-Token: $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'

‌Request Object

Key	Type	Description	Required
orgId	String	Your Org ID	Yes

Request samples

{
    "errMsg": null,
    "id": "fa673540-57ba-4e02-8c16-28ee0513ae38-searchconf",
    "orgId": "test-fa673540-57ba-4e02-8c16-28ee0513ae38",
    "docType": "searchconf",
    "spellcheck": true,
    "includeWidgets": [
        "crosssell",
        "recentviews"
    ],
    "facetList": [
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "price",
                    "repoFieldName": "price_d",
                    "displayName": "Price",
                    "value": [
                        {
                            "index": 0,
                            "alias": null,
                            "name": "0 - 20",
                            "value": "[0 TO 20]"
                        },
                        {
                            "index": 1,
                            "alias": null,
                            "name": "20 - 60",
                            "value": "[21 TO 60]"
                        },
                        {
                            "index": 2,
                            "alias": null,
                            "name": "60 - 100",
                            "value": "[61 TO 100]"
                        },
                        {
                            "index": 3,
                            "alias": null,
                            "name": "101 - *",
                            "value": "[101 TO 100]"
                        }
                    ],
                    "operator": "="
                }
            ],
            "category": "default"
        },
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "Gender",
                    "repoFieldName": "gender_ss",
                    "displayName": "Gender",
                    "value": null,
                    "operator": "="
                }
            ],
            "category": "Tops"
        },
        {
            "facets": [
                {
                    "displayType": "link",
                    "type": "color",
                    "repoFieldName": "color_s",
                    "displayName": "Color",
                    "value": null,
                    "operator": null
                },
                {
                    "displayType": "link",
                    "type": "size",
                    "repoFieldName": "pant_fit_s",
                    "displayName": "Pant Fit",
                    "value": null,
                    "operator": null
                }
            ],
            "category": "cloth"
        }
    ],
    "paginationCount": 20,
    "searchableFields": [
        {
            "repoFieldName": "namel_t",
            "displayName": "name",
            "order": 0,
            "orderBy": null
        },
        {
            "repoFieldName": "description_t",
            "displayName": "description",
            "order": 1,
            "orderBy": null
        }
    ],
    "searchSynonym": null,
    "sortEntity": {
        "sortEntities": [
            {
                "key": "Price High to Low",
                "value": "price desc",
                "type": "integer"
            }
        ]
    },
    "indexLang": "en",
    "queryLang": "en",
    "personalization": true,
    "reranking": true,
    "synonym": true,
    "stopWords": true
}

‌