Методы on База знаний DataMobile

arts/attrs/names

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка наименований атрибутов товаров

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/attrs/names?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
attr_1	string	Наименование атрибута #1
attr_2	string	Наименование атрибута #2
attr_3	string	Наименование атрибута #3
attr_4	string	Наименование атрибута #4
attr_5	string	Наименование атрибута #5
attr_6	string	Наименование атрибута #6
attr_7	string	Наименование атрибута #7
attr_8	string	Наименование атрибута #8
attr_9	string	Наименование атрибута #9
attr_10	string	Наименование атрибута #10

Пример ответа


{
 "attr_1": "Артикул",
 "attr_2": "Код",
 "attr_3": "ТоварнаяКатегория",
 "attr_4": "Атрибут 4",
 "attr_5": "Атрибут 5",
 "attr_6": "Атрибут 6",
 "attr_7": "Атрибут 7",
 "attr_8": "Атрибут 8",
 "attr_9": "Атрибут 9",
 "attr_10": "Атрибут 10"
}

arts/barcodes/generate

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Генерация значения ШК

Где используется

На форме создания ШК

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
params	string	Параметры генерации
barcode	string	Штрихкод товара
unit_coef	float	Коэффициент упаковки
unit_id	string	Идентификатор упаковки
art_id	string	Идентификатор товара

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/barcodes/generate?device_id=1&username=Администратор


{ 
 "params": { 
 "3": "", 
 "2": "", 
 "1": "" 
 }, 
 "barcode": "", 
 "unit_id": "bd72d926-55bc-11d9-848a-00112f43529a", 
 "art_id": "8U-e21f3a34-ef1f-11e0-af98-0015e9b8c48d00000000-0000-0000-0000-000000000000" 
}

Ответ

Тело

Наименование	Тип	Описание
barcode обязательное	object	Объект ШК товара

Пример ответа

Возвращается объект barcode

arts/marks

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника кодов маркировки

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/marks?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
art_mark *обязательное	object	Объект элемента справочника кодов маркировки

Пример ответа

Возвращаются объекты art_mark


[
 {
 "art_id": "8U-cd835b0d-c9fe-11eb-b08f-00a0c600004800000000-0000-0000-0000-000000000000",
 "box": "00410020030000000022",
 "coef": 1,
 "mark": "010460472700034121ja(S3pt'7.002",
 "pallet": "00410020030000000053"
 },
]

Полезные статьи

art_mark

arts/parts

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника товаров порциями
Загрузка товаров документа порциями

Примечание

За порционную загрузку отвечает параметр в ПО: Настройки / Справочники / Порционная загрузка.

Где используется

В операции “Загрузка данных”
На форме списка документов
При открытии документов

Запрос

Параметры

Наименование	Тип	Описание
doc_id	string	Идентификатор документа
username	string	Имя пользователя
device_id	string	Идентификатор устройства
part	int	Номер порции данных

Пример запроса #1

Загрузка справочника товаров


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/parts?device_id=1&username=Администратор&part=1

Пример запроса #2

Загрузка товаров документа

arts/prices/names

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка наименований дополнительных видов цен

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/arts/prices/names?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
price_1	string	Наименование доп. цены #1
price_2	string	Наименование доп. цены #2
price_3	string	Наименование доп. цены #3

arts/rest

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение остатка товара

Где используется

В справочнике товаров

Запрос

Параметры

Наименование	Тип	Описание
art_id	string	Идентификатор товара
username	string	Имя пользователя
device_id	string	Идентификатор устройства
art_sn	string	Серия товара
cell_barcode	string	ШК ячейки
doc_id	string	Идентификатор документа

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/rest?art_sn=1&cell_barcode=1&doc_id=1&art_id=1&1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
data *обязательное	float	Остаток товара

Пример ответа


{
 "data": 22
}

arts/scan

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Идентификация и получение объекта товара при сканировании ШК
Идентификация и получение объекта товара при считывании RFID-метки

Где используется

В документах
В справочнике товаров
В операции “Печать этикеток”

Запрос

Параметры

Наименование	Тип	Описание
barcode	string	Штрихкод товара
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание	Значение
operation_type	int	Идентификатор строки	0 – подбор 1 – размещение
barcode	string	ШК товара
doc_id	string	Идентификатор документа
cell_barcode	string	ШК ячейки
gs1	string	ШК GS1
kiz	object	Объект кода маркировки

Пример запроса #1

Идентификация и получение объекта товара при сканировании ШК в обычных документах
Идентификация и получение объекта товара при считывании RFID-метки в обычных документах

arts/sn

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение cписка серий по товару

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
art_id	string	Идентификатор товара
username	string	Имя пользователя
device_id	string	Идентификатор устройства
cell_barcode	string	Штрихкод ячейки
doc_id	string	Идентификатор документа

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/sn?cell_barcode=1&art_id=1&doc_id=1&device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
sn *обязательное	array	Массив серий товара

Пример ответа

Возвращаются значения реквизитов серии в соответствии с sn_type товара


[
 [
 "12345",
 "04.02.22",
 "04.02.23"
 ],
]

arts/sn_types

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника типов серий

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/sn_types?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
sn_type *обязательное	object array	Массив объектов типов серии

Пример ответа

Возвращаются объекты sn_type


[
 {
 "id": "11",
 "name": "Дата производства",
 "ai": 11,
 "date_type": 1,
 "mask": "dd.mm.yy"
 "is_need_check_task": true,
 "is_need_check_unique": false
 },
]

Полезные статьи

sn_type

arts/sn/recommendation

Mon, 01 Jan 0001 00:00:00 +0000

Метод возвращает рекомендованные значения для одного типа серии: приложение вызывает его при открытии формы ввода каждого типа и передаёт значения, введённые для строки ранее. Список серий целиком, всеми типами сразу, отдаёт arts/sn.

Метод

Свойство	Значение
Тип	POST
Путь	`/api/arts/sn/recommendation`
Доступен с версии	DataMobile 3.11.5

Условия вызова

Приложение вызывает метод в документах при одновременном соблюдении условий:

товар серийный — требует ввода серии;
в настройках шаблона опция Поиск серии установлена в значение Сервер;
в настройках шаблона включена настройка Онлайн-рекомендация серий;
в настройках шаблона включена настройка Рекомендация отдельных типов серий — поднастройка предыдущей.

Настройка Рекомендация отдельных типов серий приходит на устройство с объектом template в поле is_get_sn_list_by_type_from_server. Когда она выключена, метод не вызывается: рекомендации приходят сразу по всем типам серий методом arts/sn.

arts/sn/search

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

POST

Назначение

Получение информации о серии по ШК

Где используется

В документах, при при одновременном соблюдении следующих условий:

Отсканирован штрихкод в формате GS1
Товар серийный (т.е. требует ввода серии)
В настройках шаблона включена опция Поиск серии: Сервер
В настройках ПО заполнено значение AI-код для ШК серии
В отсканированном GS1-коде присутствует идентификатор (AI), указанный в настройке AI-код для ШК серии

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело

Наименование	Тип	Описание	Значение
doc_id	string	Идентификатор документа
operation_type	int	Идентификатор строки	0 – подбор 1 – размещение
art_id	string	Идентификатор товара
pack	string	Штрихкод групповой упаковки
cell_barcode	string	Штрихкод ячейки
sn_barcodes	array	Массив штрихкодов серий
ai_code	float	AI код серии
value	string	Значение серии

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


http://192.168.1.1/DM/hs/DataMobileExch/api/arts/sn/search?device_id=1&username=Администратор


{
 "doc_id": "doc_out_id_1",
 "operation_type": 0,
 "art_id": "...",
 "pack": "...",
 "cell_barcode": "...",
 "sn_barcodes": [
 {
 "ai_code": ...,
 "value" : "..."
 },
 {
 "ai_code": ...,
 "value" : "..."
 },
 {
 "ai_code": ...,
 "value" : "..."
 }
 ]
}

