Задать вопрос
ЛК HEADO
Личный кабинет HEADO
ЛК HEADO
Личный кабинет HEADO
https://partner.heado.ru/
Торговая система
Общее название программного обеспечения используемого на торговом предприятии которое интегрируется с сервисом HEADO.
Список готовых решений
Аккаунт HEADO
Клиентская учетная запись в сервисе HEADO в которой группируются все сущности. Для администрирования аккаунта предназначен ЛК HEADO
Торговая сеть
Торговая сеть - группировка для Торговых точек в аккаунте HEADO
Торговая точка
Одно и более устройств, сгруппированных в торговую точку по внутреннему или внешним идентификатору (store_ext_id) торговых точек торговой системы
Устройство
Закрепленный за торговой точкой виртуальный терминал, созданный в ЛК HEADO для идентификации устройств (кассы, сервера и т.п.) торгового предприятия и их взаимодействия с API HEADO.
Товар, номенклатурная позиция
Элемент справочника номенклатуры, содержащий следующие атрибуты:
name - название товара;
extid - уникальный «Внешний идентификатор товара» из справочника торговой системы предприятия, состоящий из цифр или латинских букв. Обязательно должен соответствовать внешнему уникальному идентификатору получаемого из чека;
category - массив меток, включающий метки иерархической структуры категорий/подкатегорий товара и дополнительные метки;
vat - ставка НДС в процентах (например 20.00 для 20%);
price - цена продажи за единицу.
Категории, метки, теги
Предназначены для разметки элементов справочника номенклатуры следующими атрибутами:
  • категории, подкатегории - иерархия в соответствии с принятой в управленческом учете клиента, от головной категории к подчиненным подкатегориям
  • метки - служебные метки, для идентификации в специальных дисциплинах HEADO
  • теги - определяются свободно, позволяют сделать разметку для настройки показателей, в дополнение к категориям
Ассортиментная матрица
Для каждой торговой точки существует список номенклатурных позиций, которые в соответствии со стандартами торговой сети должны обязательно присутствовать на полке в торговой точки.
HEADO регистрирует вхождение номенклатурной позиции в ассортиментную матрицу торговой точки с помощью атрибута запаса in_matrix
Запас
Сведения о состоянии запаса номенклатурной позиции в торговой точке
extid
Внешний идентификатор (<название сущности>)
Для торговой системы, состоящей из нескольких компонентов, например Front office, Back office, внесистемных справочников единство идентификаторов должно быть обеспечено на стороне торговой системы или средствами интеграции.
auth_key
Уникальный ключ авторизации устройства для взаимодействия с API HEADO и установки ПО HEADO.
cashbox_id
Уникальный «внутренний идентификатор устройства» в ЛК HEADO.
store_ext_id
Уникальный «Внешний идентификатор торговой точки» из торговой системы предприятия, состоящий из латинских букв или цифр
price_ext_id
Уникальный «Внешний идентификатор товара» из справочника торговой системы предприятия, состоящий из цифр или латинских букв.
Как интегрировать торговую систему
Перед началом
Решите - какие решения HEADO будут использоваться? Необходимые решения определяют набор данных, которые потребуется загружать в облачный сервис HEADO. Посмотрите каталог решений HEADO.
Если у Вас еще нет аккаунта HEADO, зарегистрируйте его. При регистрации будет предоставлен доступ к личному кабинету сервиса, который предоставляет возможность выполнить необходимые для интеграции настройки.
ВАЖНО: Интеграция зависит от возможностей используемой торговой системы. Мы рекомендуем передать задачу по интеграции ИТ-специалистам, т.к. могут потребоваться специальные навыки. В любой ситуации обращайтесь за поддержкой.
Данные для загрузки
Набор загружаемых в сервис HEADO данных и требования к реализации зависят от используемых решений HEADO. Источниками данных являются компоненты торговой системы. Ниже приведены типичная схема потоков данных и списки требуемых для загрузки данных, включающие требования к ним и инструкции по интеграции.
Схема потоков данных
Интеграция
В соответствии с инструкцией выполните:
  • настройки в личном кабинете HEADO,
  • настройки торговой системы,
  • установку и настройку интеграционных компонентов,
  • сверку данных в HEADO c данными торговой системы
