Get Search result

Search Result

End Point

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

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

{
  "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
        }
      ]
    }
  ]
}

Request samples

curl  --request GET 'http://api.cartup.ai/v1/widgetserver/search/result?request={"orgId":"850a8b8f-a6fe-49e4-88fc-874843279d66","searchQuery":"Compete Hoodie","filters":[],"sortEntities":[],"orgName":"WorldMarts","pagination":{"start":0,"row":12}}' 
--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

Name

Type

Required

Description

orgId

String

True

Organization Id - UUID

query

String

True

Query

filter

String

True

Filter

sortEntities

String

True

Sort Entities

com

String

True

Com

start

String

True

Start

rows

String

True

Rows

Last updated

Was this helpful?