Category tree by country

GET /categories/tree/{countryId}

Endpoint to get categories by country

Filling in the above requirements is used to properly equip the products into the web section. If this is not the case, the product may not be listed correctly or may not appear on our website at all.

Description of product category section (`sapCategories`)

An operator is an element that is informative and is not desirable for parameter values.

"sapCategories": [
  {
    "productTypeId": "WA039",
    "operator": "AND",
    "menuConstraints": [
      {
        "paramId": "ELECTRIC",
        "operator": "=",
        "value1": "Ano",
        "value2": "string",
        "class": 6
      }
    ],
    "segment": "EB"
  }
]

The `operator` field may contain following attributes

AND all menuConstraints items must be evaluated as true
OR one of menuConstraints items must be evaluated as true

Description of category conditions section (`menuConstraints`)

An operator is an element that is informative and is not desirable for parameter values.

"menuConstraints": [
  {
    "paramId": "ELECTRIC",
    "operator": "=",
    "value1": "Ano",
    "value2": "string",
    "class": 6
  }
]

The field `operator` may contain following attributes

IN selection from a set of values
ALL respected parameter has to have all values
NOT IN respected parameter has to have NONE of the values
= must contains value1
>< items between values
> greater than value1
< smaller than value1
<> not equal to value1

Please state all the requisites in accordance with the documentation received for your specific connection.

Description of the `fulltextQuery` field

This optional field specifies which keywords must / must not appear in the short and long product description.
The query uses Elasticsearch "Simple query string query" syntax specified here.
Example: the query +("carrot", "cucumber") -("apple", "pear") means that the short and long product description must contain one of ["carrot", "cucumber"] and must not contain neither of ["apple", "pear"].

Headers

X-Application-Name string

Path parameters

countryId string Required

Country ID

Values are CZ10MA, SK10MA, HU20MA, PL20MA, SI10SI, or HR10MA.

Query parameters

client_id string Required

Client identifier

Responses

200

Category tree
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes array[object]
  
  title string
  
  categoryVisible boolean
  
  items array[object]
  
  Hide items attributes Show items attributes array[object]
  
  title string
  
  categoryVisible boolean
  
  items array[object]
  
  Hide items attributes Show items attributes array[object]
  
  title string
  
  categoryVisible boolean
  
  items array[object]
  
  Hide items attributes Show items attributes array[object]
  
  menuItemId integer
  
  title string
  
  categoryVisible boolean
  
  sapCategories array[object]
  
  Hide sapCategories attributes Show sapCategories attributes array[object]
  
  productTypeId string
  
  operator string
  
  menuConstraints array[object]
  
  Hide menuConstraints attributes Show menuConstraints attributes array[object]
  
  paramId string
  
  operator string
  
  value1 string
  
  value2 string
  
  class number
  
  segment string
  
  isPhe boolean
  
  Determines whether electronic waste recycling fee is mandatory for this category (WEEE fee)
  
  fulltextQuery string
  
  Query with keywords that must / must not appear in the short and long product description
- result object
  
  Hide result attributes Show result attributes object
  
  code integer(int)
  
  status string

GET /categories/tree/{countryId}

curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/categories/tree/CZ10MA?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"

Response examples (200)

{
  "data": [
    {
      "title": "MALL",
      "categoryVisible": true,
      "items": [
        {
          "title": "Bilé zboží",
          "categoryVisible": true,
          "items": [
            {
              "title": "Cestovní chlazení",
              "categoryVisible": true,
              "items": [
                {
                  "menuItemId": 15558431,
                  "title": "Autochladničky",
                  "categoryVisible": true,
                  "sapCategories": [
                    {
                      "productTypeId": "WA039",
                      "operator": "AND",
                      "menuConstraints": [
                        {
                          "paramId": "ELECTRIC",
                          "operator": "=",
                          "value1": "Ano",
                          "value2": "string",
                          "class": 6.0
                        }
                      ],
                      "segment": "EB"
                    }
                  ],
                  "isPhe": false,
                  "fulltextQuery": "+(\"carrot\", \"cucumber\") -(\"apple\", \"pear\")"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  }
}