Получить номенклатуру

HTTP-сервис materials, метод GetMaterials. Возвращает элементы справочника Номенклатура (Справочник.Номенклатура) в виде дерева.

В выборку попадают только элементы (не группы), без пометки на удаление. Родительские группы в дереве создаются автоматически по цепочке Родитель.

Endpoint

GET /main/hs/materials/get

Параметры запроса

Все параметры опциональны. Читаются из query string (ПараметрыЗапроса) или из URL-шаблона (ПараметрыURL).

ПараметрТипОписание
codestringФильтр по коду. Поиск ПОДОБНО — подстрока в коде
namestringФильтр по наименованию. Поиск ПОДОБНО
groupstringФильтр по наименованию непосредственного родителя (группы в каталоге). Поиск ПОДОБНО
typestringФильтр по виду номенклатуры. Поиск ПОДОБНО
ngroupstringФильтр по номенклатурной группе. Поиск ПОДОБНО
articlestringФильтр по артикулу. Поиск ПОДОБНО
supplierstringФильтр по основному поставщику. Поиск ПОДОБНО
servicebooleanФильтр по признаку «Услуга». Истина: 1, true, да. Любое другое значение при заданном параметре — false

Фильтры можно комбинировать. Без параметров возвращается вся номенклатура (с учётом прав публикации 1С).

Примеры запросов

GET /main/hs/materials/get
GET /main/hs/materials/get?name=бетон
GET /main/hs/materials/get?group=Материалы&service=false
GET /main/hs/materials/get?type=Товар&article=BRK
GET /main/hs/materials/get?supplier=ООО&ngroup=Строй
GET /main/hs/materials/get?code=ДК-00001008

Формат ответа

data — массив корневых узлов дерева. Каждый узел — либо группа, либо элемент номенклатуры.

{
  "data": [
    {
      "Код": "SKU-0100",
      "Наименование": "Материалы",
      "ЭтоГруппа": true,
      "Дети": [
        {
          "Код": "ДК-00001008",
          "Наименование": "Смесь DEMO-M300",
          "Артикул": "BRK-M300",
          "ЭтоГруппа": false,
          "Услуга": false,
          "ЕдиницаИзмерения": "м3",
          "ВидНоменклатуры": "Товар",
          "НоменклатурнаяГруппа": "Стройматериалы",
          "ОсновнойПоставщик": "ООО «ПримерПоставка»"
        }
      ]
    }
  ],
  "errors": []
}

Поля узла дерева

Группа (ЭтоГруппа: true)

ПолеТипОписание
КодstringКод группы
НаименованиеstringНаименование группы
ЭтоГруппаbooleanВсегда true
ДетиarrayВложенные группы и элементы

Элемент номенклатуры (ЭтоГруппа: false)

ПолеТипИсточник в 1СОписание
КодstringКодКод номенклатуры
НаименованиеstringНаименованиеНаименование
АртикулstringАртикулАртикул или пустая строка
ЭтоГруппаbooleanВсегда false
УслугаbooleanУслугаПризнак услуги
ЕдиницаИзмеренияstringБазоваяЕдиницаИзмеренияЕдиница измерения
ВидНоменклатурыstringВидНоменклатурыВид номенклатуры
НоменклатурнаяГруппаstringНоменклатурнаяГруппаНоменклатурная группа
ОсновнойПоставщикstringОсновнойПоставщикОсновной поставщик или пустая строка

HTTP-коды

КодКогдаТело
200Запрос обработан{ "data": [...], "errors": [...] }
500Непредвиденная ошибка на стороне 1С{ "error": "текст ошибки" }

Примечания

  • Ответ — дерево, а не плоский список. Обходите рекурсивно через поле Дети.
  • Группы в дереве — это родительские папки каталога, собранные по цепочке Родитель для найденных элементов.
  • Параметр group фильтрует по имени ближайшего родителя, а не по всей иерархии.
  • Элементы в запросе сортируются по наименованию.
  • Ответ содержит заголовок Access-Control-Allow-Origin: *.