Navbar

Уведомления

Лента уведомлений

Общие атрибуты уведомлений

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Только для чтения
description String(4096) Описание уведомления
Обязательное при ответе Только для чтения
id UUID ID Уведомления
Обязательное при ответе Только для чтения
meta Meta Метаданные объекта. Содержит тип конкретного уведомления
Обязательное при ответе
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Только для чтения

Получить ленту Уведомлений

Запрос на получение ленты Уведомлений. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Уведомления.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Уведомление

Получить Уведомление

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Удалить Уведомление

Запрос на удаление Уведомления. Возможно удаление только Уведомлений текущего пользователя.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Response 200 (application/json) Успешное удаление Уведомления.

Отметить Уведомление как прочитанное

Отметить конкретное уведомление, как прочитанное. Можно отмечать только Уведомления текущего пользователя.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Уведомления.

Response 200 (application/json) Успешное проставление признака "прочитано".

Отметить все Уведомления как прочитанные

Отметить все Уведомления текущего пользователя как прочитанные.

Response 200 (application/json) Успешное проставление признака "прочитано" всем непрочитанным Уведомлениям.

Типы уведомлений

Форматы полей

Формат измененного поля

Формат измененного поля содержит в себе старое и новое значение:

Название Тип Описание
oldValue String(255) Значение атрибута до удаления
Обязательное при ответе Только для чтения
newValue String(255) Значение атрибута после обновления
Обязательное при ответе Только для чтения

Формат oldValue и newValue совпадает с форматом поля, изменение которого отображается. Одно из полей может быть не заполнено.

Возможные значения типа экспорта

Возможные значения типа импорта

Сводная таблица типов уведомлений

Тип уведомления Группа О чем уведомление
FacebookTokenExpirationNotification Интернет-магазины О скором окончании действия доступа к аккаунту Facebook
NotificationExportCompleted Обмен данными Экспорт выполнен
NotificationGoodCountTooLow Остатки Снижение количества товара до неснижаемого остатка
NotificationImportCompleted Обмен данными Импорт выполнен
NotificationInvoiceOutOverdue Счет Просрочен счёт, который не оплатил или не полностью оплатил покупатель
NotificationOrderNew Заказ покупателя Новый заказа покупателя
NotificationOrderOverdue Заказ покупателя Просрочен заказ
NotificationRetailShiftClosed Розничная торговля Закрыта смена
NotificationRetailShiftOpened Розничная торговля Открыта смена
NotificationScript Сценарии Уведомление из сценария
NotificationSubscribeExpired Биллинг Окончание подписки
NotificationSubscribeTermsExpired Биллинг Истекают условия подписки
NotificationTaskAssigned Задача Задача назначена
NotificationTaskChanged Задача Задача поменялась
NotificationTaskCommentChanged Задача Комментарий у задачи был изменен
NotificationTaskCommentDeleted Задача Комментарий у задачи был удален
NotificationTaskCompleted Задача Задача выполнена
NotificationTaskDeleted Задача Задача удалена
NotificationTaskNewComment Задача У задачи появился новый комментарий
NotificationTaskOverdue Задача Задача просрочена
NotificationTaskReopened Задача Задача переоткрыта
NotificationTaskUnassigned Задача Задача снята
NotificationBonusMoney Баланс На счет зачислены бонусные деньги
NewMentionInEvent Упоминания сотрудников Новое упоминание в ленте событий

Подробное описание типов уведомлений

Завершение экспорта

Тип уведомления

NotificationExportCompleted - завершение экспорта

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
createdDocumentName String(255) Имя экспортированного документа
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
errorMessage String(255) Сообщение об ошибке
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
message String(255) Сообщение о завершении экспорта
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
taskState Object Статус завершения. Может принимать значения completed, interrupted, interrupted_by_user, interrupted_by_timeout, interrupted_by_system
Обязательное при ответе Необходимо при создании
taskType Object Тип экспорта
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 02950e3c-35f2-11e9-9ff4-34e8000799c0 id Уведомления.

Завершение импорта

Тип уведомления

NotificationImportCompleted - завершение импорта

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
createdDocumentName String(255) Имя экспортированного документа
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
errorMessage String(255) Сообщение об ошибке
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
message String(255) Сообщение о завершении экспорта
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
taskState Object Статус завершения. Может принимать значения completed, interrupted, interrupted_by_user, interrupted_by_timeout, interrupted_by_system
Обязательное при ответе Необходимо при создании
taskType Object Тип экспорта
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 02950e31-35f2-11e9-9ff4-34e8000799c0 id Уведомления.

Снижение остатка товара ниже неснижаемого

Тип уведомления