Ответ

Тело

Наименование	Тип	Описание
sn_type_id	float	AI код серии
value	string	Значение серии

Пример ответа


[ 
 [
 {
 "sn_type_id": ..., 
 "value" : "..."
 },
 {
 "sn_type_id": ...,
 "value" : "..."
 },
 ],

 [
 {
 "sn_type_id": ..., 
 "value" : "..."
 },
 {
 "sn_type_id": ...,
 "value" : "..."
 },
 ]
]

cells

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Загрузка справочника ячеек
Получение списка ячеек по товару

Где используется

В операции “Загрузка данных”
В документах

Запрос

Параметры

Наименование	Тип	Описание	Значение
full_barcode	string	Полный ШК товара
gs1	string	Значение сканируемого ШК товара с разбитием по тегам ГС1
barcode	string	Сканируемый ШК товара
pack	string	Сканируемая групповая упаковка товара
art_sn	string	Серия товара
art_id	string	Идентификатор товара
pack	string	Штрихкод групповой упаковки
doc_id	string	Идентификатор документа
operation_type	int	Тип операции	0 – подбор 1 – размещение
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Пример запроса #1

Загрузка справочника ячеек

cells/replace

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Обновление задания по ячейке

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание	Значение
art_sn	string	Серия товара	-
art_id	string	Идентификатор товара	-
pack	string	Штрихкод групповой упаковки	-
doc_id	string	Идентификатор документа	-
operation_type	int	Тип операции	0 – подбор 1 – размещение
username	string	Имя пользователя	-
device_id	string	Идентификатор устройства	-

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


http://192.168.1.1/DM/hs/DataMobileExch/api/cells/replace?art_sn=1&art_id=1&doc_id=1&operation_type=0&username=Волков Андрей Иванович&device_id=1&barcode=9999&pack=1234

Ответ

Тело

Наименование	Тип	Описание
cell *обязательное	object array	Массив объектов ячейки
limit_qty	float	Остаток товара в ячейке

Пример ответа


[
 {
 "cell": {
 "name": "2-2-2-2-2",
 "barcode": "87654321"
 },
 "limit_qty": 2
 },
]

Полезные статьи

cell

cell/scan

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

POST

Назначение

Идентификация и получение объекта ячейки при сканировании ШК

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание	Значение
art_id	string	Идентификатор товара	-
art_barcode	string	ШК товара	-
cell_barcode	string	ШК ячейки	-
doc_id	string	Идентификатор документа	-
operation_type	int	Тип операции	0 – подбор 1 – размещение

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


http://192.168.1.1/DM/hs/DataMobileExch/api/cells/scan?username=Волков Андрей Иванович&device_id=1


{
 "art_id": "",
 "art_barcode": "",
 "cell_barcode": "18164020380380801208543584540311631276",
 "doc_id": "d82-9065ec3b-84c7-11ec-b0a5-50465db6e599",
 "operation_type": 0
}

Ответ

Тело

Наименование	Тип	Описание
cell *обязательное	object	Объект ячейки
limit_qty	float	Остаток товара в ячейке
task_qty	float	Количество товара по заданию в ячейке

Пример ответа


{
 "cell": {
 "name": "1-1-1-1-1(описание)",
 "barcode": "18164020380380801208543584540311631276"
 },
 "limit_qty": 0,
 "task_qty": 0
}

Полезные статьи

cell

cell/content

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Получение списка товаров по ячейке

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
cell_barcode	string	ШК ячейки
username	string	Имя пользователя
device_id	string	Идентификатор устройства
doc_id	string	Идентификатор документа

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


http://192.168.1.1/str/hs/DataMobileExch/api/cells/content?cell_barcode=1&username=Волков Андрей Иванович&device_id=1&doc_id=1

Ответ

Тело

Наименование	Тип	Описание
art обязательное	object	Объект товара
barcode обязательное	object	Объект ШК товара
sn	array	Список значений типов используемых реквизитов серий Объекта товара
limit_qty	float	Остаток товара
qty обязательное	float	Количество товара в ячейке
unit_qty	float	Количество товара в ячейке (упаковки)

Пример ответа


[ 
 {
 "art": {
 "id": "8U-4e7d0975-d562-11ee-b0d3-50465db6e59900000000-0000-0000-0000-000000000000",
 "name": "БАД к пище",
 "price": 0,
 "is_use_sn": true,
 "measure_type": 0,
 "mark_type": 2,
 "attributes": {
 "attr_1": "БАДы",
 "attr_2": "",
 "attr_3": "",
 "attr_4": "",
 "attr_5": "",
 "attr_6": "",
 "attr_7": "0",
 "attr_8": "0",
 "attr_9": "",
 "attr_10": ""
 },
 "parent_id": "",
 "type": 0,
 "kit_parts": [],
 "additional_prices": {
 "price_1": 0,
 "price_2": 0,
 "price_3": 0
 },
 "sn_types": [
 "10",
 "11",
 "17"
 ]
 },
 "barcode": {
 "unit_name": "шт",
 "unit_id": "9cf6755e-d562-11ee-b0d3-50465db6e599",
 "unit_coef": 1,
 "use_sn_mode": 2
 },
 "sn": "[\"2312181\",\"18.12.23\",\"17.12.24\"]",
 "limit_qty": 150,
 "qty": 150,
 "unit_qty": 150
 } 
]

см. art

clients

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Загрузка справочника контрагентов

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/clients?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
client *обязательное	object array	Массив объектов контрагентов

Пример ответа

Возвращаются объекты client


[
 {
 "name": "1С-СОФТ ООО",
 "id": "8k-5e5a724c-6896-11e8-8780-b06ebf2faaf6",
 "barcode": "7730643014"
 },
]

Полезные статьи

client

clients/parts

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Загрузка справочника клиентов (контрагентов) порциями

Примечание

За порционную загрузку отвечает параметр в ПО: Настройки / Справочники / Порционная загрузка.

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства
part	int	Номер порции данных

Пример запроса #1

Загрузка справочника товаров


http://192.168.1.1/DM/hs/DataMobileExch/api/clients/parts?device_id=1&username=Администратор&part=1

Ответ

Тело

Наименование	Тип	Описание
is_finished обязательное	boolean	Признак завершающей порции данных
data обязательное	object array	Массив объектов товаров

Пример ответа

Возвращаются объекты art

crpt/key

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Получение ключа для доступа к True API (“Честный Знак”)

Где используется

В документе
В операции “Проверка КМ”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/crpt/key?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
data *обязательное	string	Ключ API

Пример ответа


{
 "data": "key_value"
}

device/data

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

GET

Назначение

Проверка необходимости загрузки основных справочников

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/device/data?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
is_need_clear_templates	boolean	Признак очистки справочника шаблонов
is_need_load_templates	boolean	Признак загрузки справочника шаблонов
is_need_clear_cells	boolean	Признак очистки справочника ячеек
is_need_load_cells	boolean	Признак загрузки справочника ячеек
is_need_clear_docs	boolean	Признак очистки справочника документов
is_need_load_docs	boolean	Признак загрузки справочника документов
is_need_clear_users	boolean	Признак очистки справочника пользователей
is_need_load_users	boolean	Признак загрузки справочника пользователей
is_need_clear_arts	boolean	Признак очистки справочника товаров
is_need_load_arts	boolean	Признак загрузки справочника товаров
is_need_clear_clients	boolean	Признак очистки справочника контрагентов
is_need_load_clients	boolean	Признак загрузки справочника контрагентов
is_need_clear_units	boolean	Признак очистки справочника единиц измерения
is_need_load_units	boolean	Признак загрузки справочника единиц измерения
is_need_clear_egais_arts	boolean	Признак очистки справочника товаров ЕГАИС
is_need_load_egais_arts	boolean	Признак загрузки справочника товаров ЕГАИС
is_need_clear_warehouses	boolean	Признак очистки справочника складов
is_need_load_warehouses	boolean	Признак загрузки справочника складов
is_need_clear_egais_marks	boolean	Признак очистки справочника акцизных марок
is_need_load_egais_marks	boolean	Признак загрузки справочника акцизных марок
is_need_clear_art_marks	boolean	Признак очистки справочника кодов маркировки
is_need_load_art_marks	boolean	Признак загрузки справочника кодов маркировки
is_need_clear_steps	boolean	Признак очистки справочника дополнительных форм
is_need_load_steps	boolean	Признак загрузки справочника дополнительных форм
is_need_clear_barcode_templates	boolean	Признак очистки шаблонов штрихкодов
is_need_load_barcode_templates	boolean	Признак загрузки шаблонов штрихкодов
is_need_clear_sn_types	boolean	Признак очистки справочника типов серийных номеров
is_need_load_sn_types	boolean	Признак загрузки справочника типов серийных номеров
is_need_clear_roles	boolean	Признак очистки справочника ролей
is_need_load_roles	boolean	Признак загрузки справочника ролей

