Выбрать курс
- Приложение для Битрикс24 "Лаборатория роботов"
- Приложение для Битрикс24 "Сквозная аналитика 2.0"
- Приложение для Битрикс24 "Уничтожитель дубликатов"
- Приложение для Битрикс24 "Межпортальные задачи"
- Приложение для Битрикс24 "Немой чат-бот"
- Приложение для Битрикс24 "Доходы и расходы CRM"
- Приложение для Битрикс24 "Продуктивный Jivosite"
266
/
334
Получить список чеков и купонов
Активити (робот) "Получить список чеков и купонов" предназначено для использования в роботах и может быть полезно в следующих сценариях:
- Получение списка чеков и купонов из партнёрского кабинета;
- Фильтрация по активности, дате покупки, типу действия, лицензии и номеру заказа;
- Выбор одной записи со страницы результата по номеру строки;
- Связка покупки с порталом и идентификатором клиента;
- Контроль периода и типа периода лицензии;
- Интеграция с учётом заказов по orderId;
- Проверка применения модуля по mpModuleCode;
- Отчёты по покупателям и сайтам;
- Условные ветки бизнес-процесса при наличии или отсутствии записей;
- Синхронизация с внутренней CRM по email покупателя.
Как работает активити (робот):
- Выполняется запрос coupon.list к партнёрскому API с partner_id и partner_core;
- Поля filter_* передаются в фильтр (active, buyDateFrom, buyDateTo, action, licenseCode, orderId, page);
- Из списка list выбирается одна запись по совпадению индекса с номером записи row_rec;
- Поля ответа префиксируются list_;
- При отсутствии данных math_search_results = N.
- Выполняется запрос coupon.list к партнёрскому API с partner_id и partner_core;
- Поля filter_* передаются в фильтр (active, buyDateFrom, buyDateTo, action, licenseCode, orderId, page);
- Из списка list выбирается одна запись по совпадению индекса с номером записи row_rec;
- Поля ответа префиксируются list_;
- При отсутствии данных math_search_results = N.
Описание параметров активити (робота)
| Название поля | Описание и примеры использования |
|---|---|
| Идентификатор партнера | Обязательный параметр. Пример: {=Variable:PARTNER_ID}. |
| Секретный ключ партнера | Обязательный partner_core из карточки партнёра. |
| Номер записи | Номер строки в результате для возврата полей одной записи. |
| Номер страницы | filter_page — постраничная выборка. |
| Активность | filter_active — булев фильтр по активности купона. |
| Дата покупки: с / по | filter_buyDateFrom, filter_buyDateTo. |
| Тип | filter_action — тип действия в терминах API. |
| Лицензия | filter_licenseCode. |
| Номер заказа | filter_orderId — строковый идентификатор заказа. |
| Запускать от имени, статус, ожидание | Стандартные параметры робота Битрикс24 для прав и ожидания ответа. |
Примеры использования активити (робота)
| Описание примера | Решение |
|---|---|
| Первая запись без фильтра | partner_id, partner_core, row_rec = 1. |
| Только активные купоны | filter_active = Y, row_rec = 1, filter_page = 1. |
| Покупки за месяц | filter_buyDateFrom и filter_buyDateTo на границы месяца. |
| Поиск по заказу | filter_orderId = {=Variable:ORDER_ID}, row_rec = 1. |
| По коду лицензии | filter_licenseCode = {=Variable:LICENSE_CODE}, row_rec = 1. |
| Вторая строка на странице | row_rec = 2 при непустом списке. |
| Страница результатов | filter_page = {=Variable:PAGE}, row_rec = 1. |
| Фильтр по типу действия | filter_action задаётся согласно допустимым значениям API. |
| Проверка успеха | Условие: math_search_results = Y перед использованием list_buyerEmail. |
| Обогащение CRM | При Y передать list_clientId и list_portalUrl в следующее активити (робот). |
Возвращаемые параметры данного активити (робота):
- list_id, list_siteCheck, данные покупателя list_buyerName, list_buyerEmail, list_buyerLang;
- list_active, list_action, list_buyDate, list_orderId, list_sitesNumber;
- лицензия: list_licenseId, list_licenseCode, list_period, list_periodType, list_toLicenseId;
- list_b24Id, list_portalUrl, list_clientId, list_mpModuleCode;
- навигация: list_totalCount, list_pageCount, list_pageNumber, list_pageSize;
- math_search_results — признак успешного получения записи.
- list_id, list_siteCheck, данные покупателя list_buyerName, list_buyerEmail, list_buyerLang;
- list_active, list_action, list_buyDate, list_orderId, list_sitesNumber;
- лицензия: list_licenseId, list_licenseCode, list_period, list_periodType, list_toLicenseId;
- list_b24Id, list_portalUrl, list_clientId, list_mpModuleCode;
- навигация: list_totalCount, list_pageCount, list_pageNumber, list_pageSize;
- math_search_results — признак успешного получения записи.
Важно: Если список пуст, возвращается только math_search_results = N. Проверяйте это поле перед использованием list_* в следующих шагах.