Термины и определения
ТЕРМИНОПРЕДЕЛЕНИЕ
ЛК HEADO Личный кабинет HEADO доступный по адресу https://partner.heado.ru, предназначенный для доступа к информации в аккаунте HEADO и настройки его конфигурации
Торговая система

Общее название программного обеспечения используемого на торговом предприятии которое интегрируется с сервисом HEADO.
Для интеграции с HEADO важны следующие компоненты:

  • Front office - кассовое программное обеспечение, как правило является источником для передачи оперативных продаж - чеков;
  • Back office - товароучетная система (ERP система), как правило является источником для передачи справочников, запасов, товародвижения, планов
  • Внесистемные справочники и таблицы фактов (excel и.т.п.), могут являться источником для передачи справочников и планов.
Аккаунт HEADO

Клиентская учетная запись в сервисе HEADO в которой группируются все сущности. Для администрирования аккаунта предназначен ЛК HEADO и специальные методы API HEADO
Аккаунт может включать несколько торговых сетей. В большинстве случаев клиент не делит аккаунт на несколько торговых сетей, в таком случае он состоит из одной торговой сети "по умолчанию".
Атрибуты аккаунта:

  • name - Название аккаунта
  • login - Логин, используется для входа в ЛК HEADO с правами администратора (root).
Торговая сеть

Торговая сеть - группировка для Торговых точек, содержит следующие атрибуты:

  • city - город, в котором расположен центральный офис сети;
  • network_id (также shopId) - внутренний идентификатор сети (доступен в ЛК HEADO);
  • network_ext_id - внешний идентификатор Торговой сети в торговой системe.
Торговая точка

Одно и более устройств, сгруппированных в торговую точку по внутреннему или внешним идентификатору (store_ext_id) торговых точек из торговой системы и содержат следующие атрибуты:

  • country - Название страны по КЛАДР или ФИАС;
  • city - Название города по КЛАДР или ФИАС;
  • street - Название улицы по КЛАДР или ФИАС;
  • house - Дом, включая корпуса, литеры и т.п. (например 10/1а);
  • store_ext_id - Уникальный «Внешний идентификатор торговой точки» из торговой системы предприятия, состоящий из латинских букв или цифр;
  • name - Название торговой точки
Устройство

Закрепленный за торговой точкой виртуальный терминал, созданный в ЛК HEADO для идентификации устройств (кассы, сервера и т.п.) торгового предприятия и их взаимодействия с API HEADO.

Устройство (терминал) содержит следующие атрибуты: тип, auth_key, cashbox_id, extid.

Существует 2 типа устройств (терминалов):

  • ККМ-сервис 2.0 (по умолчанию) - используется для взаимодействия с Device API и для установки ПО HEADO на рабочее место торгового предприятия для отображения показателей;
  • Административный терминал - специальный тип, используется для взаимодействия с Management API.
Товар, номенклатурная позиция

Элемент справочника номенклатуры, содержащий следующие атрибуты:

  • name - название товара;
  • extid - уникальный «Внешний идентификатор товара» из справочника торговой системы предприятия, состоящий из цифр или латинских букв. Обязательно должен соответствовать внешнему уникальному идентификатору получаемого из чека;
  • category - массив меток, включающий метки иерархической структуры категорий/подкатегорий товара и дополнительные метки;
  • vat - ставка НДС в процентах (например 20.00 для 20%);
  • price - цена продажи за единицу.
Категории, метки, теги

Предназначены для разметки элементов справочника номенклатуры следующими атрибутами:

  • категории, подкатегории - иерархия в соответствии с принятой в управленческом учете клиента, от головной категории к подчиненным подкатегориям, например:
"Продовольственные товары", "Молочная продукция", "Сметана", и.т.д.
  • метки - служебные метки, для идентификации в специальных дисциплинах HEADO, например:
"monitor/*"
  • теги - определяются свободно, позволяют сделать разметку для настройки показателей, в дополнение к категориям, например:
"Прикассовая зона", "Собственная торговая марка"
Ассортиментная матрица

