Get Search suggestions

Search Suggestions

End Point

GET https://api.cartup.ai/v1/widgetserver/keyword_suggestion

‌

Query Parameters

Name	Type	Description
orgId*	String	Your Org ID
keyword*	String	The text the user searches for
lang*	String	language of the store
type*	String	type of the suggestion
autosuggest category*	Boolean	flag - to include category suggestions or not
fuzzy_suggest*	Boolean	flag - to use fuzzy suggested
spell_word_segementation*	Boolean	flag - to include word Segmentation for the suggestions
language_spell_check*	Boolean	flag - to enable spell check

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

{
  "Numberofdocs": 23,
  "Pagination": 20,
  "SearchEntities": [
    {
      "key": "Most Popular",
      "value": "popularity_score_d desc"
    }
  ],
  "Docs": [
    {
      "name": "Bruno Compete Hoodie",
      "sku": "MH03",
      "price": 63,
      "discountedprice": null,
      "smallimage": "http://mdev.ecomtics.nl//pub/media/catalog/product/m/h/mh03-black_main_1.jpg",
      "currentPageUrl": "http://mdev.ecomtics.nl/bruno-compete-hoodie.html",
      "description": "Stay comfortable and stay in the race no matter what the weather's up to. The Bruno Compete Hoodie's water-repellent exterior shields you from the elements, while advanced fabric technology inside wicks moisture to keep you dry. • Full zip black hoodie pullover. • Adjustable drawstring hood. • Ribbed cuffs/waistband. • Kangaroo pocket. • Machine wash/dry."
    }
  ],
  "facetcount": [
    {
      "type": "categorical",
      "repoFieldName": "gender_ss",
      "displayName": "Gender",
      "displayType": "multiselect",
      "value": [
        {
          "index": 1,
          "name": "Female",
          "value": "Female",
          "operator": "=",
          "count": 14
        }
      ]
    }
  ]
}

400: Bad Request The response contains error message

{
  "errMsg": "orgId param is empty",
  "numberofdocs": 0,
  "success": null,
  "widgetType": null,
  "widgetName": null,
  "products": null
}

‌

Request samples

curl --request GET 'https://api.cartup.ai/v1/widgetserver/keyword_suggestion' 
--header 'Accept: application/json' \
--header 'Content-Type: application/json' 
--header 'X-Cartup-Access-Token:$CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'

‌

Payload

{
  "orgid": null,
  "keyword": "hoodie",
  "lang": "nl",
  "type": "key-suggestion/search/filter",
  "autosuggest_category": true,
  "fuzzy_suggest": false,
  "spell_word_segementation": false,
  "language_spell_check": false
}

‌