Пример ответа


{
 "is_need_clear_templates": true,
 "is_need_load_templates": true,
 "is_need_clear_cells": true,
 "is_need_load_cells": true,
 "is_need_clear_docs": true,
 "is_need_load_docs": true,
 "is_need_clear_users": true,
 "is_need_load_users": true,
 "is_need_clear_arts": true,
 "is_need_load_arts": true,
 "is_need_clear_clients": true,
 "is_need_load_clients": true,
 "is_need_clear_units": true,
 "is_need_load_units": true,
 "is_need_clear_egais_arts": false,
 "is_need_load_egais_arts": false,
 "is_need_clear_warehouses": true,
 "is_need_load_warehouses": true,
 "is_need_clear_egais_marks": false,
 "is_need_load_egais_marks": false,
 "is_need_clear_art_marks": false,
 "is_need_load_art_marks": false,
 "is_need_clear_steps": false,
 "is_need_load_steps": false,
 "is_need_clear_barcode_templates": false,
 "is_need_load_barcode_templates": false,
 "is_need_clear_sn_types": true,
 "is_need_load_sn_types": true,
 "is_need_clear_roles": true,
 "is_need_load_roles": true
}

device/login

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

POST

Назначение

Авторизация пользователя

Где используется

В форме авторизации

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя
device_name	string	Наименование устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/device/login?device_id=1&username=Администратор&device_name=TSD1

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус авторизации
device_name	string	Наименование устройства
accounting_system	object	Информация об учётной системе
clear_required	object	Признаки очистки справочников на устройстве, см. clear_required

Пример ответа


{
 "is_success": true,
 "device_name": "PM75",
 "accounting_system": {
 "arm_version": "04.07.2024"
 },
 "clear_required": {
 "is_need_clear_docs": true
 }
}

device/logout

Wed, 16 Sep 2026 08:53:13 +0200

Тип метода

POST

Назначение

Выход из приложения на форму авторизации

Где используется

На владке “Прочее”

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

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


http://192.168.1.1/DM/hs/DataMobileExch/api/device/logout?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус авторизации

Пример ответа


{
 "is_success": true 
}

docs/client

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Изменение контрагента в документе

Где используется

В документе

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело

Наименование	Тип	Описание
client_id	string	Идентификатор контрагента
doc_id	string	Идентификатор документа

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/client?device_id=1&username=Администратор


{
 "client_id": "8k-2f5f7e5c-f873-11df-aecd-0015e9b8c48d",
 "doc_id": "d82-b322e1a7-859b-11ec-aa42-18c04d302a2e"
}

Ответ

Тело

Наименование	Тип	Описание
is_success *обязательное	boolean	Статус операции

Пример ответа


{
 "is_success": true
}

docs/comment

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Изменение комментария документа

Где используется

В документе

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело

Наименование	Тип	Описание
comment	string	Значение комментария
doc_id	string	Идентификатор документа

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/comment?device_id=1&username=Администратор


{
 "comment": "Hello, world!",
 "doc_id": "d82-b322e1a7-859b-11ec-aa42-18c04d302a2e"
}

Ответ

Тело

Наименование	Тип	Описание
is_success *обязательное	boolean	Статус операции

Пример ответа


{
 "is_success": true
}

docs/logs/verify

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Проверка строк перед записью

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание	Значения
doc_detail	object	Объект строки документа	-
doc_id	string	Идентификатор документа	-
operation_type	int	Тип операции	0 – подбор 1 – размещение

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

Запись строки с обычным товаром


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/logs?device_id=1&username=Администратор


{
 "detail": {
 "marking": {
 "raw_barcode": "",
 "tnvd": "",
 "raw_mrc": "",
 "decoded_mrc": "",
 "sn": "",
 "ean": "",
 "mark": "",
 "gtin": ""
 },
 "egais": {
 "blank_b": "",
 "blank_a": "",
 "bate_bottling": "",
 "mark": "",
 "alcocode": ""
 },
 "weight_task": 0,
 "limit_qty": 0,
 "qty": 1,
 "sn": "",
 "pack": "",
 "tare": {
 "name": "",
 "barcode": ""
 },
 "box_pack": "",
 "created_at": 1643969541,
 "price": 0,
 "pack_attributes": "",
 "changed_price": 0,
 "gs1_barcode": "",
 "data_matrix_barcode": "",
 "barcode": {
 "is_deleted": false,
 "use_sn_mode": 2,
 "unit_coef": 1,
 "unit_name": "",
 "value": ""
 },
 "date": "04.02.2022 13:12:21",
 "art": {
 "barcodes": [],
 "rest": 0,
 "sn_types": [],
 "measure_type": 0,
 "is_deleted": false,
 "is_use_sn": false,
 "price_discount": 0,
 "price": 0,
 "attributes": {
 "attr_10": "",
 "attr_9": "",
 "attr_8": "",
 "attr_6": "",
 "attr_5": "",
 "attr_4": "",
 "attr_3": "",
 "attr_2": "",
 "attr_7": "",
 "attr_1": ""
 },
 "name": "Harvest White",
 "mark_type": 0,
 "id": "8U-9936b201-c444-11eb-b08f-00a0c600004800000000-0000-0000-0000-000000000000"
 },
 "group_row_id": "",
 "row_id": 8,
 "cell": {
 "name": "",
 "barcode": "195171589514805721134711768197818530411"
 },
 "attributes": []
 },
 "operation_type": 0,
 "doc_id": "d82-b322e1a5-859b-11ec-aa42-18c04d302a2e"
}

Ответ

Тело

Наименование	Тип	Описание
is_need_confirm *обязательное	boolean	Статус подтверждения
title	string	Заголовок диалога
description	string	Текст сообщения

Пример ответа #1

подтверждение записи

docs/scan

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Получение объекта документа при сканировании ШК

Где используется

В списке шаблонов
В списке документов

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
barcode	string	ШК документа
template_id	string	Идентификатор шаблона

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/scan?device_id=1&username=Администратор

{
 "template_id": "",
 "barcode": "87295811161005633592152700077828210760"
}

Ответ

Тело

Наименование	Тип	Описание
doc *обязательное	object array	Массив объектов документов

Пример ответа

Возвращаются объекты doc