Для каждой торговой точки существует список номенклатурных позиций, которые в соответствии со стандартами торговой сети должны обязательно присутствовать на полке в торговой точки.

HEADO регистрирует вхождение номенклатурной позиции в ассортиментную матрицу торговой точки с помощью атрибута запаса in_matrix

Запас

Сведения о состоянии запаса номенклатурной позиции в торговой точке, регистрируемое следующими атрибутами:

  • snapshot_datetime - момент времени, на который актуальны значения атрибутов запаса
  • in_matrix - признак вхождения номенклатурной позиции в ассортиментную матрицу торговой точки;
  • qty - объем запаса номенклатурной позиции в единицах учета;
  • purchase_price - цена продажи в торговой точке за единицу
  • prime_cost - себестоимость номенклатурной позиции без НДС за единицу, определяется как средневзвешенная цена <стоимость всего запаса> деленная на , очищенная от косвенных налогов (НДС, VAT).

Важно! В аккаунте HEADO сведения о запасах ассоциируются с торговой точкой, определяемой по store_ext_id. Если в торговой системe учет товарных запасов ведется на нескольких складах/местах хранения, то запасы должны быть агрегированы в торговую точку, с соответствующим store_ext_id.

extid

Внешний идентификатор сущности - сквозной идентификатор в торговой системe

Важно! Для торговой системы, состоящей из нескольких компонентов, например Front office, Back office, внесистемных справочников единство идентификаторов должно быть обеспечено на стороне торговой системы или средствами интеграции.

Далее в документации ссылки приведены в формате extid(<название сущности>).

Для некоторых сущностей существуют принятые термины внешних идентификаторов, например store_ext_id.

auth_key

Уникальный ключ авторизации устройства для взаимодействия с API HEADO и установки ПО HEADO.

cashbox_id

Уникальный «внутренний идентификатор устройства» в ЛК HEADO.

store_ext_id

Уникальный «Внешний идентификатор торговой точки» из торговой системы предприятия, состоящий из латинских букв или цифр

price_ext_id

Уникальный «Внешний идентификатор товара» из справочника торговой системы предприятия, состоящий из цифр или латинских букв.

Инструкции по интеграции
В данном разделе приведены инструкции по интеграциям, требуемым для использования решений HEADO.
ВАЖНО: Разные компоненты торговой системы, являющиеся источниками данных для разных потоков данных, реализуемых при интеграции могут использовать разные идентификаторы. Важно обеспечить на передающей стороне единство идентификаторов.
Пример: часто встречается ситуация, когда кассовая система (front-office) и товароучетная система (back-office) используют разные идентификаторы для торговых точек.
Загрузка оперативных продаж
Назначение: Загрузка оперативных продаж является обязательной для любого решения HEADO.
Требования к источнику данных
Для данных оперативных продаж следует использовать источники с минимальной задержкой относительно времени первичной регистрации продажи (чека, транзакции). Глубина данных не критична, но должна быть достаточной для гарантированной отправки данных в сервис HEADO с учетом возможных перерывов связи с сервисом. Лучшим решением будет использование источника кассовой системы - front office в составе торговой системы. В случае использования в качестве источника данных промежуточных серверов (сервер торговой точки) необходимо убедиться, что задержка при доставке данных до такого источника не превышает 15 минут.
ВАЖНО: Данные должны быть одинаково представлены (тип данных, маски, форматы значений) в компонентах Торговой системы использующихся в качестве источников для оперативных продаж и исторических данных..
Бизнес-логика Сервиса HEADO предполагает точные сведения о времени регистрации чеков. Системное время компонентов торговой системы должно быть синхронизировано по одному из доступных эталонов. Критичной для аналитических функций Сервиса HEADO будет несинхронность системных часов между компонентами торговой системы более чем на одну минуту.
ВАЖНО: HEADO определяет часовой пояс торговой точки по метке времени в формате ISO-8601 (YYYY-MM-DDThh:mm:ss±hh:mm). Необходимо обязательно передавать метку времени регистрации чека с корректным смещением ±hh от UTC, соответствующим временному поясу торговой точки.
Важным параметром, используемым в логике сервиса HEADO, является уникальный «Внешний идентификатор чека». Если в торговой системе уникальный внешний идентификатор чека отсутствует, то рекомендуем использовать в качестве его маски комбинацию из следующих идентификаторов:
ВАЖНО: Способ формирования внешнего идентификатора (чека) должен гарантировать его уникальность хотя бы в пределах одной торговой сети и не превышать 40 символов..
Готовые решения по выгрузке продаж
У нас есть готовые интеграции для распространенных торговых/кассовых систем:
Вашей торговой системы нет в списке?
Команда HEADO работает над реализацией готовых интеграционных решений, возможно такое решение для вашей торговой системы уже находится в разработке, свяжитесь с нами, чтобы получить консультацию.
Также можно интегрировать с сервисом HEADO торговую систему при наличии в ней стандартных интеграционных возможностей используя API HEADO, следуйте приведенной ниже инструкции для интеграции с использованием API HEADO .

