Skip to main content

Справочники

POST {host}/dicts/

ЗАПРОС

Заголовок
{
    "Accept-Language": "ru", // ○ язык ответов: ru или en (ru по-умолчанию)
    "Authorization": "Bearer {token}" // ● JWT токен авторизации
}
Структура
{
    "names": string[] // ● Список имен справочников для получения
}

💡 Список доступных значений для имен справочников см. в разделе Доступные значения

Пример
{
    "names": ["USER_ROLE", "PRODUCT_GROUP"]
}

ОТВЕТ

Структура
{
    "dicts": {
        "string": {
            "title": string, // Название справочника
            "list": {
                "string": {
                    // Атрибуты в зависимости от справочника
                }
            }
        }
    }
}
Дополнительные поля
Атрибут Тип Назначение
chz string Код позиции справочника в системе ЧЗ
verbose string Полное наименование позиции справочника
verbose_short string Краткое наименование позиции справочника
product_groups list of strings Коды товарных групп из справочника PRODUCT_GROUP, для которых доступна позиция справочника
hidden boolean Скрытая позиция (не отображается в интерфейсе)
chz_index integer Порядковый номер позиции в системе ЧЗ
auto_utilisation boolean Автоматическое нанесение кодов
weight_in_code boolean Вес указан в коде маркировки
volume_in_code boolean Объем указан в коде маркировки
serial_in_code boolean Серийный номер указан в коде маркировки
aggregation boolean Доступна агрегация
utilisation boolean Доступно нанесение
default string Значение по умолчанию
note string Примечание к атрибуту
label string Метка для отображения в интерфейсе
type string Тип данных атрибута
required boolean Обязательность заполнения
located string Расположение атрибута (order/item)

💡 Набор полей зависит от конкретного справочника. Не все поля присутствуют во всех справочниках.

Пример
{
    "dicts": {
        "USER_ROLE": {
            "title": "Роль пользователя",
            "list": {
                "SUPERVISOR": {
                    "verbose": "Супервайзор",
                    "hidden": true
                },
                "SUPERUSER": {
                    "verbose": "Администратор"
                },
                "USER": {
                    "verbose": "Пользователь"
                },
                "SERVICE": {
                    "verbose": "Служебный аккаунт"
                },
                "AUTOSIGNER": {
                    "verbose": "Автоподписант"
                }
            }
        },
        "PRODUCT_GROUP": {
            "title": "Товарная группа",
            "list": {
                "lp": {
                    "chz": "lp",
                    "chz_index": 1,
                    "verbose": "Предметы одежды, белье постельное, столовое, туалетное и кухонное",
                    "verbose_short": "Легпром",
                    "auto_utilisation": true
                },
                "shoes": {
                    "chz": "shoes",
                    "chz_index": 2,
                    "verbose": "Обувные товары",
                    "verbose_short": "Обувь",
                    "auto_utilisation": true
                }
            }
        }
    }
}

ОШИБКИ

💡 Метод также может возвращать глобальные ошибки.

ДОСТУПНЫЕ ЗНАЧЕНИЯ

Имена справочников
Значение Описание
USER_ROLE Роли пользователей
COMPANY_ROLE Роли компаний
COMPANY_ORG_FORM Организационно-правовые формы
POA_PERMISSION Разрешения доверенностей
RELEASE_METHOD_TYPE Способы выпуска товаров в оборот
PRODUCT_GROUP Товарные группы
CREATE_METHOD_TYPE Способы изготовления кодов
TEMPLATE_ID Шаблоны кодов
CODE_MASK Маски кодов
ORDER_ITEM_FLAG Состояния товарных позиций
CIS_TYPE Типы упаковки
CODE_LENGTH Размеры кодов
SERIAL_NUMBER_TYPE Способы формирования серийных номеров
PAYMENT_TYPE Способы оплаты
FREE_CODE Бесплатные КМ
ATTRIBUTES Атрибуты
PRODUCTION_ORDER_TYPE Типы производственных заказов
USED_IN_PRODUCTION Использование КМ на производстве
ORDER_FLAG Состояния заказов
POA_STATE Состояния доверенностей
ORDER_ITEM_ATTRIBUTES_BY_PRODUCT_GROUP Атрибуты товарных позиций по товарным группам
ORDER_ITEM_ATTRIBUTES_BY_RELEASE_METHOD_TYPE Атрибуты товарных позиций по способам выпуска
VALIDATION_ATTRIBUTES_BY_PRODUCT_GROUP Атрибуты валидации по товарным группам
UTILISATION_ATTRIBUTES_BY_PRODUCT_GROUP Атрибуты нанесения по товарным группам
AGGREGATION_ATTRIBUTES_BY_PRODUCT_GROUP Атрибуты агрегации по товарным группам

ПРИМЕЧАНИЯ

  1. Метод требует аутентификации пользователя через JWT токен
  2. Возвращает только те справочники, которые были запрошены в поле names
  3. Значения справочников переводятся на язык, указанный в заголовке Accept-Language
Back to top