[
 {
 "id": "d82-f586018b-8589-11ec-aa42-18c04d302a2e",
 "number": "00-00000012",
 "date_timestamp": "1673864047",
 "comment": "",
 "barcode": "87295811161005633592152700077828210760",
 "is_deleted": false,
 "is_loaded": false,
 "is_parent": false,
 "is_finished": false,
 "parent_doc_id": "",
 "priority": 0,
 "inn": "",
 "template": {
 "id": 1,
 "name": "Заказ клиента",
 "roles": [
 "1",
 "2"
 ],
 "process_id": 3,
 "dest_template_id": null,
 "is_notify_getting_doc": false,
 "is_allow_create_on_device": true,
 "is_load_arts_with_doc": false,
 "is_load_rows_on_open_doc": false,
 "is_use_select_log_as_insert_task": false,
 "is_scan_art_again": false,
 "is_from_select_to_insert_art_by_art": false,
 "is_unload_completed_doc": false,
 "is_unload_completed_child_doc": false,
 "unload_incorrect_doc_action": 0,
 "unload_incorrect_doc_option": 0,
 "search_barcode_priority": 0,
 "is_use_second_warehouse": false,
 "is_disable_manual_change_client": false,
 "is_disable_manual_change_warehouse": false,
 "is_use_all_barcodes": true,
 "unique_barcode_mode": 0,
 "is_use_barcode_templates": false,
 "is_manual_apply_cell": false,
 "is_manual_apply_art": false,
 "pack_list_generate_mode": 0,
 "is_can_skip_pack": false,
 "required_pack_qty": 0, 
 "is_multi_sn_logic": false,
 "is_get_sn_list_from_server": false,
 "is_use_additional_forms": false,
 "is_group_selection_forms": false,
 "is_update_forms_from_server": false,
 "is_multi_doc": false,
 "multi_doc_timeout": 0,
 "is_play_multi_doc_sound": false,
 "new_art_action": 2,
 "is_delete_left_task_qty": false,
 "online_arts_catalog": 0,
 "is_deleted": false,
 "create_mode": 0,
 "is_warehouse_required": false,
 "is_client_required": false,
 "is_check_unit_task": false,
 "is_check_remaining_expiration_date": false,
 "is_load_doc_logs": false,
 "selective_check_pack_mode": 0,
 "select": {
 "is_use_operation": true,
 "art_scan_action": 2,
 "is_manual_quantity": true,
 "is_enter_to_commit": true,
 "is_send_row_to_server": true,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_tare_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_check_cell_by_task": false,
 "is_handle_whole_cell": false,
 "is_handle_whole_tare": false,
 "use_sn_mode": 1,
 "is_check_sn_by_task": false,
 "is_use_unique_sn": false,
 "is_require_enter_sn": false,
 "sn_data_type": 1,
 "sn_rules": {
 "mask": "yyyy/dd/mm",
 "is_expired_year": true
 },
 "use_pack_mode": 0,
 "is_check_pack_by_task": false,
 "print_label_mode": 0,
 "is_use_photo_fixation": false,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0
 },
 "insert": {
 "is_use_operation": true,
 "art_scan_action": 2,
 "is_manual_quantity": true,
 "is_enter_to_commit": true,
 "is_send_row_to_server": true,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_tare_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_check_cell_by_task": false,
 "is_handle_whole_cell": false,
 "is_handle_whole_tare": false,
 "use_sn_mode": 0,
 "is_check_sn_by_task": false,
 "is_use_unique_sn": false,
 "is_require_enter_sn": false,
 "sn_data_type": 0,
 "use_pack_mode": 0,
 "is_check_pack_by_task": false,
 "print_label_mode": 0,
 "is_use_photo_fixation": false,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0
 },
 "egais": {
 "is_egais_doc": false,
 "enter_data_matrix_mode": 0,
 "is_compare": false,
 "is_check_mark_on_server": false,
 "version": 0,
 "is_use_bottling_date": false,
 "enter_pdf417_barcode_mode": 0,
 "is_use_blank_a": false,
 "is_use_blank_b": false,
 "is_get_bottling_date_from_server": false
 },
 "marking": {
 "is_marking_doc": false,
 "check_task_mode": 0,
 "ean_scan_type": 0,
 "without_km_enter_type": 0,
 "is_ean_equals_gtin": false,
 "is_search_by_km": false,
 "is_only_mark_art": false,
 "check_km_owner_action": 0,
 "check_km_status_action": 0,
 "sn_source": 0,
 "allowed_statuses": [
 0,
 1,
 2,
 6
 ]
 }
 },
 "warehouse_1": {
 "id": "6f87e83f-722c-11df-b336-0011955cba6b",
 "name": "Центральный склад"
 },
 "forms": []
 },
]

Полезные статьи

doc

docs/state

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Возврат выгруженного документа в работу

Где используется

В списке выгруженных документов

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело

Наименование	Тип	Описание	Значение
state_id	int	Состояние документа	0 – в работе 1 – новый 2 – обновлен 3 – просмотрен 5 – завершен 495 – отложен «»- возврат документа в работу
doc_id	string	Идентификатор документа	-

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/state?device_id=1&username=Администратор


{
 "state_id": "1",
 "doc_id": "d82-f586018b-8589-11ec-aa42-18c04d302a2e"
}

Ответ

Тело

Наименование	Тип	Описание
is_success *обязательное	boolean	Статус операции

Пример ответа


{
 "is_success": true
}

docs/sync

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Загрузка шапок документов

Где используется

На форме списка документов

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
docs_ids	array	Массив идентификаторов документов в ПО

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/sync?username=Администратор&device_id=1


{
 "docs_ids": [
 "d82-1ca673b6-6872-11ec-8414-00a0c6000012",
 "d82-409f5c35-688e-11ec-8414-00a0c6000012",
 "d82-409f5c37-688e-11ec-8414-00a0c6000012",
 "d82-409f5c3a-688e-11ec-8414-00a0c6000012"
 ]
}

Ответ

Тело

Наименование	Тип	Описание
doc обязательное	object array	Массив объектов документа

Пример ответа

Возвращаются объекты doc


[
 {
 "id": "d82-f586018b-8589-11ec-aa42-18c04d302a2e",
 "number": "00-00000012",
 "date_timestamp": "1673864047",
 "comment": "",
 "barcode": "87295811161005633592152700077828210760",
 "is_deleted": false,
 "is_loaded": false,
 "is_parent": false,
 "is_finished": false,
 "parent_doc_id": "",
 "priority": 0,
 "inn": "",
 "template": {
 "id": 1,
 "name": "Заказ клиента",
 "roles": [
 "1",
 "2"
 ],
 "process_id": 3,
 "dest_template_id": null,
 "is_notify_getting_doc": false,
 "is_allow_create_on_device": true,
 "is_load_arts_with_doc": false,
 "is_load_rows_on_open_doc": false,
 "is_use_select_log_as_insert_task": false,
 "is_scan_art_again": false,
 "is_from_select_to_insert_art_by_art": false,
 "is_unload_completed_doc": false,
 "is_unload_completed_child_doc": false,
 "unload_incorrect_doc_action": 0,
 "unload_incorrect_doc_option": 0,
 "search_barcode_priority": 0,
 "is_use_second_warehouse": false,
 "is_disable_manual_change_client": false,
 "is_disable_manual_change_warehouse": false,
 "is_use_all_barcodes": true,
 "unique_barcode_mode": 0,
 "is_use_barcode_templates": false,
 "is_manual_apply_cell": false,
 "is_manual_apply_art": false,
 "pack_list_generate_mode": 0,
 "is_can_skip_pack": false,
 "required_pack_qty": 0, 
 "is_multi_sn_logic": false,
 "is_get_sn_list_from_server": false,
 "is_use_additional_forms": false,
 "is_group_selection_forms": false,
 "is_update_forms_from_server": false,
 "is_multi_doc": false,
 "multi_doc_timeout": 0,
 "is_play_multi_doc_sound": false,
 "new_art_action": 2,
 "is_delete_left_task_qty": false,
 "online_arts_catalog": 0,
 "is_deleted": false,
 "create_mode": 0,
 "is_warehouse_required": false,
 "is_client_required": false,
 "is_check_unit_task": false,
 "is_check_remaining_expiration_date": false,
 "is_load_doc_logs": false,
 "selective_check_pack_mode": 0,
 "select": {
 "filter_type": 0,
 "is_use_operation": true,
 "art_scan_action": 2,
 "is_manual_quantity": true,
 "is_enter_to_commit": true,
 "is_send_row_to_server": true,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_tare_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_check_cell_by_task": false,
 "is_handle_whole_cell": false,
 "is_handle_whole_tare": false,
 "use_sn_mode": 1,
 "is_check_sn_by_task": false,
 "is_use_unique_sn": false,
 "is_require_enter_sn": false,
 "sn_data_type": 1,
 "sn_rules": {
 "mask": "yyyy/dd/mm",
 "is_expired_year": true
 },
 "use_pack_mode": 0,
 "is_check_pack_by_task": false,
 "print_label_mode": 0,
 "is_use_photo_fixation": false,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0,
 "task_place_exсeed_action" : 0
 },
 "insert": {
 "filter_type": 0,
 "is_use_operation": true,
 "art_scan_action": 2,
 "is_manual_quantity": true,
 "is_enter_to_commit": true,
 "is_send_row_to_server": true,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_tare_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_check_cell_by_task": false,
 "is_handle_whole_cell": false,
 "is_handle_whole_tare": false,
 "use_sn_mode": 0,
 "is_check_sn_by_task": false,
 "is_use_unique_sn": false,
 "is_require_enter_sn": false,
 "sn_data_type": 0,
 "use_pack_mode": 0,
 "is_check_pack_by_task": false,
 "print_label_mode": 0,
 "is_use_photo_fixation": false,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0,
 "task_place_exсeed_action" : 0
 },
 "egais": {
 "is_egais_doc": false,
 "enter_data_matrix_mode": 0,
 "is_compare": false,
 "is_check_mark_on_server": false,
 "version": 0,
 "is_use_bottling_date": false,
 "enter_pdf417_barcode_mode": 0,
 "is_use_blank_a": false,
 "is_use_blank_b": false,
 "is_get_bottling_date_from_server": false
 },
 "marking": {
 "is_marking_doc": false,
 "check_task_mode": 0,
 "ean_scan_type": 0,
 "without_km_enter_type": 0,
 "is_ean_equals_gtin": false,
 "is_search_by_km": false,
 "is_only_mark_art": false,
 "check_km_owner_action": 0,
 "check_km_status_action": 0,
 "sn_source": 0,
 "use_osu_mode": 0,
 "use_osu_switcher": 0,
 "check_ki_source": 0,
 "allowed_statuses": [
 0,
 1,
 2,
 6
 ]
 }
 },
 "warehouse_1": {
 "id": "6f87e83f-722c-11df-b336-0011955cba6b",
 "name": "Центральный склад"
 },
 "forms": []
 },
]