Интеграция с использованием API HEADO
Требования к организации процесса извлечения и передачи данных:
  • Отправка данных должна производиться непосредственно после завершения транзакции (печати чека);
  • Повторная отправка данных по одному чеку должна быть исключена;
  • Отмененные (удаленные из чека) до регистрации чека позиции не должны попадать в данные о чеке;
  • Сумма по позициям чека и общая сумма чека должны совпадать;
  • Сумма чека и суммы по позициям должны учитывать примененные скидки (Суммы передаются с учетом всех скидок);
  • Общая скидка на чек и скидка на позицию передаются отдельными параметрами чека и корзины.
ВАЖНО: В случае, если источник данных о чеках в торговой системе не содержит сведений о наименованиях товара и полную иерархию категорий необходимо реализовать дополнительный поток данных для загрузки и обновления справочника номенклатуры - см. Management API метод priceUpdateBatch.
Требуется реализовать обработку следующих событий:
Регистрация продажи
Для регистрации продажи/возврата выполняется одним из способов (до 100 чеков в запросе):
  • запрос к Device API с использованием метода purchaseRegisterBatch (используются auth_key привязанные к торговым точкам)
  • запрос к Management API с использованием метода receipt.processBatch (используется один auth_key, обязательно передавать параметры @store_ext_id/extid)
Важно: Для торговых систем с предзаказом количества товара (продукта) необходимо передавать фактически отпущенное количество, зарегистрированное в чеке продажи.
Регистрация возврата
Для регистрации возврата чека и возврата позиции применяется тот же метод, который используется для регистрации чеков продажи с учетом следующих важных особенностей:
  • При полном возврате, уникальный «Внешний идентификатор чека», передаваемый в запросе должен соответствовать чеку продажи по которому производится возврат.
ВАЖНО: При частичном возврате или в случае, если регламенты оператора торговой системы допускают проведение чеков возврата, без привязки к чеку продажи в качестве уникального «внешнего идентификатора чека» и параметров такого чека произвольного возврата необходимо применять данные самого чека произвольного возврата.
  • Все параметры и атрибуты чека возврата, включая позиции чека (корзины) должны формироваться по данным чека продажи.
  • Итоговая сумма по чеку должна быть отрицательной (<0).
  • Значения атрибутов чека должны быть отрицательными (<0).
