Shop.app

Suggest Shop.app searches

Returns Shop.app autocomplete suggestions for the required query. limit defaults to 10 and is capped at 20. Each suggestion is either a search query or a shop, with its text, type, URL and, for shops, the shop handle, name, rating and image.

get/shop-app/suggestions

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/shop-app/suggestions
  • Auth: API key in header x-api-key

Query parameters

querystring required

Search query

limitinteger

Maximum suggestions, defaults to 10 and supports up to 20

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "limit": 10,
    "query": "sneakers",
    "suggestions": [
      {
        "rating": 4.79,
        "shop_handle": "gr21z45he0",
        "shop_id": "365323",
        "shop_name": "Sneakers Plus",
        "text": "sneakers",
        "type": "query",
        "url": "https://shop.app/search/results?query=sneakers"
      }
    ]
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.