NotificationGoodCountTooLow - снижение остатка товара ниже неснижаемого

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
actualBalance Int Остаток товара
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
good Meta Метаданные товара
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
minimumBalance Int Неснижаемый остаток товара
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 9338c8bd-56e5-11e9-c0a8-100b00000023 id Уведомления.

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

Тип уведомления

NotificationInvoiceOutOverdue - просрочен счет покупателя

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
invoice Meta Метаданные счета
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
paymentPlannedMoment DateTime Запланированная дата оплаты
Обязательное при ответе
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 572d1dd9-56fc-11e9-c0a8-100b00000006 id Уведомления.

Новый заказ

Тип уведомления

NotificationOrderNew - новый заказ

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
*agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
deliveryPlannedMoment DateTime Планируемое время отгрузки
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
order Meta Метаданные заказа
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: c6082a9e-56e1-11e9-c0a8-100b00000011 id Уведомления.

Просроченный заказ

Тип уведомления

NotificationOrderOverdue - просроченный заказ

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
*agentName String(255) Имя контрагента
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
deliveryPlannedMoment DateTime Планируемое время отгрузки
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
order Meta Метаданные заказа
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
sum Int Сумма счета
Обязательное при ответе
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: c6082a9e-56e1-11e9-c0a8-100b00000011 id Уведомления.

Окончание подписки

Тип уведомления

NotificationSubscribeExpired - окончание подписки

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: c2582a9e-56e1-11e9-c0a8-100b00000123 id Уведомления.

Условия подписки истекают

Тип уведомления

NotificationSubscribeTermsExpired - условия подписки истекают

Атрибуты

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
daysLeft Int Количество оставшихся дней подписки
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: c2582a9e-56e1-11e9-c0a8-100b00000125 id Уведомления.

Задача назначена

Тип уведомления

NotificationTaskAssigned - задача назначена

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: bcd815b9-56ca-11e9-c0a8-100b00000001 id Уведомления.

Задача снята

Тип уведомления

NotificationTaskUnassigned - задача снята

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 80c8a58b-56cb-11e9-c0a8-100b00000009 id Уведомления.

Задача изменена

Тип уведомления

NotificationTaskChanged - задача изменена

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
diff Object Измененные поля Подробнее тут
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Измененные поля
Название Тип Описание
description String(255) Изменение описания задачи в формате изменения поля
Обязательное при ответе
deadline String(255) Изменение планируемой даты завершения задачи в формате изменения поля
Обязательное при ответе
agentLink String(255) Изменение контрагента в формате изменения поля
Обязательное при ответе
documentLink String(255) Изменение связанного документа в формате изменения поля
Обязательное при ответе
assignee String(255) Изменение исполнителя в формате изменения поля
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: bd0dbccf-56ca-11e9-c0a8-100b00000003 id Уведомления.

Задача выполнена

Тип уведомления

NotificationTaskCompleted - задача выполнена

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 7945a089-56fd-11e9-c0a8-100b00000008 id Уведомления.

Задача удалена

Тип уведомления

NotificationTaskDeleted - задача удалена

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 8d07388c-56cb-11e9-c0a8-100b0000000d id Уведомления.

Задача просрочена

Тип уведомления

NotificationTaskOverdue - задача просрочена

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 51a5b0a3-56e4-11e9-c0a8-100b00000014 id Уведомления.

Задача переоткрыта

Тип уведомления

NotificationTaskReopened - задача переоткрыта

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: df0c3e22-56fd-11e9-c0a8-100b0000000a id Уведомления.

Новый комментарий к задаче

Тип уведомления

NotificationTaskNewComment - новый комментарий к задаче

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 240706df-5704-11e9-c0a8-100b00000003 id Уведомления.

Изменен комментарий к задаче

Тип уведомления

NotificationTaskCommentChanged - изменен комментарий к задаче

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
diff String(255) Изменения комментария в формате изменения поля
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 3d3423ee-5704-11e9-c0a8-100b00000007 id Уведомления.

Удален комментарий к задаче

Тип уведомления

NotificationTaskCommentDeleted - удален комментарий к задаче

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
noteContent String(4096) Содержимое комментария
Обязательное при ответе Необходимо при создании
performedBy Object Сотрудник, выполнивший изменение. Подробнее тут
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
task Object Задача Подробнее тут
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Атрибуты вложенных сущностей

Сотрудник, выполнивший изменение
Название Тип Описание
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе
Задача
Название Тип Описание
deadline DateTime Планируемая дата завершения задачи
Обязательное при ответе
id UUID ID Уведомления
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
name String(255) Наименование Контрагента
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: 3d2abf0f-5704-11e9-c0a8-100b00000005 id Уведомления.

Смена открыта

Тип уведомления

NotificationRetailShiftOpened - смена открыта

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
retailShift Object Описание смены
Обязательное при ответе Необходимо при создании
retailStore Object Точка продаж
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании
user Object Сотрудник
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 8002409b-351d-11e9-9ff4-34e80002a126 id Уведомления.

