Search (v2)

Get Results

Used to get search results that match the given query. Has support for filtering and sorting. Example response: <pre> { "n_hits": 1, "displays": [ { "product_id": "foobar", "title": "Foobar" } ], "sorts": [ { "field": "_relevance", "order": "desc", "meta": { "title": "Relevance", "values": [ "desc" ], "names": [ "Relevance" ] } }, { "field": "title", "order": "asc", "meta": { "title": "Title", "values": [ "asc", "desc" ], "names": [ "A-Z", "Z-A" ] } } ], "filters": [ { "field": "sale_price", "op": "inrange", "data": [ 0, 2500 ], "meta": { "group_title": "Price", "type": "range", "min": 0, "max": 2500, "currency": "EUR" }, "id": "price0" }, { "field": "color_name", "op": "in", "meta": { "group_title": "Color", "type": "checkbox", "values": [ "Blue", "Black", "Brown" ] }, "id": "colors1" } ], "search_request_id": "1a278f4a-16eb-4d95-a002-88bd305493d4", "cursor": "eyJjIjogMSwgInIiOiAwfQ==" } </pre> Example request body for applying a filter: <pre> { "tenant": "foobar" "market": "en", "limit": 20, "query": "hoodie", "filters": [ { "field": "color_name", "op": "in", "data": ["Blue"] } ] } </pre>

POST

results

{
  "n_hits": 123,
  "sorts": [
    {
      "field": "<string>",
      "order": "asc",
      "meta": {
        "title": "<string>",
        "values": [
          "asc"
        ],
        "names": [
          "<string>"
        ]
      }
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "group_title": "<string>",
        "group_expanded": true,
        "type": "<any>",
        "min": 123,
        "max": 123,
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "search_request_id": "<string>",
  "cursor": "<string>",
  "content_search_links": [
    {
      "type": "<any>",
      "title": "<string>",
      "description": "<string>",
      "image_url": "<string>",
      "page_url": "<string>",
      "highlights": [
        {
          "field": "<string>",
          "snippet": "<string>",
          "matched_tokens": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "displays": [
    {}
  ],
  "debug_info": "<any>"
}

Authorizations

api_key

string

query

required

Headers

x-use-db-display-store

boolean

default:false

Body

application/json

Response

200

application/json

Successful Response

The response is of type object.

Get Products Get Suggestions

{
  "n_hits": 123,
  "sorts": [
    {
      "field": "<string>",
      "order": "asc",
      "meta": {
        "title": "<string>",
        "values": [
          "asc"
        ],
        "names": [
          "<string>"
        ]
      }
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "group_title": "<string>",
        "group_expanded": true,
        "type": "<any>",
        "min": 123,
        "max": 123,
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "search_request_id": "<string>",
  "cursor": "<string>",
  "content_search_links": [
    {
      "type": "<any>",
      "title": "<string>",
      "description": "<string>",
      "image_url": "<string>",
      "page_url": "<string>",
      "highlights": [
        {
          "field": "<string>",
          "snippet": "<string>",
          "matched_tokens": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "displays": [
    {}
  ],
  "debug_info": "<any>"
}

Glossary

Shopify app

Data ingestion

Search

Product Listing Pages

Product Listing Pages and Search

Looks

Recommendations SDK

Tracking Product Interactions

HTTP API

Get Results

Authorizations

Headers

Body

Response