Регистрация чеков коррекции
Чеки коррекции регистрируются в сервисе HEADO способами, аналогичными для чеков продажи и чеков возврата. Параметры и атрибуты чеков, отсутствующие в случае регистрации чеков коррекции не передаются (остаются пустыми).
Сверка данных сервиса HEADO с торговой системой
Рекомендованный порядок сверки описан по ссылке https://support.heado.ru/manuals/compare
ВАЖНО: HEADO группирует продажи по календарным дням. Необходимо учитывать данную особенность при отладке функции загрузки оперативных продаж, так как в некоторых торговых системах данные о продажах группируются по сменам.
Для отладки загрузки оперативных продаж и локализации ошибок загрузки данных необходимо использовать отчеты по продажам с группировкой по календарным дням, либо производить сверку по специальным выгрузкам с группировкой по календарным дням. Пример по ссылке: https://partner.heado.ru/files/media/Mag58PurchasePositions61080064732179.xlsx
Загрузка внешнего справочника товаров
ВАЖНО: Рекомендуем выполнять загрузку справочника ежедневно по расписанию, либо по расписанию в соответствии с изменением номенклатуры, но не реже одного раза в неделю.
Требования к источнику данных справочника товаров
Для корректной работы аналитики HEADO справочник товаров торговой системы должен содержать иерархическую информацию о категориях товара (категории, подкатегории). Максимальная длина всех категорий товара не должна превышать 2000 символов и 200 символов каждой из них.
Имена категорий и подкатегорий, которые будут использоваться в фильтрах для настройки показателей (KPI) должны быть уникальными.
ВАЖНО: В случае, если при настройке фильтров по категориям товаров в показателях (KPI) будет выявлено дублирование имен категорий (подкатегорий) необходимо переименовать одну из конфликтующих категорий (подкатегорий) товаров.
Для реализации показателей (KPI) по спискам товаров справочник товаров, торговая система должны поддерживать дополнительные метки товаров и иметь средства управления ими. В составе продаж (чеков) в HEADO должна передаваться информация о товарах, стандартизованная как минимум в пределах торговой сети:
  • код товара (артикул) - уникальный идентификатор товара;
  • наименование товара;
  • иерархия категорий товара и дополнительные текстовые метки (например название акции в которой участвует товар).
Наименования товаров, категории товара и метки следует передавать соответствующими полями и атрибутами чека при реализации функций.
ВАЖНО: В случае, если торговая система не поддерживает в полном объеме необходимые для формирования показателей HEADO категории или метки товаров (или требуемая параметризация и актуальность не поддерживается по иным причинам), существует возможность загрузки в HEADO внешнего справочника товаров, дополненного (относительно справочника торговой системы) необходимыми параметрами товара (категории, метки). В таком случае требуется определить дополнительный источник информации для таких данных. Связность с чеками обеспечивается по уникальному идентификатору товара (должен совпадать с идентификатором товара получаемого из чека).
Варианты реализации
  • Передача в составе позиции чека
Транспорт оперативных продаж позволяет передавать сведения из справочника товаров в составе позиции чека. Сервис HEADO формирует внутренний справочник номенклатуры из истории продаж.
ВАЖНО: Данный способ не подходит для решений, где требуется информация о товаре до начала его продаж. В таком случае обязательной является централизованная загрузка справочника товаров, описанная ниже. В описании набора данных для таких решений есть необходимые указания.
  • Выгрузка в промежуточный файл CSV
