v1

latestOpenAPI 3.0.32026-07-173196215.4 KB
search-v1

Resolve v1

This endpoint is intended to provide one best match.

The request needs to match at least one category and one attribute. For example, searching for pants black denim useless would return category pants that have two attributes: black and denim. The useless will be discarded. If the best match was found, it will return the relevant result; otherwise, it will return nothing.

A detailed explanation of the functionality can be found in SCAYLE Panel developer guide

get/v1/search/resolve

Query parameters

termstring required
Example:pants black

The search term to match attributes and categories.

categoryIdinteger
Example:20201

The categoryId parameter is used to filter the results and limit the returned data to items that belong to the specified category or its child categories.

Response

successful operation

Example response

{
  "matches": [
    {
      "count": 20201,
      "match": "pants Unifarben",
      "category": {
        "match": "pants",
        "id": 20201,
        "name": "pants"
      },
      "attributes": [
        {
          "match": "Unifarben",
          "name": "pattern",
          "attributeGroup": 123,
          "attributeId": 223344
        }
      ]
    }
  ]
}