1.56 от 11.01.2023 16:07:22
Сообщение обмена: getTicketsIDs (ПолучитьСписокБилетов)
Новый синхронный запрос на номера билетов, полученных в гиис
1.55 от 28.12.2022 16:02:23
Сообщение обмена: unionBatches (ОбъединитьПартии)
Новое действие с партиями, объединить без преобразования
1.51 от 18.12.2022 16:57:52
Сообщение обмена: wholesale (ОптоваяПродажа)
Новое сообщение обмена для удобного обмена продажами
1.50 от 12.12.2022 21:42:07
Сообщение обмена: hallmarking (ПробирныеРаботы)
Новый пакет обмена для пробирных работ
1.49 от 07.12.2022 20:18:20
Сообщение обмена: kitMaking (ИзготовлениеКомплектов)
Добавлена новая операция
Сообщение обмена: kit (Комплект)
В партии добавлено свойство barcode, штрихкод.
Сообщение обмена: kit (Комплект)
Добавлен новый тип партии.
1.47 от 17.11.2022 21:54:37
Сообщение обмена: convertToScarp (ПреобразованиеПартийВЛом)
Предоставлены методы для преобразования партий в лом и заготовки изделий
1.46 от 27.10.2022 20:53:03
Сообщение обмена: retailSell (РозничнаяПродажа)
Добавлен параметр autosend для целей автоматического размещение в очереди отправки
1.36 от 05.05.2022 16:56:47
Сообщение обмена: deal (Контракт)
Для контракта появляется признак forceSend. Сценарий выглядит так, после отправки сообщения контракт, флаг по умолчанию становится "истина" и тогда контракт в ближайший сеанс обмена по этой спецификации отправится. Поведение флага нужно менять только в случае, если не хочется отправлять заново контракт.
1.32 от 22.04.2022 1:07:27
Сообщение обмена: productBase (ПартияИзделийБазовая)
Добавлена таблица родительских партий для изготовления изделий.
Сообщение обмена: productBaseRemains (ПартияИзделийБазоваяОстатки)
Добавлена таблица родительских партий для изготовления изделий.
Сообщение обмена: productFull (ПартияИзделийПолная)
Добавлена таблица родительских партий для изготовления изделий.
Сообщение обмена: productFullRemains (ПартияИзделийПолнаяОстатки)
Добавлена таблица родительских партий для изготовления изделий.
1.30 от 30.03.2022 23:30:36
Сообщение обмена: produceProduct (ОформлениеИзделий)
Для рейса 3.3.13. Используется для изготовления из партий полуфабрикатов ювелирных изделий
Сообщение обмена: retailSell (РозничнаяПродажа)
Добавлен реквизит Возврат. Используется при возврате в розничной продаже.
Сообщение всегда передается в составе пакета, т.е. библиотека интеграции на стороне потребителя данных всегда ожидает массив сообщений. В частном случае в массиве может быть одно сообщение. Для каждого сообщения должны быть объявлены поля:
[
{
"MsgType": "Loan", // имя типа
"MsgID": 1, // уникальный номер в пакете
"MsgData":
{
// содержание сообщения, формат определяется типом сообщения
}
},
{
"MsgType": "Client", // имя типа
"MsgID": 2, // уникальный номер в пакете
"MsgData":
{
// содержание сообщения, формат определяется типом сообщения
}
}
]
Пакет сообщений передается в теле запроса POST "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/postMessage". Где "[ИмяБазы]" это наименование информационной базы, указанное при ее публикации. А "[ИдентификаторПоставщика]" это идентификатор поставщика, указанный в поле "Идентификатор" в соответствующем элементе справочника Поставщики данных, по настройкам которого будет загружаться пакет сообщений. Пример ответа от сервера:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор запущенного задания загрузки переданных данных
"taskStarted", "true" // Признак, что задание успешно запущено
"declineReason", "" // Представление ошибки, в случае если задание не запущено
}
Получить результат загрузки пакета сообщений можно через запрос GET "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/getTaskStatus?taskID=[ИдентификаторЗаданияПотребителя]" Где "[ИмяБазы]" это наименование информационной базы, указанное при ее публикации. А "[ИдентификаторПоставщика]" это идентификатор поставщика, использованный ранее при выгрузке данных. И "[ИдентификаторЗаданияПотребителя]" это идентификатор, полученный с ответом сервера при выполнении postMessage.
Пример ответа от сервера:
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 150000, // Общее количество сообщений в задании
"dataProcessed": 150000, // Количество обработанных на момент запроса сообщений
"dataDeclined": 2, // Количество сообщений с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID": "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания загрузки данных
"msgIDs": // Массив сообщений, которые не были загружены или были загружены с ошибками
[
{
"msgID": "34" // Идентификатор сообщения с ошибкой
},
{
"msgID": "54792" // Идентификатор сообщения с ошибкой
}
]
}
Наименование этого сообщения в журнале регистрации: "ДействиеСКвитанцией".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор операции действия с квитанцией;
action (Действие) - Строка - Действие, проводимое с квитанцией;
Допустимые значения (см. описание типа с перечисляемыми значениями ДействиеСКвитанцией):
ticketsList (СписокКвитанций) - Массив -
Пример пакета с сообщением ticketAction
[
{
"MsgType": "ticketAction",
"MsgID": 1,
"MsgData":
{
"id": "2344/2134\/1241",
"action": "DS_BR_REDEEMED",
"ticketsList":
[
{
"ticketID": "230f9da68-512a-11e9-9156-e0d55e22b782"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ДобавитьУИНвСпецификацию".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением pushUINsToSpec
[
{
"MsgType": "pushUINsToSpec",
"MsgID": 1,
"MsgData":
{
"id": "2344/2134\/1241",
"specID": "Т-912939-123-233",
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
],
"addMode": "True"
}
}
]
Наименование этого сообщения в журнале регистрации: "ДрагоценныйКамень".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
stoneType (ВидКамня) - Строка - Вид камня;
Необязательный параметр. Значение по умолчанию: "PRECIOUS_STONE";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидыКамней):
stonesBatchType (ВидПартииКамней) - Строка - Тип партии камней;
Необязательный параметр. Значение по умолчанию: "TREATED_GEMSTONES";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартииКамней):
quantity (Количество) - Число - Количество;
Необязательный параметр. Значение по умолчанию: 1
weight (Масса) - Число - Масса в каратах;
shape (Форма) - Строка - Форма огранки из документации к ГИИС;
quality (Качество) - Строка - Качество камня из документации к ГИИС;
color (Цвет) - Строка - Цвет камня из документации к ГИИС;
classCode (КлассификационныйКод) - Строка - Классификационный код камня из документации к ГИИС, можно не указывать, если заполнить Форма, Качество, Цвет;
Пример пакета с сообщением preciousStone
[
{
"MsgType": "preciousStone",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weight": 0.4,
"shape": "DIAMOND_KR_57",
"quality": "DIAMOND_3_GROUP",
"color": "DIAMOND_3",
"classCode":
}
}
]
Наименование этого сообщения в журнале регистрации: "ДрагоценныйКаменьОстатки".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
stoneType (ВидКамня) - Строка - Вид камня;
Необязательный параметр. Значение по умолчанию: "PRECIOUS_STONE";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидыКамней):
stonesBatchType (ВидПартииКамней) - Строка - Тип партии камней;
Необязательный параметр. Значение по умолчанию: "TREATED_GEMSTONES";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартииКамней):
quantity (Количество) - Число - Количество;
Необязательный параметр. Значение по умолчанию: 1
weight (Масса) - Число - Масса в каратах;
shape (Форма) - Строка - Форма огранки из документации к ГИИС;
quality (Качество) - Строка - Качество камня из документации к ГИИС;
color (Цвет) - Строка - Цвет камня из документации к ГИИС;
classCode (КлассификационныйКод) - Строка - Классификационный код камня из документации к ГИИС, можно не указывать, если заполнить Форма, Качество, Цвет;
Пример пакета с сообщением preciousStoneRemains
[
{
"MsgType": "preciousStoneRemains",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weight": 0.4,
"shape": "DIAMOND_KR_57",
"quality": "DIAMOND_3_GROUP",
"color": "DIAMOND_3",
"classCode":
}
}
]
Наименование этого сообщения в журнале регистрации: "ЗалоговыйБилет".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением pawnTicket
[
{
"MsgType": "pawnTicket",
"MsgID": 1,
"MsgData":
{
"ticketID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"clientID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"date": "20220901",
"ticketNumber": "АБ331212",
"cost": 17000,
"description": "Кольцо 1г, браслет 5г, АБ331212",
"items":
[
{
"Batch": "id1230123"
}
],
"sum": 15000,
"days": 30,
"redeemDate": "20221013"
}
}
]
Для изготовления комплекта необходимо передать столько строк, сколько изделий входит в комплект. Если в один комплект входит 3 изделия, то нужно передать три строки, где kitID будет общий для всех трёх. Таких комплектов можно передать до 100 штук в одном изготовлении.
Наименование этого сообщения в журнале регистрации: "ИзготовлениеКомплектов".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением kitMaking
[
{
"MsgType": "kitMaking",
"MsgID": 1,
"MsgData":
{
"kitMakingID": ,
"kits":
[
{
"kitID": "4331f79d-a3f4-40a1-93fa-9311d014e9cf",
"batchID": "3d323520-59b2-4536-bac5-27e89c72cf2d"
}
]
}
}
]
В рамках данного сообщения можно передавать только идентификатор клиента и все остальные данные будут подставлены значения по умолчанию в рамках обезличивания клиентов. В последующем по этим идентификаторам при необходимости можно передать дополнительные сведения по клиентам, но переданные сведения в ГИИС уже исправить будет невозможно.
Наименование этого сообщения в журнале регистрации: "Клиент".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор клиента;
familyName (Фамилия) - Строка - Фамилия клиента;
Необязательный параметр. Значение по умолчанию: "Неопределено"
firstName (Имя) - Строка - Имя клиента;
Необязательный параметр. Значение по умолчанию: "Неопределено"
secondName (Отчество) - Строка - Отчество;
Необязательный параметр. Значение по умолчанию: ""
birthDay (ДатаРождения) - Дата - Дата рождения;
Необязательный параметр. Значение по умолчанию: Дата("20000101000000")
docType (ТипДокумента) - Строка - Тип документа;
Необязательный параметр. Значение по умолчанию: "ПаспортРФ";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипыДокументов):
docSerial (СерияДокумента) - Строка - Серия документа;
Необязательный параметр. Значение по умолчанию: "0000"
docNumber (НомерДокумента) - Строка - Номер документа;
Необязательный параметр. Значение по умолчанию: "123456"
issuerDeptCode (КодПодразделения) - Строка - ;
Необязательный параметр. Значение по умолчанию: "000-000"
issueDate (ДатаВыдачи) - Дата - Дата выдачи;
Необязательный параметр. Значение по умолчанию: Дата("20190101000000")
issuer (КемВыдан) - Строка - Орган, выдавший документ;
Необязательный параметр. Значение по умолчанию: "Неопределено"
nationality (Национальность) - Строка - ОКСМ код страны национальности;
Необязательный параметр. Значение по умолчанию: "643"
FIASCode (КодФИАС) - Строка - Код ФИАС адреса, если нет возможности указать, заполняется вручную в Аскорт:Маркировке, либо не указывается и будет выбран адрес по умолчанию;
Необязательный параметр. Значение по умолчанию: "0c2c345f-cd7b-4011-9f3b-65095ab4c186"
clientAddress (АдресКлиента) - Строка - Если передать этот адрес, а не код ФИАС, то в дальнейшем нужно обработать клиентов с такими произвольными адресами, чтобы выбрать с них код ФИАС. ;
Необязательный параметр. Значение по умолчанию: ""
Пример пакета с сообщением client
[
{
"MsgType": "client",
"MsgID": 1,
"MsgData":
{
"id": "230f9da68-512a-11e9-9156-e0d55e22b782"
}
}
]
Наименование этого сообщения в журнале регистрации: "Комиссия".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением comission
[
{
"MsgType": "comission",
"MsgID": 1,
"MsgData":
{
"ticketID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"clientID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"date": "20220901",
"ticketNumber": "АБ331212",
"cost": 17000,
"description": "Кольцо 1г, браслет 5г, АБ331212",
"items":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "Комплект".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
article (Артикул) - Строка - ;
barcode (Штрихкод) - Строка - ;
Пример пакета с сообщением kit
[
{
"MsgType": "kit",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"article": ,
"barcode":
}
}
]
Передает базовые сведения о контрагенте.
Необходимо передавать по тем контрагентам, которые используются в сообщениях с владельцами, производителями и держателями партий товаров.
Наименование этого сообщения в журнале регистрации: "Контрагент".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Произвольный идентификатор, используемый в последующем в сообщениях, где применяет контрагент;
description (Наименование) - Строка - Название компании;
ogrn (ОГРН) - Строка - ОГРН или ОГРНИП организации или предпринимателя;
inn (ИНН) - Строка - ;
kpp (КПП) - Строка - КПП организации;
intercompany (ТОП) - Булево - ;
Необязательный параметр. Значение по умолчанию: Ложь
fn (ФискальныйНакопитель) - Строка - ;
Пример пакета с сообщением counterparty
[
{
"MsgType": "counterparty",
"MsgID": 1,
"MsgData":
{
"id": "1201600090504/166001001",
"description": "ООО Ромашка",
"ogrn": "1201600090504",
"inn": ,
"kpp": "166001001",
"fn":
}
}
]
Наименование этого сообщения в журнале регистрации: "Контракт".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
dealID (Идентификатор) - Строка - Идентификатор контракта;
number (Номер) - Строка - необязателен к заполнению, опционально;
numberOut (НомерВходящий) - Строка - Номер контракта получателя;
dealDate (ДатаКонтракта) - Дата - Дата контракта;
dealType (ТипКонтракта) - Строка - DL_IMPORT_EXPORT Контракт на импорт/экспорт¶DL_IMPORT_EXPORT_TEMP Контракт на временный ввоз/вывоз¶DL_MAIL_ERRAND Письмо-поручение¶DL_PRODUCTION Договор на производство по давальческой схеме¶DL_REALIZATION Договор на реализацию¶DL_RENT Договор аренды¶DL_SALE Договор купли-продажи¶DL_TRANSPORTING Договор подряда¶DL_MINING Договор на добычу;
dealState (СостояниеКонтракта) - Строка - DS_DRAFT Черновик¶DS_ON_SIGNING На подписании¶DS_OPERATE Действует¶DS_COMPLETED Выполнен¶DS_TERMINATED Расторгнут;
Необязательный параметр. Значение по умолчанию: "DS_OPERATE"
provider (Поставщик) - Строка - Идентификатор поставщика;
recipient (Получатель) - Строка - Идентификатор покупателя (получателя, собственника);
shipper (Грузоотправитель) - Строка - ;
consignee (Грузополучатель) - Строка - ;
currency (Валюта) - Строка - Код валюты;
Необязательный параметр. Значение по умолчанию: "RUB"
amount (Сумма) - Число - Сумма Контракта;
VATAmount (СуммаНДС) - Число - ;
forceSend (ПринудительнаяОтправка) - Булево - Если установить данный флаг, то следующая отправка любой спецификации по данному контракту обновит данные контракты. ;
Необязательный параметр. Значение по умолчанию: Истина
giisNumber (НомерВГИИС) - Строка - // служебное поле;
Пример пакета с сообщением deal
[
{
"MsgType": "deal",
"MsgID": 1,
"MsgData":
{
"dealID": "ad2210923",
"number": "U133-22",
"numberOut": "АБ-123123-2022",
"dealDate": "20220101",
"dealType": "DL_SALE",
"provider": "123981237/123123123",
"recipient": "213123/4411231",
"shipper": "123981237/123123123",
"consignee": "213123/4411231",
"amount": 12333.33,
"VATAmount": ,
"giisNumber":
}
}
]
Метод объединяет партии рейсом 3.3.37, но не проводит их преобразования
Наименование этого сообщения в журнале регистрации: "ОбъединитьПартии".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор для рейса преобразования;
UINList (СписокУИН) - Массив - Перечень объединяемых уинов
BatchList (СписокИдентификаторовПартий) - Массив - Перечень идентификторов объединяемых партий
unionResult (ОбъединитьПартии) - Булево - ;
Необязательный параметр. Значение по умолчанию: Истина
Пример пакета с сообщением unionBatches
[
{
"MsgType": "unionBatches",
"MsgID": 1,
"MsgData":
{
"id": "230f9da68-512a-11e9-9156-e0d55e22b782",
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ОптоваяПродажа".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Любой уникальный идентификатор данной оптовой продажи, можно не заполнять, назначится автоматически;
buyer (Покупатель) - Строка - Идентификатор контрагента (требуется передать отдельным сообщением counterparty);
contract (Контракт) - Строка - Идентификатор контракта (требуется передать отдельным сообщением deal);
saleDate (ДатаПродажи) - Дата - Дата продажи;
ammount (Сумма) - Число - Стоимость всей продажи;
VAT (СуммаНДС) - Число - Сумма НДС по продаже;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
saleOperationNumber (УчетныйНомерПродажи) - Строка - Учётный номер документа продажи (накладной);
saleMethod (СпособПродажи) - Строка - Способ преобразования партий в продаже;
Допустимые значения (см. описание типа с перечисляемыми значениями способыОптовойПродажи):
batches (Партии) - Массив -
Пример пакета с сообщением wholesale
[
{
"MsgType": "wholesale",
"MsgID": 1,
"MsgData":
{
"id": "guid",
"buyer": "0c2c345f-cd7b-4011-9f3b-65095ab4c186",
"contract": "0c2c345f-cd7b-4011-9f3b-65095ab4c186",
"saleDate": "20221201",
"ammount": 500000,
"saleOperationNumber": "АБ00231233",
"saleMethod": "convertToNonCommodity",
"batches":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ОформлениеИзделий".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением produceProduct
[
{
"MsgType": "produceProduct",
"MsgID": 1,
"MsgData":
{
"id": ,
"produceList":
[
{
"batchPrepack": "id1230123",
"batchPoduct": "id3312312"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияИзделийБазовая".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;
Необязательный параметр. Значение по умолчанию: "DM_GOLD";
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - Проба партии;
Необязательный параметр. Значение по умолчанию: 0
weightFull (ОбщийВес) - Число - Общий вес изделия;
weight (ВесМеталла) - Число - Вес металла в изделии;
subType (ВидПартии) - Строка - Вид партии изделия;
Необязательный параметр. Значение по умолчанию: "JEWERLY";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
productType (ТипИзделия) - Строка - Тип изделия;
Необязательный параметр. Значение по умолчанию: "JS_OTHER";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):
quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;
Необязательный параметр. Значение по умолчанию: 1
inp (ИНП) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
uin (УИН) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
parentBatches (РодительскиеПартии) - Массив -
barcode (Штрихкод) - Строка - ;
Пример пакета с сообщением productBase
[
{
"MsgType": "productBase",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weightFull": 5.25,
"weight": 5.25,
"parentBatches":
[
{
"batch": "2333108763616",
"INP": ,
"metal": "DM_GOLD",
"quantity": 1,
"weight": 3.33
}
],
"barcode":
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияИзделийБазоваяОстатки".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;
Необязательный параметр. Значение по умолчанию: "DM_GOLD";
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - Проба партии;
Необязательный параметр. Значение по умолчанию: 0
weightFull (ОбщийВес) - Число - Общий вес изделия;
weight (ВесМеталла) - Число - Вес металла в изделии;
subType (ВидПартии) - Строка - Вид партии изделия;
Необязательный параметр. Значение по умолчанию: "JEWERLY";
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
productType (ТипИзделия) - Строка - Тип изделия;
Необязательный параметр. Значение по умолчанию: "JS_OTHER";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):
quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;
Необязательный параметр. Значение по умолчанию: 1
inp (ИНП) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
uin (УИН) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
parentBatches (РодительскиеПартии) - Массив -
barcode (Штрихкод) - Строка - ;
Пример пакета с сообщением productBaseRemains
[
{
"MsgType": "productBaseRemains",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weightFull": 5.25,
"weight": 5.25,
"parentBatches":
[
{
"batch": "2333108763616",
"INP": ,
"metal": "DM_GOLD",
"quantity": 1,
"weight": 3.33
}
],
"barcode":
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияИзделийПолная".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;
Необязательный параметр. Значение по умолчанию: "DM_GOLD";
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - Проба партии;
Необязательный параметр. Значение по умолчанию: 0
weightFull (ОбщийВес) - Число - Общий вес изделия;
weight (ВесМеталла) - Число - Вес металла в изделии;
productType (ТипИзделия) - Строка - Тип изделия;
Необязательный параметр. Значение по умолчанию: "JS_OTHER";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):
quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;
Необязательный параметр. Значение по умолчанию: 1
inp (ИНП) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
uin (УИН) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
parentBatches (РодительскиеПартии) - Массив -
barcode (Штрихкод) - Строка - ;
subType (ВидПартии) - Строка - Вид партии изделия;
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
article (Артикул) - Строка - Артикул изделия;
Необязательный параметр. Значение по умолчанию: ""
manufacturingDate (ДатаПроизводства) - Дата - Дата производства изделия;
Необязательный параметр. Значение по умолчанию: ""
brand (ТорговаяМарка) - Строка - Торговая марка производителя изделия;
Необязательный параметр. Значение по умолчанию: ""
metalList (Сплав) - Массив - Сведения о сплаве изделия
stones (Камни) - Массив -
INPonly (ТолькоИНП) - Булево - ;
Необязательный параметр. Значение по умолчанию: Ложь
serialNumber (СерийныйНомер) - Строка - ;
Пример пакета с сообщением productFull
[
{
"MsgType": "productFull",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weightFull": 5.25,
"weight": 5.25,
"parentBatches":
[
{
"batch": "2333108763616",
"INP": ,
"metal": "DM_GOLD",
"quantity": 1,
"weight": 3.33
}
],
"barcode": ,
"subType": "JEWERLY",
"serialNumber":
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияИзделийПолнаяОстатки".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;
Необязательный параметр. Значение по умолчанию: "DM_GOLD";
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - Проба партии;
Необязательный параметр. Значение по умолчанию: 0
weightFull (ОбщийВес) - Число - Общий вес изделия;
weight (ВесМеталла) - Число - Вес металла в изделии;
productType (ТипИзделия) - Строка - Тип изделия;
Необязательный параметр. Значение по умолчанию: "JS_OTHER";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):
quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;
Необязательный параметр. Значение по умолчанию: 1
inp (ИНП) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
uin (УИН) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
parentBatches (РодительскиеПартии) - Массив -
barcode (Штрихкод) - Строка - ;
subType (ВидПартии) - Строка - Вид партии изделия;
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
article (Артикул) - Строка - Артикул изделия;
Необязательный параметр. Значение по умолчанию: ""
manufacturingDate (ДатаПроизводства) - Дата - Дата производства изделия;
Необязательный параметр. Значение по умолчанию: ""
brand (ТорговаяМарка) - Строка - Торговая марка производителя изделия;
Необязательный параметр. Значение по умолчанию: ""
metalList (Сплав) - Массив - Сведения о сплаве изделия
stones (Камни) - Массив -
INPonly (ТолькоИНП) - Булево - ;
Необязательный параметр. Значение по умолчанию: Ложь
serialNumber (СерийныйНомер) - Строка - ;
Пример пакета с сообщением productFullRemains
[
{
"MsgType": "productFullRemains",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"weightFull": 5.25,
"weight": 5.25,
"parentBatches":
[
{
"batch": "2333108763616",
"INP": ,
"metal": "DM_GOLD",
"quantity": 1,
"weight": 3.33
}
],
"barcode": ,
"subType": "JEWERLY",
"serialNumber":
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияМеталла".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
subType (ВидПартии) - Строка - ;
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
quantity (Количество) - Число - ;
Необязательный параметр. Значение по умолчанию: 1
baseMetal (ОсновнойМеталл) - Строка - ;
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - ;
weight (ВесМеталла) - Число - ;
stamp (НомерСлитка) - Строка - ;
dateManufacture (ГодВыпуска) - Строка - ;
markType (МаркаДрагоценногоМеталла) - Строка - ;
mixMarkType (МаркаСплава) - Строка - ;
nuggetType (КодСамородка) - Строка - ;
metalList (Сплав) - Массив -
Пример пакета с сообщением batchMetal
[
{
"MsgType": "batchMetal",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"subType": ,
"baseMetal": ,
"hallmark": ,
"weight": ,
"stamp": ,
"dateManufacture": ,
"markType": ,
"mixMarkType": ,
"nuggetType": ,
"metalList":
[
{
"metal": "DM_GOLD",
"clearMetalWeight": 2.72,
"hallmark": 585
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПартияМеталлаОстатки".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;
name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );
okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;
description (Описание) - Строка - Полное описание партии (description из обмена);
phase (ЭтапОбработки) - Строка - Этап обработки партии;
Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";
Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):
process (СтадияОбработки) - Строка - Стадия обработка партии;
Необязательный параметр. Значение по умолчанию: "STORED";
Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):
tnved (ТНВЭД) - Строка - Код ТНВЭД;
Необязательный параметр. Значение по умолчанию: ""
producer (Производитель) - Строка - Производитель партии;
Необязательный параметр. Значение по умолчанию: ""
owner (Собственник) - Строка - Собственник партии изделий;
Необязательный параметр. Значение по умолчанию: ""
keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;
Необязательный параметр. Значение по умолчанию: ""
costType (ТипСтоимости) - Строка - Тип стоимости партии;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT";
Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):
sum (Цена) - Число - Цена партии;
Необязательный параметр. Значение по умолчанию: ""
vatRate (СтавкаНДС) - Строка - Ставка НДС;
Необязательный параметр. Значение по умолчанию: "NDS_NULL";
Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):
vat (СуммаНДС) - Число - Сумма НДС;
Необязательный параметр. Значение по умолчанию: ""
outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;
Необязательный параметр. Значение по умолчанию: Ложь
specificationID (Спецификация) - Строка - ;
subType (ВидПартии) - Строка - ;
Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):
quantity (Количество) - Число - ;
Необязательный параметр. Значение по умолчанию: 1
baseMetal (ОсновнойМеталл) - Строка - ;
Допустимые значения (см. описание типа с перечисляемыми значениями Металл):
hallmark (Проба) - Число - ;
weight (ВесМеталла) - Число - ;
stamp (НомерСлитка) - Строка - ;
dateManufacture (ГодВыпуска) - Строка - ;
markType (МаркаДрагоценногоМеталла) - Строка - ;
mixMarkType (МаркаСплава) - Строка - ;
nuggetType (КодСамородка) - Строка - ;
metalList (Сплав) - Массив -
Пример пакета с сообщением batchMetalRemains
[
{
"MsgType": "batchMetalRemains",
"MsgID": 1,
"MsgData":
{
"id": "АБ00231233",
"name": "Кольцо золотое 5.25 гр.",
"okpd2": "32.12.13.110",
"description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
"specificationID": ,
"subType": ,
"baseMetal": ,
"hallmark": ,
"weight": ,
"stamp": ,
"dateManufacture": ,
"markType": ,
"mixMarkType": ,
"nuggetType": ,
"metalList":
[
{
"metal": "DM_GOLD",
"clearMetalWeight": 2.72,
"hallmark": 585
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПреобразованиеПартийВЛом".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор для рейса преобразования;
UINList (СписокУИН) - Массив - Перечень объединяемых уинов
BatchList (СписокИдентификаторовПартий) - Массив - Перечень идентификторов объединяемых партий
unionResult (ОбъединитьПартии) - Булево - ;
Необязательный параметр. Значение по умолчанию: Истина
Пример пакета с сообщением convertToScarp
[
{
"MsgType": "convertToScarp",
"MsgID": 1,
"MsgData":
{
"id": "230f9da68-512a-11e9-9156-e0d55e22b782",
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПреобразованиеПартийВНетоварныеИзделия".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор для рейса преобразования;
UINList (СписокУИН) - Массив - Перечень объединяемых уинов
BatchList (СписокИдентификаторовПартий) - Массив - Перечень идентификторов объединяемых партий
unionResult (ОбъединитьПартии) - Булево - ;
Необязательный параметр. Значение по умолчанию: Истина
Пример пакета с сообщением convertToNonCommodity
[
{
"MsgType": "convertToNonCommodity",
"MsgID": 1,
"MsgData":
{
"id": "230f9da68-512a-11e9-9156-e0d55e22b782",
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПреобразованияПартийВЗаготовки".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор для рейса преобразования;
UINList (СписокУИН) - Массив - Перечень объединяемых уинов
BatchList (СписокИдентификаторовПартий) - Массив - Перечень идентификторов объединяемых партий
unionResult (ОбъединитьПартии) - Булево - ;
Необязательный параметр. Значение по умолчанию: Истина
Пример пакета с сообщением convertToPrepack
[
{
"MsgType": "convertToPrepack",
"MsgID": 1,
"MsgData":
{
"id": "230f9da68-512a-11e9-9156-e0d55e22b782",
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "ПробирныеРаботы".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор операции пробирных работ, не обязательно, само заполнится;
duration (Срок) - Строка - Срок выполнения;
Необязательный параметр. Значение по умолчанию: "none";
Допустимые значения (см. описание типа с перечисляемыми значениями Срок):
deliveryDate (ДатаСдачиВФПП) - Дата - Дата сдачи в ФПП;
assayOfficeCode (КодМРУ) - Строка - Код МРУ: 0110¶0111¶0112¶0113¶0114¶0115¶0116¶0220¶0221¶0330¶0331¶0332¶0440¶0441¶0442¶0550¶0660¶0661¶0662¶0770¶0880¶0881¶0990¶0991¶0992¶0993¶;
assayBatchList (СписокПартийОпробования) - Массив -
comment (Комментарий) - Строка - ;
Пример пакета с сообщением hallmarking
[
{
"MsgType": "hallmarking",
"MsgID": 1,
"MsgData":
{
"id": ,
"deliveryDate": "20221125",
"assayOfficeCode": "0110",
"assayBatchList":
[
{
"batchID": "as30aa12-331zz23-zweq-2312",
"UIN": ,
"packed": "false",
"hasInserts": "true",
"hasLabeles": "false",
"otherAlloys": "false",
"combinedStamp": "false",
"chemical": "true",
"marking": "true",
"branding": "true"
}
],
"comment":
}
}
]
Наименование этого сообщения в журнале регистрации: "РегистрацияОтправкиПартий".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением registerSendBatch
[
{
"MsgType": "registerSendBatch",
"MsgID": 1,
"MsgData":
{
"id": ,
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "РегистрацияРеклассификацииКамней".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - ;
Необязательный параметр. Значение по умолчанию: ""
batchList (Партии) - Массив -
Пример пакета с сообщением registerGemstoneReclassification
[
{
"MsgType": "registerGemstoneReclassification",
"MsgID": 1,
"MsgData":
{
"batchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "РозничнаяПродажа".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор передаваемого отчета о розничных продажах;
date (ДатаОперации) - Дата - Дата операции продажи;
dept (Подразделение) - Строка - Идентификтор подразделения (counterparty id);
saleMethod (СпособПродажи) - Строка - Способ продажи;
Необязательный параметр. Значение по умолчанию: "ВМагазине";
Допустимые значения (см. описание типа с перечисляемыми значениями СпособыПродажи):
BatchList (СписокИдентификаторов) - Массив - Перечень продаваемых идентификаторов
UINList (СписокУИН) - Массив - Перечень продаваемых УИНов
return (Возврат) - Булево - Является возвратом товара;
Необязательный параметр. Значение по умолчанию: Ложь
autosend (Автоотправка) - Булево - Зарегистрировать рейс автоотправках;
Необязательный параметр. Значение по умолчанию: Ложь
Пример пакета с сообщением retailSell
[
{
"MsgType": "retailSell",
"MsgID": 1,
"MsgData":
{
"id": "2022/03/03/22",
"date": "20210101",
"dept": "1201600090504/166001001",
"BatchList":
[
{
"Batch": "id1230123",
"fiscalDocumentNumber": "3312",
"price":
}
],
"UINList":
[
{
"UIN": "6820332287120991",
"fiscalDocumentNumber": "332",
"price":
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "Скупка".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
Пример пакета с сообщением buyingUp
[
{
"MsgType": "buyingUp",
"MsgID": 1,
"MsgData":
{
"ticketID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"clientID": "230f9da68-512a-11e9-9156-e0d55e22b782",
"date": "20220901",
"ticketNumber": "АБ331212",
"cost": 17000,
"description": "Кольцо 1г, браслет 5г, АБ331212",
"items":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "Спецификация".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Идентификатор спецификации для обмена с Аскорт:Маркировкой;
specDate (ДатаСпецификации) - Дата - Дата спецификации;
shipper (Отправитель) - Строка - Идентификатор отправителя;
consignee (Получатель) - Строка - Идентификатор получателя;
amount (Сумма) - Число - Сумма по спецификации;
VATAmount (СуммаНДС) - Число - Сумма НДС;
priceType (ТипСтоимости) - Строка - Тип стоимости из перечня ГИИС;
Необязательный параметр. Значение по умолчанию: "P_CONTRACT"
batchCount (КоличествоПартий) - Число - // Служебное поле;
currency (Валюта) - Строка - Код валюты;
Необязательный параметр. Значение по умолчанию: "RUB"
contracts (Контракты) - Массив - Перечень контрактов спецификации
number (УчетныйНомер) - Строка - Номер в инфомрационной системе участника;
specificationState (СостояниеСпецификации) - Строка - // Служебное поле;
Необязательный параметр. Значение по умолчанию: "DS_SP_COMPLETE_SET";
Допустимые значения (см. описание типа с перечисляемыми значениями СтатусСпецификации):
giisNumber (НомерГИИС) - Строка - // Служебное поле;
Пример пакета с сообщением Specification
[
{
"MsgType": "Specification",
"MsgID": 1,
"MsgData":
{
"id": "6927861f-13eb-43f1-89c4-531cd2ed1249",
"specDate": "20220403",
"shipper": "614ca392-4d87-4d15-a8c5-4029e0cc020e",
"consignee": "13662c97-d1ef-4a3a-bf1c-675445a0cb5f",
"amount": 1222,
"VATAmount": 33,
"batchCount": ,
"contracts":
[
{
"contractID": "C-00-000001325-22"
}
],
"number": "АМ-0031233",
"giisNumber":
}
}
]
Наименование этого сообщения в журнале регистрации: "списаниеПартииВыбытие".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Можно передать для последующей перезаписи перечня списываемых партий;
writeOffReason (ПричинаСписания) - Строка - Указывается причина списания.;
Необязательный параметр. Значение по умолчанию: "Списание"
UINList (СписокУИН) - Массив - Перечений УИНов / ИНП к списанию
BatchList (СписокИдентификаторовПартий) - Массив - Перечень партий к списанию
Пример пакета с сообщением BatchRemoveDisposal
[
{
"MsgType": "BatchRemoveDisposal",
"MsgID": 1,
"MsgData":
{
"id": ,
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Наименование этого сообщения в журнале регистрации: "списаниеПартииОшибка".
Для сообщения определены следующие поля (в скобках представление для журнала регистрации):
id (Идентификатор) - Строка - Можно передать для последующей перезаписи перечня списываемых партий;
writeOffReason (ПричинаСписания) - Строка - Указывается причина списания.;
Необязательный параметр. Значение по умолчанию: "Списание"
UINList (СписокУИН) - Массив - Перечений УИНов / ИНП к списанию
BatchList (СписокИдентификаторовПартий) - Массив - Перечень партий к списанию
Пример пакета с сообщением batchRemoveMistake
[
{
"MsgType": "batchRemoveMistake",
"MsgID": 1,
"MsgData":
{
"id": ,
"UINList":
[
{
"UIN": "6432200152139957"
}
],
"BatchList":
[
{
"Batch": "id1230123"
}
]
}
}
]
Метод может быть вызван синхронно и асинхронно: соответственно через PUT методы syncCall и asyncCall. В случае асинхронного вызова результат выполнения метода может быть получен через GET метод getTaskStatus
В журнале регистрации метод имеет наименование: "ДоступнаФизическаяМаркировка".
Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/isMarkingAvailable"
Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/isMarkingAvailable"
Для метода не предусмотрены параметры.
В случае вызова для асинхронного запуска asyncCall/isMarkingAvailable возвращает результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата asyncCall/isMarkingAvailable:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
"taskStarted", "true" // Признак, что метод успешно стартовал
"declineReason", "" // Представление ошибки, в случае если метод не запущен
}
Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/isMarkingAvailable возвращают результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата метода isMarkingAvailable
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 0, // Количество объектов данных к обработке
"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
"dataDeclined": 2, // Количество объектов данных с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"Available": ,
"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}
В журнале регистрации метод имеет наименование: "ЗапроситьСпецификации".
Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getSpecs"
Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getSpecs"
Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):
Пример параметров метода getSpecs
{
"dateStart": ,
"dateEnd":
}
В случае вызова для асинхронного запуска asyncCall/getSpecs возвращает результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата asyncCall/getSpecs:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
"taskStarted", "true" // Признак, что метод успешно стартовал
"declineReason", "" // Представление ошибки, в случае если метод не запущен
}
Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getSpecs возвращают результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата метода getSpecs
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 0, // Количество объектов данных к обработке
"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
"dataDeclined": 2, // Количество объектов данных с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}
Получает результат рейса по его идентификатору. Результат метода контекстно зависим от рейса. Поддерживается: *
В журнале регистрации метод имеет наименование: "ПолучитьРезультатРейса".
Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getExchangeSessionResult"
Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getExchangeSessionResult"
Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):
Пример параметров метода getExchangeSessionResult
{
"sessionID":
}
В случае вызова для асинхронного запуска asyncCall/getExchangeSessionResult возвращает результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата asyncCall/getExchangeSessionResult:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
"taskStarted", "true" // Признак, что метод успешно стартовал
"declineReason", "" // Представление ошибки, в случае если метод не запущен
}
Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getExchangeSessionResult возвращают результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата метода getExchangeSessionResult
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 0, // Количество объектов данных к обработке
"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
"dataDeclined": 2, // Количество объектов данных с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"result": ,
"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}
В журнале регистрации метод имеет наименование: "ПолучитьСписокБилетов".
Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getTicketsIDs"
Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getTicketsIDs"
Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):
Пример параметров метода getTicketsIDs
{
"IDList":
[
{
"ID": "00123123123"
}
]
}
В случае вызова для асинхронного запуска asyncCall/getTicketsIDs возвращает результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата asyncCall/getTicketsIDs:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
"taskStarted", "true" // Признак, что метод успешно стартовал
"declineReason", "" // Представление ошибки, в случае если метод не запущен
}
Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getTicketsIDs возвращают результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата метода getTicketsIDs
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 0, // Количество объектов данных к обработке
"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
"dataDeclined": 2, // Количество объектов данных с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"ticketsList":
[
{
"TicketID": ,
"AssignedID":
}
]
"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}
В журнале регистрации метод имеет наименование: "ПолучитьСписокУИН".
Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getUINs"
Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getUINs"
Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):
Пример параметров метода getUINs
{
"IDList":
[
{
"ID": "00123123123"
}
]
}
В случае вызова для асинхронного запуска asyncCall/getUINs возвращает результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата asyncCall/getUINs:
{
"providerID": "ibd1", // Идентификатор поставщика данных
"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
"taskStarted", "true" // Признак, что метод успешно стартовал
"declineReason", "" // Представление ошибки, в случае если метод не запущен
}
Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getUINs возвращают результат со следующими полями (в скобках представление для журнала регистрации):
Пример результата метода getUINs
{
"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
"dataToProcess": 0, // Количество объектов данных к обработке
"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
"dataDeclined": 2, // Количество объектов данных с ошибками
"progress": 1, // Доля выполенных загрузок сообщений
"isError": "true", // Наличие ошибок во время выполнения
"startTime": "20200211150000", // Начало выполнения
"finishTime": "20200211150500", // Окончание выполнения
"errorMessage": "", // Представление сообщения об ошибке
"providerID": "ibd1", // Идентификатор поставщика данных
"UINList":
[
{
"ID": ,
"UIN":
}
]
"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}
В качестве значений некоторых полей сообщения обмена могут быть использованы строки с ограниченным списком возможных значений.
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения:
Допустимые значения: