Create new

Create a new category in the material categories tree

Url:

Text

api/merchantMaterialCategory

Method POST

Body:

JSON

{
  "public": 1,
  "en_name": "category1\\subcategory1",
  "ru_name": "тест",
  "name": "en_name",
  "icon": "iVBORw0KGgoAAAANSUhEUgAAAEcAAAAtCAYAAAD833YjAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTM4IDc5LjE1OTgyNCwgMjAxNi8wOS8xNC0wMTowOTowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTcgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjVDMUZERjc5RjY5MjExRUJBNjhDRjZCMTUyRkMwNDkwIiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjVDMUZERjdBRjY5MjExRUJBNjhDRjZCMTUyRkMwNDkwIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6NUMxRkRGNzdGNjkyMTFFQkE2OENGNkIxNTJGQzA0OTAiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6NUMxRkRGNzhGNjkyMTFFQkE2OENGNkIxNTJGQzA0OTAiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz7w8/j8AAAFvElEQVR42uxaz48URRT+XlXPDPsLBpbFVYy7sioEBRWJoJgoJCZejD/jgQMhMV6MiScvnvTghYOY+Ad4MfHshRh/YgwKFw0GRXYjLrCBJSDusjvD7sxsPau6qqere2c3uOmBGTOdnXRNVfXbrq/e9733uoeYGZ2j8SE6EHTAuf3gENGSn48O0MHyV4MlnHnrheXmLfc5fID2Tx/ZUMLYm/uXm9d2nqMEdnbJfwrgqw+v1EaV8UhPcK2A2t/bb8U9B80w+st7KI5swdN9AxiABGEBOPItNhPrhirv4KN44z8btTYekqQALm+r2xBg5HvOo3b3T/TUmZlMmZBltDIu/fHr2PPcTnw+MoIiSW+Q3UcYZ1Ur+weNbBga5dYAvdsmULjvZdr6yc9ZrSlTzzm0H/fv2oov7x1G96+ngUtX9RLcfXatAp55HBg/Tzj958rsF/LA3l3AxEWBU2MWHDKOk5/CYw/+MFQcEV/z2bef0N1nWg6cO9bhw53bqXB5kjEzBazOxWPjl/WmUw6y+x4U8ytD568rml1avETvJm1jNNYiQ7nvgVe6flxdWPXAB7rr1ZYT5IF+7KOu9Zi8KiFSQaNXe843x6qYunh2xfbX9gDfHVeYnhhL9Oc0fft7gdHxKlA6vaclBTmfRwFBP6qVaaug3rG+z55nZ1auB8Vue56eXmzDADRfNZo0N9DCoZzwfzmyD+U6XN813AM1X7mlC5mdtaLf2uDMjmJj/23aam51cGQeJ04S5qryJu+WvHlLtZean0RmeMMchta2Mjjdm7Brt1ZG1sm+ydBMIsKeELFNPcMx9iUq7HOr5/iaqFZyl8Rf4tQzFOmZKo/9cRFDrV2Vu51ls3hzdotNrD+96ewWyc4pwgrSZnixWfYApkX9nH0kaFLhSRaE+k67hiBezAiNTDjsXIMiINPgeWcfEG5eeBRNlkf2FmK/Ud277BhTkj6JjIDIgedT1MObnGVmImT+SLMpVTmkqEBJc8/sPMZ6BEcKFH0PqcfeVpGTHLbbRrY4i+rM9MOawPFQmT8WWW92c8ARQTl8lKAa+KdKVdUK8eIjymhHqIuTDEFhSN3n21MevUytIkNw+toDHFM/yAaP5WSqEUV82VCorZdFUc2fI1UCdRYLsj3AyWlwFCn/qZHdXkctisIWJ8uNevh243WNcukAORoxeTYicGr5NtEceUNjUU0VWpwMZQxPYCkWZ14u4eN4bt227ZNBrT3AEcENkKrEkDDZiLMIJo6Voy7aMaRM5MXveDyKYl4fk2gTcIKgpBWzEtPGnc1uCxeB0pkz1fUlSb0E1eDZcWSL8KVAtQc4ZGgl5pemHVz54FcBKbBuPt8Mr2OZfcrWLM/RoZzn4mzNoaB0W3iIKE03IaLdp2TNFI1rOvrXRX31OYZa2mmEbBNwpAFH3Qi1Jgq3xulzTifCKKzbcajnZDXuPEi6+bJBKqCUzZdCL5SkSIg2EWRNKynLjfObJXIapJJBg5aw77zqZIv0KkwXXAmiQv1hFjJoH3ByopwqDRq8rvISOWKjqrZsIK+sMP1wWXKjalB4D5LaQ3NESQNUCqmjvCxZ1j2AQ+1ItxNleHSdAzBtK3XoOF5oaXBYWf5rn59DQOVw4Qvp6OI8JHBnCfuiQqbca8EDNGrnkXyp4Y3N16jHPvlQrQlOqYxJqNKdUMV+yPKlUJCF5y0xF5x4hAUm27swbYm6qASewATe/IDi64wdsRDaPvf75IbNRXP5tVMtCc6FK/h0avLcO8W+iedxae4Ypo6eRGWR72R76GzqxG/Y0Sfw7MZHDb/Of5FZupblDwkOv0br1g7i+Et7sWlN/xq9wdcXpS6ZH+ZHFzX7b8rXMdqbw5N4kadaDhwTZA4dxGAOeHdoEPt6urGFmvyOT9uvqRrGKxV8NpDD4d3v43pWa6LODyaXyUg6EHTA6YDTAacDTgecDjjtfPwrwADHflhkC1NTTgAAAABJRU5ErkJggg==",
  "tag_list": "asd,dsa,aaa"
}

Fields:
name - this field has value with main language field name ( en_name for english main language )
en_name - category name written in the main language for the website.
In this case, is English (en_name), but it could be any other language (i.e. Ukrainian - ua_name).
the field contains the name of the category with a path for the needed category.
For example: you have a category tree like this

• category1
  -- subcategory1
  -- subcategory2

in this example will be created subcategory1 category with parent category1

public - value "1" means that this category will become visible to all users of the room planner immediately after upload. This field could be empty. In case when "public" field remains empty - category will be visible only for Admin after uploaded.

icon - link to the icon of the category or base64 encoded image

tag_list - list of the tags for category (we don't use it for now, but it will be used for advanced product search later)

en_name / ua_name / de_name ... - category names in other languages (optional fields, used in case if site supports several languages)

We support these languages for now:
en_name - English
ua_name - Ukrainian
ru_name - Russian
de_name - German (Deutch)
pl_name - Polish

private_category - set category mode for PRO features
allowed values:
1 - MATERIAL
2 - MODEL
3 - POSTER
4 - CARPET
5 - FLOOR_MATERIAL
6 - COLOR_PICKER
7 - MODEL_MATERIAL
examples on
https://www.youtube.com/watch?v=9s9q8hqWuDM
https://www.youtube.com/watch?v=FLhd405cQa4
https://www.youtube.com/watch?v=lRUkldqW_tE
https://www.youtube.com/watch?v=oJXEmHoZOQ8
https://www.youtube.com/watch?v=kthGMfI5Uh0

headers

x-token: 202cb962ac59075b964b07152d234b70

Response:

Text

{
    "status": "ok",
    "data": {
        "id": 8666
    }
}

As result new category id obtained