/cash

Кассовые операции

Предварительный чек. Позволяет узнать, сколько бонусов будет начислено в результате оплаты чека, а так же какой баланс будет после оплаты чека. По структуре этот запрос аналогичен /cash/order, но является информационным, и не приводит ни к каким действиям.

post

Оплата чека. В результате в MCRM появляется транзакция, происходит списание и начисление бонусов.

post

Импорт чека. Похож на /cash/order, но не приводит к начислению бонусов. Параметр date_create обязательный. Ожидается в формате yyyy-mm-dd hh:ii

post

Максимально доступная сумма к списанию в чеке. Параметры order_pay_money и order_pay_bonus в этом запросе игнорируется

post

Проверить, можно ли будет применить промокод к заказу. Параметр promo в этом запросе обязателен.

post

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

post

Списать бонус с клиента

post

/transaction

Операции с транзакциями

Список транзакций

get

Выполнить полный откат транзакции

post

Выполнить частичный откат транзакции

post

Установить код запроса для транзакции. ВАЖНО! Установка кода запроса не приведёт к кешированию ответа. Попытка повторной обработки аналогичного запроса приведёт к ошибке.

post

Добавление метаданных для транзакции

post

Удаление метаданных из транзакции

post

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

post

/user

Работа с клиентами. Обратите внимание, что для методов, которые получают данные конкретного клиента нужен дополнительный параметр - access_token. Который получается в результате выполнения /user/auth или /user/openauth

Список клиентов в сегменте

get
post

Анкетные данные клиента по номеру карты или номеру телефона. Вместо number/external_id можно включить в запрос access_token. Тогда будет возвращена анкета авторизованного пользователя.

get
post

Регистрация нового клиента. Важно: обязательность полей (в том числе код подтверждения телефона) определяется индивидуальными настройками в MCRM. Проверку отдельных полей можете проверить в ответе, поле field_status

post

Авторизация клиента по телефону и паролю

post

Авторизация без пароля. Для подключения возможности нужно обратиться к администратору MCRM

post

Обновление анкетных данных клиента. Поле phone изменить нельзя. Поле birth_date можно изменить, если ранее оно было пустым. Попытка изменений не вызовет ошибки, но изменения будут проигнорированы. Анкета принимается и обновляется целиком. Если имя было указано, а при вызове обновления вы его не укажете - после обновления он станет пустым. Пустой gender заменит любой пол на мужской.

post

Список транзакций пользователя

get

Список push сообщений в приложении

get

Изменение пароля пользователю

post

Добавление доп. параметров для пользователя

post

Добавление метаданных для пользователя

post

Удаление метаданных у пользователя

post

Добавление сегмента для пользователя

post

Добавление сегмента для пользователя

post

Удаление сегмента у пользователя

post

Добавить для пользователя адрес доставки. ВАЖНО! Валидация адреса не производится. Должен быть заполнен хотя бы один параметр адреса.

post

Добавить новую бронь для пользователя

post

Баланс пользователя

post

Получить персональные рекомендации для пользователя

get

/community

Коммуникации.

Отправить push сообщение в стороннее приложение.

post

Отправить сообщение в чат бот телеграм MCRM.

post

Отправить сообщение по SMS

post

Выслать проверочный код для регистрации по СМС

get
post

Восстановление пароля

get
post

/reservation

Управление бронированиями

Создать новое бронирование. Если у предприятия уже есть бронирование у этого клиента на эту дату и время - существующее бронирование будет обновлено

post

Обновить существующее бронирование. Поиск идёт по клиенту, предприятию, дате и времени. Обновляется только столик и статус.

post

Мягкое удаление бронирования. Поиск идёт по клиенту, предприятию, дате и времени. Откат невозможен, при запросе /reservation/create будет создано новое бронирование.

post

/reference

Справочные данные для разных методов

Список обязательных полей для авторизации. Имена полей соответствуют методу /user/register. Значение true у поля phone_code говорит о том, что подтверждение по СМС обязательно.

get

Список доступных предприятий в сети

get

Список доступных для регистрации районов

get

Список счетов, доступных для предприятия

get

Список сегментов, доступных для предприятия

get

Список типов транзакций, доступных для предприятия

get

/metadata

Работа с метаданными (функционал в разработке)

Список доступных вариантов метаданных, которые используются для транзакций

get

Список доступных вариантов метаданных, которые используются для пользователей

get