см. doc

docs/tasks

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка строк задания документов

Где используется

На форме списка документов
При входе в документ

Запрос

Параметры

Наименование	Тип	Описание
doc_id	string	Идентификатор документа
operation_type	int	Тип операции
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/tasks?operation_type=0&doc_id=1&device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
doc_detail *обязательное	object array	Массив объектов строк документа

Пример ответа

Возвращаются объекты doc_detail


[
 {
 "art": {
 "id": "8U-bd72d927-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000"
 },
 "cell": {
 "barcode": "195171589514805721134711768197818530411"
 },
 "unit_id": "GUID_UNIT_2",
 "unit_qty": 5,
 "unit_name": "UNIT_2_NAME",
 "unit_coef": 100,
 "limit_qty": 10,
 "qty": 2,
 "sn": "",
 "attributes": [
 {
 "number": 1,
 "form_id": "123",
 "value": "id342553453456346",
 "value_name": "Наименование значения доп. формы",
 },
 {
 "number": 2,
 "form_id": "123",
 "value": "Строка",
 "value_name": "Наименование значения доп. формы",
 },
 {
 "number": 3,
 "form_id": "123",
 "value": "2",
 "value_name": "Наименование значения доп. формы",
 }
 ],
 "is_kit": false
 },
]

Полезные статьи

doc_detail

docs/tasks/replace

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Замена задания по товару и ячейке

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание	Значения
doc_id	string	Идентификатор документа	-
operation_type	int	Тип операции	0 – подбор 1 – размещение
doc_detail	object	Объект строки задания	-

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/tasks/replace?device_id=1&username=Администратор


[
 {
 "doc_id": "d82-b322e1a5-859b-11ec-aa42-18c04d302a2e",
 "operation_type": 0,
 "detail": {
 "art":{
 "id": "8U-bd72d927-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000"
 },
 "sn": {},
 "qty_left": 5,
 "cell": {}
 }
 },
 {
 "doc_id": "d82-b322e1a5-859b-11ec-aa42-18c04d302a2e",
 "operation_type": 0,
 "detail": {
 "art":{
 "id": "8U-bd734563-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000"
 },
 "sn": {},
 "qty_left": 18,
 "cell": {}
 }
 },
]

Ответ

Тело

Наименование	Тип	Описание
doc_detail *обязательное	object array	Массив объектов строк задания

Пример ответа


[
 {
 "art": {
 "id": "8U-bd72d927-55bc-11d9-848a-00112f43529a00000000-0000-0000-0000-000000000000"
 },
 "cell": {
 "barcode": "195171589514805721134711768197818530411"
 },
 "limit_qty": 10,
 "qty": 2,
 "sn": ""
 },
]

Полезные статьи

doc_detail

docs/warehouse

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Изменение склада в документе

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело

Наименование	Тип	Описание	Значение
warehouse_id	string	Идентификатор контрагента	-
warehouse_type	string	Тип склада	0 – склад-отправитель 1 – склад-получатель
doc_id	string	Идентификатор документа	-

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


http://192.168.1.1/DM/hs/DataMobileExch/api/docs/warehouse?device_id=1&username=Администратор


{
 "warehouse_id": "08305acc-7303-11df-b338-0011955cba6b",
 "warehouse_type": 1,
 "doc_id": "d82-b322e1a7-859b-11ec-aa42-18c04d302a2e"
}

Ответ

Тело

Наименование	Тип	Описание
is_success *обязательное	boolean	Успешность операции

Пример ответа


{
 "is_success": true
}

egais/arts

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника товаров ЕГАИС
Загрузка товаров ЕГАИС документа

Где используется

В операции “Загрузка данных”
В документах ЕГАИС

Запрос

Параметры

Наименование	Тип	Описание
doc_id	string	Идентификатор документа ЕГАИС
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Пример запроса №1

Загрузка справочника ЕГАИС товаров


http://192.168.1.1/DM/hs/DataMobileExch/api/egais/arts?username=Администратор&device_id=1

Пример запроса №2

Загрузка ЕГАИС товаров документа


http://192.168.1.1/DM/hs/DataMobileExch/api/egais/arts?doc_id=1&username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
egais_art *обязательное	object array	Массив объектов товаров ЕГАИС

Пример ответа


[
 {
 "id": "8e-ecf5f0d1-dc9c-4e14-00ec-83396819e05b",
 "name": "Вино столовое сухое белое ''Шардоне''",
 "alcocode": "0016112000001188702",
 "percent_alco": 11.5,
 "type_alco": "400 Вина натуральные",
 "capacity": 0.7,
 "importer": "",
 "manufacturer": "АО ''Миллеровский винзавод''",
 "is_compared": false,
 "box_coef": 0
 },
]

Полезные статьи

egais_art

egais/arts/marks

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника акцизных марок товаров ЕГАИС

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/egais/arts/marks?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
egais_art_mark *обязательное	object array	Массив объектов элементов справочника акцизных марок

Пример ответа


[
 {
 "art_id": "8e-bef5a6d5-a081-f5c3-21f6-eaa63dd473b6",
 "mark": "22N000003DZJ812S92S09K580924002000364IHOH2WWNADB16YSSV4R4XYKPZABA520",
 "box": "",
 "pallet": ""
 },
]

Полезные статьи

egais_art_mark

egais/arts/scan

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Идентификация и получение объекта товара ЕГАИС при сканировании акцизной марки

Где используется