Смена закрыта

Тип уведомления

NotificationRetailShiftClosed - смена закрыта

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
retailShift Object Описание смены
Обязательное при ответе Необходимо при создании
retailStore Object Точка продаж
Обязательное при ответе Необходимо при создании
returns Int Количество возвратов
Обязательное при ответе Необходимо при создании
sales Int Количество продаж
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании
user Object Сотрудник
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 3929d717-351c-11e9-9ff4-34e800029ad4 id Уведомления.

Уведомление из сценария

Тип уведомления

NotificationScript - уведомление из сценария

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Только для чтения
description String(255) Описание уведомления
Обязательное при ответе Только для чтения
entity Object Ссылка на объект сценария
Обязательное при ответе Только для чтения
eventType Событие Тип события сценария
Обязательное при ответе Только для чтения
id UUID ID Уведомления
Обязательное при ответе Только для чтения
meta Meta Метаданные объекта
Обязательное при ответе Только для чтения
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Только для чтения
title String(255) Краткий текст уведомления
Обязательное при ответе Только для чтения

Атрибуты вложенных сущностей

Событие

Тип события сценария. Возможные значения:

Объект

Объект, на который сработал сценарий.

Название Тип Описание
id UUID ID объекта
Обязательное при ответе Только для чтения
meta Meta Метаданные объекта
Обязательное при ответе Только для чтения
name String(255) Наименование объекта
Обязательное при ответе Только для чтения

Допустимые значения для meta.type:

Параметры

Параметр Описание
id string (required) Example: 3929d717-351c-11e9-9ff4-34e800029ad4 id Уведомления.

Предупреждение о скором окончании действия доступа к аккаунту Facebook

Тип уведомления

FacebookTokenExpirationNotification - предупреждение о скором окончании действия доступа к аккаунту Facebook

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
connectorName String(4096) Название коннектора "Instagram and Facebook"
Обязательное при ответе
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
daysLeftToExpiration Int Количество дней, оставшихся до окончания действия доступа к аккаунту Facebook
Обязательное при ответе
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 9596251d-da73-11eb-ac12-000c00000015 id Уведомления.

На счет зачислены бонусные деньги

Тип уведомления

NotificationBonusMoney - На счет зачислены бонусные деньги

Атрибуты уведомления

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Необходимо при создании
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Необходимо при создании
description String(4096) Описание уведомления
Обязательное при ответе Необходимо при создании
id UUID ID Уведомления
Обязательное при ответе Необходимо при создании
meta Meta Метаданные объекта
Обязательное при ответе Необходимо при создании
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Необходимо при создании
title String(255) Краткий текст уведомления
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: c2582a9e-56e1-11e9-c0a8-100b00000123 id Уведомления.

Новое упоминание в ленте событий

Тип уведомления

NewMentionInEvent - уведомление о новом упоминании в ленте событий

Атрибуты уведомления

Название Тип Описание
meta Meta Метаданные объекта
Обязательное при ответе Только для чтения
id UUID ID Уведомления
Обязательное при ответе Только для чтения
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Дата и время формирования Уведомления
Обязательное при ответе Только для чтения
read Boolean Признак того, было ли Уведомление прочитано
Обязательное при ответе Только для чтения
title String(255) Краткий текст уведомления
Обязательное при ответе Только для чтения
description String(4096) Описание уведомления
Обязательное при ответе Только для чтения
operation Object Объект, в ленте которого было добавлено событие с упоминанием
Обязательное при ответе Только для чтения

Атрибуты вложенных сущностей

Объект

Объект, в ленте которого добавили событие с упоминанием.

Название Тип Описание
meta Meta Метаданные объекта
Обязательное при ответе Только для чтения
id UUID ID объекта
Обязательное при ответе Только для чтения
name String(255) Наименование объекта
Обязательное при ответе Только для чтения

Допустимые значения для meta.type:

Параметры

Параметр Описание
id string (required) Example: c290e571-f65d-11ee-c0a8-300d0000000a id Уведомления.

Настройки уведомлений

Атрибуты сущности

Значения кода группы уведомлений.

Код группы уведомлений Описание
customer_order Заказы покупателей
data_exchange Обмен данными
invoice Счета покупателей
retail Розничная торговля
scripts Сценарии
stock Складские остатки
task Задачи
mentions Упоминания сотрудников

Получить настройки уведомлений

Запрос настроек Уведомлений текущего пользователя.

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

Изменение настроек Уведомлений текущего пользователя.

Отключение уведомлений из сценариев недопустимо. Параметр enabled игнорируется.

Response 200 (application/json) Успешное изменение настроек уведомлений.