Описание способа загрузки и требования к CSV формату, доступно по ссылке
В Management API используйте 2 метода: priceUpdateBatch(items); и priceCategoryReset();
Загрузка истории продаж
Назначение: Загрузка истории продаж требуется для быстрого старта, при наличии истории продаж HEADO сможет сразу выполнить профилирование продаж, необходимое для большинства полезных функций HEADO.
Требования к источнику данных для загрузки истории продаж
Для исторических данных продаж за указанный период действуют требования, предъявляемые к данным оперативных продаж.
Дополнительным требованием является достаточная глубина архива (до 1 года).
Важным показателем качества исторических данных являются однородность данных (отсутствие в загружаемом периоде влияния внешних факторов, влияющих на показатели торговой точки – смена формата, ремонт, временный простой).
Источник исторических данных должен обладать нагрузочной способностью, достаточной для обработки таких объемов данных без деградации для основных функций. Лучшим решением будет использование специализированных хранилищ в составе торговой системы.
Варианты реализации
Для однократной загрузки небольшого объема данных, можно сформировать файл с продажами в формате CSV, который описан в инструкции и загрузить его с помощью ПО HEADO.
Для загрузки в сервис HEADO больших объемов исторических данных, целесообразно разработать утилиту, реализующую транспорт чеков из хранилища торговой системы в API HEADO, способом, аналогичным транспорту оперативных данных.
ВАЖНО: Загрузка больших объемов исторических данных в сервис HEADO возможна в часы наименьшей нагрузки с 23:00 до 07:00 по московскому времени (UTC+03:00).
Для автоматизации выгрузки целесообразно в утилите выгрузки исторических данных предусмотреть настройку заданий для выгрузки и выполнение заданий по расписанию – в часы наименьшей загрузки.
ВАЖНО: В случае, если источник исторических данных содержит наименования товаров и категорий отличающиеся от источника данных оперативных продаж (компоненты разных разработчиков) рекомендуем реализовать дополнительный поток данных для загрузки и обновления справочника номенклатуры - см. Management API метод priceUpdateBatch
При формировании задания необходимо предусмотреть выбор торговой точки, устройства и периода выгрузки.
ВАЖНО: Период выгрузки должен быть кратен одному календарному месяцу. В случае, если выгружаются данные за несколько периодов, не должно быть разрывов между ними, последний по хронологии период должен заканчиваться датой, после которой в сервисе HEADO существуют оперативные данные.
Автоматизация добавления торговых точек и устройств в сервис HEADO
Назначение: Автоматическое добавление торговых точек и устройств в сервис HEADO требуется для упрощения администрирования и для оперативного развертывания при большом количестве торговых точек и устройств. Наибольший эффект автоматизации возможен при наличии в торговой системе функций централизованного управления конфигурацией торговой сети.
Описание процесса добавления и требования к организации
Перед добавлением торговых точек и устройств торговой системы в сервис HEADO необходимо выполнить следующие процедуры в торговой системе:
ВАЖНО: HEADO обеспечивает автоматическую регистрацию новых устройств торговой точки торговой сети в аккаунте HEADO. Для этого при передаче данных продаж (чеков) должны передаваться оба параметра: store_ext_id и extid (устройства).
Для случае, когда источником данных продаж (чеков) является сервер торговой точки (передает продажи со всех устройств торговой точки) или сервер группы торговых точек (передает продажи со всех устройств всех торговых точек группы) достаточно зарегистрировать по одному устройству на каждую торговую точку. Полученные auth_key при регистрации таких устройств в дальнейшем должны использоваться для взаимодействия с API HEADO.
ВАЖНО: Для регистрации устройства, предназначенного для передачи данных о продажах (сервер торговой точки или сервер группы торговых точек), достаточно при регистрации передать идентификатор торговой точки store_ext_id, а extid (устройства) можно не передавать, оставив "значение" пустым.
В случае, если источником данных о продажах является непосредственно устройство, то регистрации подлежат все активные устройства торговых точек, выбранных оператором при настройке торговой системы.
Зарегистрированные сервисом HEADO устройства группируются по идентификаторам торговых точек store_ext_id.
ВАЖНО: При автоматизированной регистрации нескольких устройств одной торговой точки необходимо гарантированно обеспечить одинаковые значения всех параметров устройств (кроме extid), относящихся к данной торговой точке.
Повторная регистрация устройств в сервисе HEADO должна быть исключена.
При успешной регистрации устройств, сервис возвращает внутренний идентификатор устройства (cashbox_id) и ключ устройства (auth_key);
Полученные в результате добавления устройств ключи (auth_key), необходимо передать средствами торговой системы на узлы (компоненты), с которых будет выполняться взаимодействие с сервисом HEADO (передача оперативных и исторических данных, загрузка справочника товаров, получение отчетов и.т.д.).
ВАЖНО: Удаление устройств и торговых точек не доступно через API, возможно только в личном кабинете HEADO с правами администратора.
Ниже приведена общая схема процесса добавления торговых точек/устройств в HEADO и получение auth_key зарегистрированных устройств для дальнейшего взаимодействия с API HEADO. Полученные auth_key также возможно использовать при установке ПО HEADO для отображения показателе по торговых точек.
Добавление торговой точки/устройства
Для добавления торговой точки/устройства выполняется запрос к Management API используя метод setCashbox и ключ доступа (auth_key) от устройства с типом терминала: "Административный терминал".
ВАЖНО: Ключ доступа (auth_key) от устройства с типом терминала: "Административный терминал" можно получить в ЛК HEADO или через администратора сервиса HEADO после регистрации личного кабинета торговой сети и должен быть сохранен на компоненте торговой системы, выполняющей функции централизованного управления конфигурацией торговой сети.
Запрещается сохранять ключ доступа (auth_key) от устройства специального типа терминала: "Административный терминал" на других компонентах торговой системы (сервер магазина, устройства).
Загрузка информации о запасах
Информация о запасах включает: остаток, его себестоимость и признак вхождения товара в ассортиментную матрицу торговой точки.
Для передачи данных используйте API HEADO, метод inventoryUpdateBatch.
В качестве источника данных выступает как правило back-office компонент торговой системы.
При необходимости с помощью inventoryUpdateBatch вы можете реализовать два отдельных потока:
  • для передачи информации о запасах: атрибуты qty и prime_cost;
  • для передачи признака вхождения товара в ассортиментную матрицу торговой точки: атрибут in_matrix.