В документах ЕГАИС

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
cell_barcode	string	ШК ячейки
barcode	string	ШК товара ЕГАИС
mark	string	Акцизная марка
doc_id	string	Идентификатор документа ЕГАИС
art_id	string	Идентификатор товара ЕГАИС

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


http://192.168.1.1/DM/hs/DataMobileExch/api/egais/arts/scan?username=Администратор&device_id=1


{
 "cell_barcode": "",
 "barcode": "",
 "mark": "22N000004EN86MA2XWN0CFK8062600100003586SGV5J6HEZCIBWBOITHANHU2VH3PD9",
 "doc_id": "d82-2b098337-4388-11ec-b09f-50465db6e599",
 "art_id": ""
}

Ответ

Тело

Наименование	Тип	Описание
egais_art *обязательное	object	Объект товара ЕГАИС

Пример ответа


{
 "id": "8e-cf92cb65-9101-e2f6-f4c7-fbacf7e657c0",
 "name": "Вино географического наименования Ведерниковское сухое розовое ''Губернаторское розовое''",
 "alcocode": "0016112000002677287",
 "percent_alco": 12.5,
 "type_alco": "401 Вино (виноградное)",
 "capacity": 0.75,
 "importer": "",
 "manufacturer": "АО ''Миллеровский винзавод''",
 "is_compared": true,
 "box_coef": 0
}

Полезные статьи

egais_art

egais/packs/scan

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Получение данных по коробу в документе ЕГАИС
Получение данных по палете в документе ЕГАИС

Где используется

В документах ЕГАИС

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание	-
type	int	Тип упаковки	0 – короб 1 – палета
pack_barcode	string	ШК упаковки	-
doc_id	string	Идентификатор документа ЕГАИС	-

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


http://192.168.1.1/DM/hs/DataMobileExch/api/egais/packs/scan?username=Администратор&device_id=1

{
 "type": 0,
 "pack_barcode": "01000000014810118000000169",
 "doc_id": "d82-2b098337-4388-11ec-b09f-50465db6e599"
}

Ответ

Тело

Наименование	Тип	Описание
qty обязательное	int	Количество позиций в упаковке
mark обязательное	string	Акцизная марка
box	string	ШК короба
pallet	string	ШК палеты
egais_art	object array	Массив объектов товаров ЕГАИС

Пример ответа №1

Запрос по каждой АМ

fast_access/url

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение данных из учетной системы
Пример использования Быстрый доступ (Создание пользовательской функции)

Где используется

Операции / Быстрый доступ - функция “Быстрый доступ (ссылка)”

Запрос

Параметры

Наименование	Тип	Описание
barcode	string	ШК
full_barcode	string	Полный ШК
username	string	Имя пользователя
device_id	string	Идентификатор устройства
gs1_barcode	string	Полный ШК ГС1 с разбитием по тегам (теги в квадратных скобках) *Передаётся только при условии считывания ШК формата ГС1

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

Получение данных в операции “Быстрый доступ” при сканировании ШК

fast_access/text

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение данных из учетной системы
Пример использования Быстрый доступ (Создание пользовательской функции)

Где используется

Операции / Быстрый доступ - функция “Быстрый доступ (текст)”

Запрос

Параметры

Наименование	Тип	Описание
barcode	string	ШК
full_barcode	string	Полный ШК
username	string	Имя пользователя
device_id	string	Идентификатор устройства
gs1_barcode	string	Полный ШК ГС1 с разбитием по тегам (теги в квадратных скобках) *Передаётся только при условии считывания ШК формата ГС1

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

Получение данных в операции “Быстрый доступ” при сканировании ШК

fast_access/html

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение данных из учетной системы
Пример использования Быстрый доступ (Создание пользовательской функции)

Где используется

Операции / Быстрый доступ - функция “Быстрый доступ (html)”

Запрос

Параметры

Наименование	Тип	Описание
barcode	string	ШК
full_barcode	string	Полный ШК
username	string	Имя пользователя
device_id	string	Идентификатор устройства
gs1_barcode	string	Полный ШК ГС1 с разбитием по тегам (теги в квадратных скобках) *Передаётся только при условии считывания ШК формата ГС1

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

Получение данных в операции “Быстрый доступ” при сканировании ШК

forms

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника доп. форм

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

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


http://192.168.1.1/DM/hs/DataMobileExch/api/forms?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
step *обязательное	object array	Массив объектов дополнительных форм

Пример ответа

Возвращаются объекты step


[
 {
 "id": "df8282cd-eee0-11eb-b092-50465db6e599",
 "name": "Ответственный",
 "type": 3,
 "parent_id": "ffc48ab0-c806-4e8b-98df-a78a65543d50",
 },
]

Полезные статьи

step

forms/content

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника значений доп. форм

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

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


http://192.168.1.1/DM/hs/DataMobileExch/api/forms/content?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
form_content *обязательное	object array	Массив объектов значений доп.формы

Пример ответа

Возвращаются объекты form_content


[
 {
 "id": "ad3057e8-ffd2-11db-8378-00055d74a96a",
 "name": "Иванов Петр Федорович",
 "form_id": "ffc48ab0-c806-4e8b-98df-a78a65543d50",
 "barcode": ""
 },
]

Полезные статьи

form_content

forms/docs

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение связи шаблонов документов и доп. форм

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

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


http://192.168.1.1/DM/hs/DataMobileExch/api/forms/docs?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
doc_form *обязательное	object array	Массив объектов связей шаблонов документов и доп.форм

Пример ответа


[
 {
 "id": "a6b53d0a-85a8-11ec-b0a5-50465db6e599",
 "template_id": 42,
 "attribute_number": 1,
 "is_check_by_task ": false,
 "enter_mode": 1,
 "is_required": false,
 "form_type": 0
 },
]

Полезные статьи

doc_form

packs/verify

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Проверка значения штрихкода агрегируемой упаковки

Где используется

В документах, при использовании параметра шаблона “Проверка ввода упак. листа”:

в форме генерации и ввода упаковочных листов
в форме сканирования товара при смене упаковки сканированием

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Список объектов с параметрами.

Наименование	Тип	Описание
doc_id	string	Идентификатор документа
pack_barcode	string	ШК упаковки

Пример запроса #1

При сканировании упаковки маркированной продукции

packs/generate

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Генерация ШК упаковки при агрегации (упаковочный лист/короб/палета)

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
doc_id	string	Идентификатор документа ТСД

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


http://192.168.1.1/DM/hs/DataMobileExch/api/packs/generate?username=Администратор&device_id=1


{
 "doc_id": "123"
}

Ответ

Тело

Наименование	Тип	Описание
data *обязательное	string	ШК упаковки

Пример ответа


{
 "data": "[00]400000011100000096"
}

packs/scan

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Получение данных по упаковке

Где используется

В документах

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
gs1	string	ШК упаковки в формате GS1
cell_barcode	string	ШК ячейки
doc_id	string	Идентификатор документа
pack_barcode	string	ШК упаковки

Пример запроса #1

При сканировании упаковки маркированной продукции


http://192.168.1.1/DM/hs/DataMobileExch/api/packs/scan?username=Администратор&device_id=1


{
 "gs1": "[00]400000011100000089",
 "cell_barcode": "",
 "doc_id": "123",
 "pack_barcode": "00400000011100000089"
}

Пример запроса #2

При сканировании упаковки обычной продукции

photos/parts

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Порционная загрузка изображений в карточке товара
Порционная загрузка изображений со справочником товаров

Примечание

За порционную загрузку отвечает параметр в ПО: Настройки / Справочники / Порционная загрузка.

Где используется

В карточке товара
В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
art_id	string	Идентификатор товара
username	string	Имя пользователя
device_id	string	Идентификатор устройства
part	int	Номер порции данных

Пример запроса #1

Загрузка миниатюры изображения в карточке товара

photos/previews

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка основного превью-изображения в карточке товара
Загрузка основных превью-изображений со справочником товаров

Где используется

