Znode

Build Version:

POST search/keyword

Performs keyword search.

Request Information

» Parameters

Name Description Additional information
model The model of the keyword search.

Define this parameter in the request body.

» Expands

Name Description Usage
categories This will retrieve the related list of categories. POST search/keyword?expand=categories
facets This will retrieve the related list of facets. POST search/keyword?expand=facets

» Sorting

Name Description Usage
name This will sort the response by name. POST search/keyword?sort=name
rating This will sort the response by rating. POST search/keyword?sort=rating
relevance This will sort the response by relevance. POST search/keyword?sort=relevance

Request Body Formats

Sample: 
	{
  "Category": "sample string 1",
  "CategoryId": 1,
  "ExternalIdEnabled": true,
  "ExternalIdNotNullCheck": true,
  "InnerSearchKeywords": {
    "$id": "2",
    "$values": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  "Keyword": "sample string 4",
  "RefineBy": {
    "$id": "3",
    "$values": [
      {
        "Key": "sample string 1",
        "Value": {
          "$id": "4",
          "$values": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        }
      },
      {
        "Key": "sample string 1",
        "Value": {
          "$id": "5",
          "$values": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        }
      },
      {
        "Key": "sample string 1",
        "Value": {
          "$id": "6",
          "$values": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        }
      }
    ]
  },
  "Categories": {
    "$id": "7",
    "$values": [
      {
        "$id": "8",
        "Count": 1,
        "Hierarchy": {
          "$id": "9",
          "$values": [
            {
              "$ref": "8"
            },
            {
              "$ref": "8"
            },
            {
              "$ref": "8"
            }
          ]
        },
        "Id": "sample string 2",
        "Name": "sample string 3",
        "Title": "sample string 4"
      },
      {
        "$ref": "8"
      },
      {
        "$ref": "8"
      }
    ]
  },
  "Facets": {
    "$id": "10",
    "$values": [
      {
        "$id": "11",
        "AttributeName": "sample string 1",
        "AttributeValues": {
          "$id": "12",
          "$values": [
            {
              "$id": "13",
              "AttributeValue": "sample string 1",
              "FacetCount": 2
            },
            {
              "$ref": "13"
            },
            {
              "$ref": "13"
            }
          ]
        },
        "ControlTypeId": 2
      },
      {
        "$ref": "11"
      },
      {
        "$ref": "11"
      }
    ]
  },
  "Products": {
    "$id": "14",
    "$values": [
      {
        "$id": "15",
        "Id": "sample string 1"
      },
      {
        "$ref": "15"
      },
      {
        "$ref": "15"
      }
    ]
  }
}