ВАЖНО:
- Рекомендуем обновлять информацию о запасах не реже одного раза в сутки, например передавать остатки на конец завершенного рабочего дня.
- Первая выгрузка остатков, должна выполняться полностью по действующей номенклатуре, а каждая последующая только по номенклатуре, где произошли изменения.
- Рекомендуем реализовать выгрузку номенклатурного справочника, так как при отсутствии товара в системе HEADO, то остатки по ней не будут обновлены.
- После реализации задачи, обязательно выполняется сверка по остаткам товаров.
Загрузка событий товародвижения
События товародвижения фиксируют изменения запасов в торговой точке, возникающие в результате проведения в торговой системе документов движения товара на торговой точке.
Для передачи данных используйте API HEADO, метод storeRegisterEvent().
В качестве источника данных выступает как правило back-office компонент торговой системы.
Передаваемое событие сопоставляется с документами товародвижения, изменяющими количество доступного к реализации запаса в торговой точке:
  • Списание товара (sku/writeoff) - документ списания.
  • Перемещение товара (sku/move) - документ перемещения, соответствующий убытию товара с торговой точки.
  • Приход товара (sku/income) - приходный документ от поставщика.
  • Возврат товара (sku/return) - документ возврата поставщику.
ВАЖНО: Cобытия товародвижения должны передаваться с минимальной задержкой, в сложных случаях - не позднее конца рабочего дня возникновения.
Информация о маркетинговых акциях
Маркетинговые акции регистрируются в HEADO через показатели (KPI) с ограниченным сроком действия - устанавливается начало действия акции (показатель начнет работать с начала указанных суток) и окончание (показатель прекратит действие по окончанию указанных суток).
Регистрация показателя выполняется через API HEADO, метод KPIAdd.
Для акций используйте следующие параметры:
  • name - Название показателя, по названию маркетинговой акции;
  • type - Если требуется отображение показателя в интерфейсе HEADO выберите из списка, возвращаемого методом KPITypes. Если отображение не требуется, можно не задавать, по умолчанию будет установлено значение "SUM";
  • order - Порядок сортировки, выберите место показателя в интерфейсе HEADO в соответствии с важностью акционного показателя относительно постоянных;
  • status: Статус, установите значение 1 (включен);
  • showOnDevices: Отображение показателя: выберите true - отображать, если требуется отображение показателя с выбранным type в интерфейсе пользователя на устройствах, false - не отображать, параметр не влияет на работу электронного директора;
  • zone: Зона привязки: выберите в соответствии с областью действия маркетинговой акции;
  • workPeriod: Период акции, установите начало и окончание, показатель начинает действовать с начала суток начала и заканчивает действие по окончанию суток окончания.
  • filters: Настройте номенклатурной позиции, которые будут участвовать в акции;
  • sku_monitor_control: включите, если настроен "Контроль выкладки ТОП товаров".