В карточке товара
В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
art_id	string	Идентификатор товара
username	string	Имя пользователя
device_id	string	Идентификатор устройства
part	int	Номер порции данных

Пример запроса #1

Загрузка превью-изображения в карточке товара


http://192.168.1.1/DM/hs/DataMobileExch/api/photos/previews?art_id=1&username=Администратор&device_id=1&part=1

Пример запроса #2

Загрузка превью-изображений со справочником товаров


http://192.168.1.1/DM/hs/DataMobileExch/api/photos/previews?username=Администратор&device_id=1&part=1

Ответ

Тело

Наименование	Тип	Описание
data *обязательное	object array	Массив объектов изображений
is_finished *обязательное	boolean	Признак завершающей порции данных

Пример ответа


{
 "is_finished": false,
 "data":[
 {
 "id": "12345678",
 "art_id": "123",
 "data": "/9j/4AAQSkZJRgABAQEAYABgAAD//gA7Q1JFQVRPUjogZ2QtanBlZyB2MS4wICh1\r\nc2luZyBJSkcgSlBFRyB2NjIpLCBxdWFsaXR5ID0gOTAK/9sAQwADAgIDAgIDAwMD"
 },
 ]
}

Полезные статьи

image

print

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Печать этикеток

Где используется

В операции “Печать этикеток”
Форма списка документов
В документах (быстрая печать)
Форма генерации упаковки

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
is_km	boolean	Признак печати КМ
unit_name	string	Наименование ЕИ
gs1	string	Значение ШК GS1
art_sn	string	Серия товара
qty_int	int	Количество до запятой
qty	float	Количество
is_need_print_copy	boolean	Признак печать копии ШК
barcode	string	ШК
qty_fraction	int	Количество после запятой
art_id	string	Идентификатор товара
price	float	Цена товара
barcode_full	string	Цена товара и ШК

Пример запроса #1

Печать этикетки товара на форме операции “Печать этикеток”

print/art

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Печать этикеток

Где используется

Печать этикетки товара

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
art_id	string	Идентификатор товара
art_sn	string	Серия товара
barcode	string	ШК
barcode_full	string	Цена товара и ШК
doc_id	string	Идентификатор документа
gs1	string	Значение ШК GS1 разбитое по тегам. Теги заключены в квадратные скобки.
is_km	boolean	Признак печати КМ
is_need_print_copy	boolean	Признак печать копии ШК
price	float	Цена товара
qty	float	Количество копий этикеток
qty_fraction	int	Количество товара после запятой
qty_int	int	Количество товара до запятой
sn_data	object array	Массив типов серий и их значений
unit_name	string	Наименование ЕИ

Пример запроса #1

Печать этикетки товара на форме операции “Печать этикеток”

print/doc

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Печать документа

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
doc_id	string	Идентификатор документа

Пример запроса #1

Печать документа


http://192.168.1.1/DM/hs/DataMobileExch/api/print/doc?device_id=1&username=Администратор


{
 "doc_id": "d82-15248e90-80a6-11ef-af66-d843ae3df62e"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус печати

Пример ответа


{
 "is_success": true
}

print/pack

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

POST

Назначение

Печать упаковочного листа

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

Тело

Наименование	Тип	Описание
doc_id	string	Идентификатор документа
pack_barcode	string	Номер упаковочного листа

Пример запроса #1

Печать упаковочного листа


http://192.168.1.1/DM/hs/DataMobileExch/api/print/pack?device_id=1&username=Администратор


{
 "doc_id": "1",
 "pack_barcode": "[00]000000000100000054"
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	Статус печати

Пример ответа


{
 "is_success": true
}

system/info

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Установка соединения с сервером

Где используется

На форме авторизации
Проверка соединения

Запрос

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


http://192.168.1.1/DM/hs/DataMobileExch/api/system/info

Ответ

Тело

Наименование	Тип	Описание
data *обязательное	string	Ответ сервера

Пример ответа


{
 "data": "Соединение с сервером установлено! "
}

system/ping

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Проверка состояния соединения с сервером

Где используется

На всех формах (индикатор соединения с сервером)

Запрос

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


http://192.168.1.1/DM/hs/DataMobileExch/api/system/ping

Ответ

Тело

Наименование	Тип	Описание
is_success *обязательное	boolean	Статус соединения с сервером

Пример ответа


{
 "is_success": true
}

system/version

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Проверка версии формата обмена сервера

Где используется

Авторизация
Проверка соединения
Сохранение настроек обмена

Запрос

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


http://192.168.1.1/DM/hs/DataMobileExch/api/system/version

Ответ

Тело

Наименование	Тип	Описание
data обязательное	string	Версия форматов обмена

Пример ответа


{
 "data": "3.0"
}

templates

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка шаблонов документов

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/templates?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
template обязательное	object array	Массив объектов шаблона документа

Пример ответа


[
 {
 "id": 1,
 "is_deleted": false,
 "name": "Заказ клиента",
 "roles": [
 "1",
 "2"
 ],
 "is_multi_sn_logic": false,
 "is_allow_create_on_device": true,
 "is_load_arts_with_doc": false,
 "is_load_rows_on_open_doc": false,
 "pack_list_generate_mode": 0,
 "is_use_barcode_templates": false,
 "is_use_select_log_as_insert_task": false,
 "unload_incorrect_doc_action": 0,
 "unload_incorrect_doc_option": 0,
 "is_scan_art_again": false,
 "is_use_all_barcodes": true,
 "is_unload_completed_child_doc": false,
 "is_unload_completed_doc": false,
 "required_pack_qty": 0,
 "is_use_second_warehouse": false,
 "is_disable_manual_change_client": false,
 "is_disable_manual_change_warehouse": false,
 "dest_template_id": null,
 "is_notify_getting_doc": false,
 "is_manual_apply_cell": false,
 "is_manual_apply_art": false,
 "is_use_additional_forms": false,
 "is_group_selection_forms": false,
 "is_update_forms_from_server": false,
 "is_can_skip_pack": false,
 "is_get_sn_list_from_server": false,
 "is_delete_left_task_qty": false,
 "new_art_action": 2,
 "is_multi_doc": false,
 "is_from_select_to_insert_art_by_art": false,
 "unique_barcode_mode": 0,
 "multi_doc_timeout": 0,
 "is_play_multi_doc_sound": false,
 "online_arts_catalog": 0,
 "create_mode": 0,
 "is_warehouse_required": false,
 "is_client_required": false,
 "is_check_unit_task": false,
 "is_check_remaining_expiration_date": false,
 "is_load_doc_logs": false,
 "selective_check_pack_mode": 0,
 "select": {
 "filter_type": 0,
 "is_use_operation": true,
 "art_scan_action": 2,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_sn_mode": 0,
 "use_pack_mode": 0,
 "is_check_cell_by_task": false,
 "is_check_sn_by_task": false,
 "is_manual_quantity": true,
 "is_enter_to_commit": true,
 "is_send_row_to_server": true,
 "print_label_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_use_unique_sn": false,
 "is_use_photo_fixation": false,
 "use_tare_mode": 0,
 "is_handle_whole_tare": false,
 "is_handle_whole_cell": false,
 "is_require_enter_sn": false,
 "sn_data_type": 0,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0,
 "task_place_exсeed_action" : 0
 },
 "insert": {
 "filter_type": 0,
 "is_use_operation": false,
 "art_scan_action": 0,
 "task_exceed_action": 0,
 "limit_exceed_action": 0,
 "use_cell_mode": 0,
 "use_sn_mode": 0,
 "use_pack_mode": 0,
 "is_check_cell_by_task": false,
 "is_check_sn_by_task": false,
 "is_manual_quantity": false,
 "is_enter_to_commit": false,
 "is_send_row_to_server": false,
 "print_label_mode": 0,
 "enter_cell_type": 0,
 "is_get_cells_from_server": false,
 "is_use_unique_sn": false,
 "is_use_photo_fixation": false,
 "use_tare_mode": 0,
 "is_handle_whole_tare": false,
 "is_handle_whole_cell": false,
 "is_require_enter_sn": false,
 "sn_data_type": 0,
 "is_verify_row_on_server": false,
 "row_task_replace_mode": 0,
 "use_kit_mode": 0,
 "task_place_exсeed_action" : 0
 },
 "egais": {
 "is_egais_doc": false,
 "enter_data_matrix_mode": 0,
 "is_use_bottling_date": false,
 "is_compare": false,
 "enter_pdf417_barcode_mode": 0,
 "is_check_mark_on_server": false,
 "version": 0,
 "is_use_blank_a": false,
 "is_use_blank_b": false,
 "is_get_bottling_date_from_server": false
 },
 "marking": {
 "is_marking_doc": false,
 "check_task_mode": 0,
 "is_ean_equals_gtin": false,
 "ean_scan_type": 0,
 "is_search_by_km": false,
 "is_only_mark_art": false,
 "without_km_enter_type": 0,
 "check_km_owner_action": 0,
 "check_km_status_action": 0,
 "sn_source": 0,
 "use_osu_mode": 0,
 "use_osu_switcher": 0,
 "check_ki_source": 0,
 "need_confirm_km": false,
 "is_ignore_art_mismatch_by_ean_km": false,
 "allowed_statuses": [
 0,
 1,
 2,
 6
 ]
 }
 },
 "favorite": {
 "operation": 3,
 "actions": [
 1,
 3,
 7,
 8,
 9
 ] 
 }
},
]

Полезные статьи

template

units

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника ед. измерения

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/units?username=Администратор&1

Ответ

Тело

Наименование	Тип	Описание
unit *обязательное	object array	Массив объектов единиц измерения

Пример ответа

Возвращаются объекты unit


[
 {
 "id": "bd72d926-55bc-11d9-848a-00112f43529a",
 "name": "шт"
 },
]

Полезные статьи

unit

units/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Установка предела вместимости текущего упаковочного листа. Получение списка из единиц измерения (ЕИ) для установки ограничения текущего упаковочного листа (УЛ) по количеству мест в агрегируемой упаковке (limit).

Где используется

При агрегации товаров в упаковочный лист. Метод вызывается при подборе первой позиции в упаковке. Метод вызывается если в шаблоне документа используются параметры (см. template):

“Режим ввода упаковочных листов” = “После товара” (use_pack_mode = 2)
“Источник предела вместимости упаковки” = “Товар” (required_pack_qty_source = 1)

Принцип работы:

units/commit

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Установка предела вместимости текущего упаковочного листа. Подтверждение установки единицы измерения (ЕИ) ограничивающей текущий упаковочный лист (УЛ) по количеству мест.

Где используется

При агрегации товаров в упаковочный лист. Метод вызывается сразу после вызова метода GET api/units/list (см. units/list).

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя

Тело запроса

Наименование	Тип	Описание
doc_id	string	Идентификатор документа
operation_type	int	Вид табличной части: `0` - подбор, `1` - размещение *В шаблоне документа: “Подбор” или “Размещение”
value	string	Идентификатор выбранной упаковки (ЕИ)
detail	object	Объект данных подбираемой строки товара

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


http://192.168.1.1/DM/hs/DataMobileExch/api/units/commit?device_id=Q0822021A0042&username=Администратор


{
 "doc_id": "d82-e55b9c52-d0f5-11f0-ab61-005056b9db04",
 "operation_type": 0,
 "value": "aeaedada-3eba-11ef-bb1d-005056b96467",
 "detail": {
 ...
 }
}

Ответ

Тело

Наименование	Тип	Описание
is_success обязательное	boolean	`false` - для отказа в записи, `true` - для подтверждения записи

Пример ответа


{
 "is_success": false // или true
}

см. units/list

users

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника пользователей

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/users?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
user *обязательное	object array	Массив объектов пользователей

Пример ответа

Возвращаются объекты user


[
 {
 "id": "GUID-1CUS",
 "login": "login",
 "username": "Волков Андрей Иванович",
 "password": "",
 "roles": [
 "1",
 "2"
 ]
 },
]

Полезные статьи

user

users/roles

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника ролей

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/users/roles?username=Администратор&device_id=1

Ответ

Тело

Наименование	Тип	Описание
role *обязательное	object array	Массив объектов ролей пользователей

Пример ответа

Возвращаются объекты role


[

 {
 "id": "1",
 "name": "Роль №1",
 "permissions": {
 "is_allow_settings": 1,
 "is_allow_template_settings": 0,
 "is_allow_create_arts": 1,
 "is_allow_edit_arts": 0,
 "is_allow_create_barcodes": 1,
 "is_allow_edit_barcodes": 0,
 "is_allow_view_price": 1,
 "is_allow_docs": 0,
 "is_allow_scan_doc_barcode": 1,
 "is_allow_create_docs": 1,
 "is_allow_delete_docs": 1,
 "is_allow_fast_access": 0,
 "is_allow_feature_books": 1,
 "is_allow_feature_dashboard": 1,
 "is_allow_feature_operations": 1,
 "is_allow_print": 1,
 "is_allow_license_settings": 1,
 "is_allow_view_rest": 1
 }
 }
 ]

Полезные статьи

role

warehouses

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка справочника складов

Где используется

В операции “Загрузка данных”

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/warehouses?username=Администратор&1

Ответ

Тело

Наименование	Тип	Описание
warehouse *обязательное	object array	Массив объектов складов

Пример ответа

Возвращаются объекты warehouse


[
 {
 "id": "03ce4b6e-3ff7-11e0-af05-0015e9b8c48d",
 "name": "Бытовая техника"
 },
]

Полезные статьи

warehouse

warehouses/list

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Рекомендация списка складов с сервера

Где используется

В документах - при назначении или изменении склада. Вызывается при условии использования параметра шаблона is_get_warehouses_list_from_server.

Запрос

Параметры

Наименование	Тип	Описание
device_id	string	Идентификатор устройства
username	string	Имя пользователя
doc_id	string	Идентификатор документа

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


http://192.168.1.1/DM/hs/DataMobileExch/api/warehouses/list?device_id=Q0822021A0042&username=Администратор&doc_id=d82-f45e81e8-af14-11f0-a34e-d3afad0180a6

Ответ

Тело

Наименование	Тип	Описание
warehouse обязательное	object array	Массив объектов складов

Пример ответа

Возвращаются объекты warehouse


[
 {
 "id": "03ce4b6e-3ff7-11e0-af05-0015e9b8c48d",
 "name": "Бытовая техника"
 },
 {
 "id": "04ce5b7d-3ff7-11e0-af05-0015e9b8c48d",
 "name": "Торговый зал"
 }
]

см. template
см. warehouse

barcode_templates

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Загрузка шаблонов ШК

Где используется

В операции “Загрузка данных”, если в /device/data пришёл параметр is_need_load_barcode_templates (см. DMX-A-26).

Запрос

Параметры

Наименование	Тип	Описание
username	string	Имя пользователя
device_id	string	Идентификатор устройства

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


http://192.168.1.1/DM/hs/DataMobileExch/api/barcode_templates?device_id=1&username=Администратор

Ответ

Тело

Наименование	Тип	Описание
barcode_template обязательное	object array	Объект шаблона штрихкодов

Пример ответа

Возвращается массив из объектов barcode_template


[
 {
 "type_id": 0,
 "length": 13,
 "barcode_type_id": 0,
 "prefix": "20",
 "bc_segment": {
 "start": 3,
 "end": 7
 },
 "kg_segment": {
 "start": 8,
 "end": 9
 },
 "gm_segment": {
 "start": 10,
 "end": 12
 }
 },
 {
 "type_id": 6,
 "length": 20,
 "barcode_type_id": 0,
 "prefix": "00",
 "bc_segment": {
 "start": 3,
 "end": 20
 }
 }
]

см. barcode_template