ВАЖНО: Параметры status, zone, workPeriod, filters являются критически важными для работы электронного директора.
В качестве источника данных выступает как правило back-office компонент торговой системы либо специальный компонент торговой системы в котором ведется планирование акций.
ВАЖНО: Рекомендуем передавать информацию о маркетинговых акциях непосредственно после ее утверждения. Для поддержки сценариев электронного директора, связанных с контролем подготовки к проведению акции критичной является загрузка акции в HEADO не позднее чем за 3 дня до ее старта. Возможные корректировки акции после загрузки в HEADO можно учесть с помощью метода KPIUpdate.
После окончания акции и выхода показателя в архивный статус его можно удалить с помощью метода KPIDelete, список зарегистрированных показателей можно получить методом KPIList
Отображение KPI на рабочем месте кассира (продавца)
Назначение: Оперативное доведение достигнутых показателей до персонала на всех уровнях является важной задачей сервиса HEADO. Штатным и проверенным временем способом является установка на рабочие места персонала ПО «HEADO» для всех версий операционной системы Windows, которое отображает показатели HEADO в графическом интерфейсе.
Инструкция, в которой описан графический интерфейс, доступна по ссылке
В случае, если отдельные рабочие места торговой системы, работают на отличной от Windows операционной системе или имеют специфический дизайн, ориентированный на дисплеи небольшого физического размера, на которых графический интерфейс ПО «HEADO» будет конфликтовать с основным интерфейсом оператора (кассира), рекомендуем реализовать для таких рабочих мест адаптированное к пользовательскому интерфейсу оператора (кассира) отображение показателей HEADO.
Способ получения данных для отображения
Для получения показателей (отчетов) по торговой точке выполняется запрос Device API метод reports.
ВАЖНО: Ответ API HEADO на запрос с использованием метода reports предоставляет набор показателей торговой точки к которой относится используемых ключ (auth_key) устройства. Для всех устройств торговой точки набор показателей одинаковый и определяется настройками в ЛК HEADO.
В случае автоматизированного добавления торговых точек и устройств в сервис HEADO для получения показателей рекомендуем использовать один ключ auth_key привязанный к торговой точке, получаемый при регистрации торговой точки. Исключением будет являться случай, когда данные о продажах передаются с использованием ключа auth_key сервера группы торговых точек предприятия.
Сигнал открытия/закрытия торговой точки
ВАЖНО: Для корректного работы данного сервиса, необходимо соблюдение двух условий:
- сигнал должен быть отправлены сразу при наступлении соответствующего события на торговой точке.
- необходимо установить расписание работы торговых точек (в настройках ЛК HEADO или через Management API метод storeSchedule)
Для отслеживания своевременного открытия и закрытия торговой точки, необходимо определить источник в торговой системе и событие на которое будет отправляться сигнал об открытии/закрытии торговой точки.
Рекомендуемые варианты реализации:
  • Реализация через Management API используя метод storeRegisterEvent. Торговая система самостоятельно определяет время открытия и закрытия торговой точки и сразу его отправляет при наступлении соответствующего события. Данный вариант реализации рекомендуется, при наличии централизованного источника данных (например кассовый сервер торговой точки) для определения точного времени передаваемых в сигналах открытия/закрытия по имеющимся в торговой системе данных. Время открытия торговой точки определяется торговой системой по времени открытия самой первой смены кассира из всех касс торговой точки за текущий день. Время закрытия торговой точки определяется торговой системой по времени снятия последнего Z отчета среди всех касс торговой точки по которым были открыты смены.
  • Реализация через Device API используя метод regısterEvent. Торговая система при наступлении соответствующего события на каждой кассе, сразу отправляет сигнал с использованием auth_key кассы на котором произошло событие. В сигнале открытия, необходимо указывать время открытия смены кассира. В сигнале закрытия, необходимо указывать время снятия Z отчета на кассе за текущий день. При данном варианте реализации, система HEADO зафиксирует время (не корректируется при получении сигналов с другим временем) первого полученного сигнала открытия и самостоятельно определит время закрытия торговой точки (как только кол-во сигналов открытия и закрытия будут совпадать, последний сигнал закрытия будет
    считаться что торговую точку закрыли).
Счетчики посетителей
Для отслеживания количества посетителей и возможности выводить конверсию покупателей, сервисом HEADO предусмотрено получение данных по количеству посетителей двумя способами:
  • Через Management API, используя метод KPISetValues. При данной способе, торговая система самостоятельно подсчитывает кол-во посетителей за 1 час и передает передает это значение в созданный показатель.
  • Через формирование CSV файла, формат и способ передачи данных описан в инструкции
Made on
Tilda