REST_API

ПОРЯДОК РАБОТЫ С API ТЕРМИНАЛА

Общая информация
Авторизация
2.1 Авторизация с помощью логина/пароля
2.2 Авторизация с помощью API KEY
Получение настроек Терминала
Получение категорий покупателей
Получение счетов покупателей
Получение товаров и категорий
Получение данных о покупателе
7.1 Получение идентификатора покупателя из Kiosk-а
7.2 Получение анкеты покупателя
7.3 Изменение анкеты покупателя
7.4 Изменение типа доступа покупателя
7.5 Изменение категории покупателя
7.6 Согласие покупателя на обработку персональных данных
Получение правил программы лояльности
Работа с чеком
9.1 Подготовка чека
9.2 Процессинг чека
9.3 Запись чека с финализацией
9.4 Запись чека
9.5 Резервирование чека
9.6 Финализация чека
9.7 Создание чека с финализацией
9.8 Резервирование средств по чеку
9.9 Процессинг чека с ранее зарезервированными средствами
9.10 Списание ранее зарезервированных средств по чеку
Платежи
10.1 Запрос платежей по чеку
10.2 Добавление платежа к чеку
10.2 Отмена платежа по чеку
10.4 Отправка сообщения с информацией о платеже в приложение для покупателей
10.5 Запрос статуса платежа
Транзакции
11.1 Объект транзакции
11.2 Получение списка транзакций
11.3 Отмена транзакций
11.4 Получение информации о транзакции
11.5 Получение чека транзакции
Код заказа
12.1 Генерация кода заказа
12.2 Получение последнего кода заказа, сгенерированного Терминалом в режиме Стюард
Идентификаторы покупателя
13.1 Поиск покупателя по идентификаторам
13.2 Регистрация покупателя с заданными идентификаторами
13.3 Получение идентификаторов покупателя
13.4 Добавление идентификаторов покупателя
13.5 Удаление идентификаторов покупателя
Купоны
14.1 Выпуск купонов серии
14.2 Получение данных о купоне
14.3 Использование купона без покупателя
14.4 Список купонов добавленных в кошелек покупателя
14.5 Добавление купона в кошелек покупателя
14.6 Использование купона типа "сертификат"
Выгоды
15.1 Начисление выгоды покупателю
Туристическая карта (карта предоплаченных услуг)
16.1 Список туристических карт покупателя
16.2 Добавление туристической карты в кошелек покупателя
16.3 Получение данных о туристической карте
16.4 Использование услуги из туристической карты
Магазин
17.1 Список заказов покупателя
17.2 Список заказов
17.3 Получение данных о заказе
17.4 Изменение статуса заказа
Задачи
18.1 Объект задачи
18.2 Запрос задач по чеку
18.3 Создание задачи с добавлением к чеку
18.4 Создание задачи
18.5 Информация о задаче
18.6 Запуск задачи
18.7 Остановка задачи
18.8 Закрепление существующей задачи за чеком
Топливо и энергия
19.1 Комплексная информация о состоянии топливных колонок и зарядных станций
Товары и категории в бренде
20.1 Получение списка товаров
20.2 Создание товара
20.3 Получение списка категорий товаров
20.4 Создание категории товаров
20.5 Получение данных о категории товаров
20.6 Изменение категории товаров
20.7 Добавление/изменение картинки категории товаров
20.8 Получение товара по артикулу
20.9 Получение товара по ID
20.10 Изменение товара
20.11 Активация/деактивация товара
20.12 Добавление дополнительной картинки товара
20.13 Удаление дополнительной картинки товара
20.14 Добавление основной картинки товара
20.15 Добавление рекомендованных значений для товара
20.16 Добавление списка цен для товара
Дополнительные возможности
21.1 Подтверждение телефона покупателя
Коды ответов

Общая информация

Обмен информацией с сервером API осуществляется в формате JSON

URL сервера: https://api.incust.com/v1

В header-ах любого запроса должны присутствовать поля:

Content-Type, равное application/json
Accept-Language, возможные значения (поддерживаемые языки) 'en' - английский, 'ru' - русский, 'uk' - украинский, 'pl' - польский.

Авторизация

Для работы с API Терминала необходимо необходимо использовать токен авторизации, который должен добавляться в заголовки (headers) всех запросов.

Token может быть краткосрочным, когда он получен с использованием логина и пароля, и долгосрочным, когда он получен через API KEY.

Перед тем как релизовывать авторизацию, следует добавить как минимум один Терминал в список Терминалов в Панели Управления Бизнеса. Логин и пароль, также как и API KEY одного из добавленных Терминалов могут использоваться для авторизации запросов к API.

Авторизация с помощью логина/пароля

Для работы с API Терминалом посредством логина/пароля необходимо получить токен авторизации, который в дальнейшем будет добавляться в заголовки (headers) всех запросов. Логин и пароль должны соответствовать заданным для одного из Терминалов, которые вы добавили в Панели Управления Бизнеса.

Запрос на получение токена авторизации

URL: /term/token
Метод: POST
URL параметры:
- нет
Data параметры:
- login, type: string,
- password, type: string

Пример запроса:

  { 
     "method":"POST",
     "url":"https://api.incust.com/v1/term/token",
     "headers":{ 
        "Content-Type":"application/json",
        "Accept-Language":"ru"
     },
     "data": {"login":"login","password":"1234"}
  }

Пример ответа:

  { 
     "business_code":"123456",
     "currency":"RUB",
     "display_active":1,
     "display_type":"customer-identity",
     "id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "loyalty":{ 
        "title":"Pizza Hattta"
     },
     "phone":"+7501111111",
     "pos":{ 
        "addresses":"ул. Хрещатик, 24",
        "country":"RU",
        "title":"Название точки продажи"
     },
     "title":"Название Терминала",
     "token":"eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет токен и общая информация о бизнесе, POS и Терминале.
Токен необходимо сохранить для добавления его в заголовки всех последующих запросов и далее обновлять сохраненный токен не реже чем раз в сутки. Срок жизни токена 24 часа.

Авторизация с помощью API KEY

Для авторизации запросов к API Терминала можно использовать API KEY вместо токена. Включить авторизацию через API Key возможно в Панели Управления Бизнеса - с помощью кнопки API KEY возле названия того Терминала, который вы хотите представлять при использовании API.

Формат поля Authorization в заголовках аналогичен авторизации с помощью токена, полученного с помощью логина/пароля:
"Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"

Преимущества API KEY:

Срок жизни API KEY 10 лет, нет необходимости его обновлять в отличие от токена
API KEY перестает работать только если его специально обновить в Панели управления. Необходимость в этом возникает только из соображений безопасности (есть подозрения в несанкционированном доступе к API KEY и т. п.)

Получение настроек Терминала

Запрос на получение настроек Терминала

URL: /term/settings
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/settings",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Пример ответа:

  {
     "business_code":"305187",
     "currency":"RUB",
     "display_active":0,
     "display_type":"customer-identity",
     "id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "loyalty":{
        "title":"Название программы лояльности"
     },
     "loyalty_settings":{
        "bonus_payment_limit":30,
        "bonus_payment_type":"partial"
     },
     "phone":"+7112233444",
     "pos":{
        "addresses":"Адрес точки продажи",
        "country":"RU",
        "title":"Название точки продажи"
     },
     "system_params": {
        "default_check_amount_decimal_digits": 2,
        "default_check_bonuses_decimal_digits": 2,
        "default_check_special_accounts_decimal_digits": 2,
        "default_item_amount_decimal_digits": 2,
        "default_item_bonuses_decimal_digits": 2,
        "default_item_price_decimal_digits": 3,
        "default_item_special_accounts_decimal_digits": 2,
        "maximum_check_amount_decimal_digits": 2,
        "maximum_check_bonuses_decimal_digits": 2,
        "maximum_check_special_accounts_decimal_digits": 2,
        "maximum_item_amount_decimal_digits": 2,
        "maximum_item_bonuses_decimal_digits": 2,
        "maximum_item_price_decimal_digits": 2,
        "maximum_item_special_accounts_decimal_digits": 2,
        "support_external_id_primary_identifier": true
     },
     "title":"Название Терминала"
  }

Замечания:
В случае правильно сформированного запроса в ответе на запрос прийдет объект с данными и настройками Терминала:
- id: идентификатор Терминала
- phone: телефон, привязанный к Терминалу
- title: название Терминала
- business_code: уникальный код бизнеса, состоящий из 6 цифр
- currency: валюта Терминала (ISO 4217)
- display_active: подключен ли к Терминалу киоск(0 – нет, 1 – да)
- display_type: режим работы киоска, возможные значения:
  - customer-identity - аутентификация покупателя
  - gift-redeem - выбор и получение вознаграждения
- loyalty: данные программы лояльности
  - title: название программы лояльноси
- loyalty_settings: настройки программы лояльности
  - bonus_payment_limit: ограничение по оплате чека бонусами. Значение передается в процентах от сумы к оплате(amount_to_pay) чека
  - bonus_payment_type: тип оплаты бонусами, возможные значения
    - partial: частичная оплата
    - partial-rounded: частичная оплата с округлением до целого
    - full-check: только полная оплата чека
- pos: данные точки продажи
  - addresses: адрес, указанный в настройках точки продажи
  - country: код страны которая задана в настройках
  - title: название точки продажи
- system_params: параметры системы
  - maximum_check_amount_decimal_digits: максимально допустимое количество десятичных знаков в сумме чека
  - default_check_amount_decimal_digits: значение по умолчанию количества десятичных знаков в сумме чека
  - maximum_check_bonuses_decimal_digits: максимально допустимое количество десятичных знаков в сумме бонусов начисляемых или списываемых по чеку
  - default_check_bonuses_decimal_digits: значение по умолчанию количества десятичных знаков в сумме бонусов начисляемых или списываемых по чеку
  - maximum_check_special_accounts_decimal_digits: максимально допустимое количество десятичных знаков в сумме начисления на счета покупателей по чеку
  - default_check_special_accounts_decimal_digits: значение по умолчанию количества десятичных знаков в сумме начисления на счета покупателей по чеку
  - maximum_item_price_decimal_digits: максимально допустимое количество десятичных знаков в цене товара
  - default_item_price_decimal_digits: значение по умолчанию количества десятичных знаков в цене товара
  - maximum_item_amount_decimal_digits: максимально допустимое количество десятичных знаков в сумме по товару
  - default_item_amount_decimal_digits: значение по умолчанию количества десятичных знаков в сумме по товару
  - maximum_item_bonuses_decimal_digits: максимально допустимое количество десятичных знаков в сумме бонусов начисляемых или списываемых по товару
  - default_item_bonuses_decimal_digits: значение по умолчанию количества десятичных знаков в сумме бонусов начисляемых или списываемых по товару
  - maximum_item_special_accounts_decimal_digits: максимально допустимое количество десятичных знаков в сумме начисления на счета покупателей по товару
  - default_item_special_accounts_decimal_digits: значение по умолчанию количества десятичных знаков в сумме начисления на счета покупателей по товару
  - support_external_id_primary_identifier: признак поддержки внешнего идентификатора в качестве первичного идентификатора пользователя/покупателя

Получение категорий покупателей

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

Запрос на получение категорий покупателей

URL: /term/card_categories
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/card_categories",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Пример ответа:

  [
     {
        "id": "5c5e9012-ee35-4863-8ec2-3a12e51d6c2f",
        "title": "Test PLATINUM",
        "type": "custom"
     },
     {
        "id": "9806a813-e396-4c5c-bb0a-4e44b3e50628",
        "title": "Test GOLD",
        "type": "custom"
     },
     {
        "id": "b4e2d095-0d35-11e6-bfd1-020000ed147d",
        "title": "NEW CLIENTS",
        "type": "base"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список доступных категорий покупателей. Каждый элемент массива является объектом, имеющим поля:
- id: идентификатор категории
- title: название категории
- type: тип категории. Возможные значения 'base', 'custom'

Получение счетов покупателей

Для того, чтобы работать со счетами покупателей (выдача чашки кофе после покупки семи чашек, получение предоплаченных литров топлива и т. д.) в Терминале, необходимо получить доступные для Терминала счета. Если работа со счетами не предполагается, можно пропустить этот пункт и перейти сразу к получению товаров и категорий

Запрос на получение счетов покупателей

URL: /term/special_account
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/special_account",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Пример ответа:

  [
     {
        "active":1,
        "goods_items":[
           "1444"
        ],
        "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "public_title":"Передплата за каву",
        "title":"Передплата за каву",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "123",
           "1234"
        ],
        "id":"2d1d3ae9-eb45-43f8-87ff-12987f5d3ffa",
        "public_title":"Универсальный топливный счет",
        "title":"Универсальный топливный счет",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "id":"4adaa00d-fd86-415b-86a7-e75709b5dc11",
        "public_title":"Достижения",
        "title":"Достижения",
        "type":"punches",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "1234"
        ],
        "id":"4b43be56-c667-4057-8ee3-fcbd179ac6df",
        "public_title":"Дизельное топливо",
        "title":"ДТ",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
        "public_title":"Вознаграждение за визит",
        "title":"Вознаграждение за визит",
        "type":"punches",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "123"
        ],
        "id":"fe16758d-6fe1-45b7-9781-dbd94b77c4ee",
        "public_title":"Бензин A95",
        "title":"A95",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список счетов покупателей. Каждый элемент массива является объектом, имеющим поля:
- id: ID счета покупателя
- active: включен ли счет (1 – да, 0 – нет)
- public_title: локализованное название счета
- title: название счета
- type: тип счета. Возможные значения 'punches', 'goods', 'money'
- goods_items: массив кодов (code товара) товаров, которые можно продать со счета (фильтр по товарам).
  - Для счета с type == 'goods', если не задано ни одного товара (массив пуст или значение отсутствует), то продать с данного счета ничего не возможно.
  - Для остальных типов счетов, если не задано ни одного товара (массив пуст или значение отсутствует), то можно продать любой товар.
- unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS

Получение товаров и категорий

После успешной авторизации необходимо получить список товаров и категорий товаров для проведения торговых операций в Терминале.

Получение списка категорий

URL: /term/categories
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  { 
     "method":"GET",
     "url":"https://api.incust.com/v1/term/categories",
     "headers":{ 
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
     }
  }

Пример ответа:

  [ 
     { 
        "active":1,
        "code":"Категория товаров 1",
        "color":3545497855,
        "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
        "title":"Категория товаров 1",
        "image":{ 
           "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
           "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
        },
        "nodes":[ 
           { 
              "active":1,
              "code":" Подкатегория товаров 1.1",
              "color":4294967295,
              "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
              "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
              "title":" Подкатегория товаров 1.1"
           }
        ]
     },
     { 
        "active":1,
        "code":"Категория товаров 2",
        "color":4294967295,
        "id":"4729488e-051a-4238-bebb-9d40306109b3",
        "title":"Категория товаров 2"
     },
     { 
        "active":1,
        "code":"Категория товаров 3",
        "color":4294967295,
        "id":"82daa2d8-774a-44df-a078-b26d41ed4290",
        "title":"Категория товаров 3"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список категорий товаров, с которыми работает Терминал. Каждый элемент массива является объектом, имеющим поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: код/артикул категории
- color: цвет категории (integer)
- title: название категории
- image: объект, содержащий поля id – id картинки, url – ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый дочерний объект также может содержать массив nodes и т. д.

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

URL: /term/goods
Метод: GET
URL параметры:
- category
  - 'all' – возвращает все товары
  - 'root' – возвращает товары без категорий
  - category_id – возвращает товар из категории
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/goods?category=all",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5g1YA.q6yWPEECM12jhAzphz2BOWNO8mg"
     }
  }

Пример ответа:

  [
     {
        "active":1,
        "code":"1444",
        "color":4294967295,
        "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
        "image":{
           "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
           "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
        },
        "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Напитки",
        "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
        "parent_title":"Напитки",
        "price":[
           {
              "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
              "price":1,
              "special_account":{
                 "active":1,
                 "goods_items":[
                    "1444"
                 ],
                 "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
                 "public_title":"Предоплата за кофе",
                 "title":"Предоплата за кофе",
                 "type":"goods",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "type":"special-account"
           },
           {
              "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
              "price":7,
              "special_account":{
                 "active":1,
                 "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                 "public_title":"Вознаграждение за визит",
                 "title":"Вознаграждение за визит",
                 "type":"punches",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "type":"special-account"
           },
           {
              "currency":"RUB",
              "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
              "price":10,
              "type":"currency"
           }
        ],
        "sort_order":0,
        "title":"Кофе",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     },
     {
        "active":1,
        "code":"11111",
        "color":4294967295,
        "id":"4ce153e5-8ed9-4840-bcd3-e0f77536e055",
        "image":{
           "id":"9d377a96-ee6e-4322-88a2-c56563131537",
           "url":"https://api.incust.com/static/b0/67/d83f371e4bc998896556f16970e7.jpeg"
        },
        "image_id":"9d377a96-ee6e-4322-88a2-c56563131537",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Пицца",
        "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
        "parent_title":"Пицца",
        "price":[
           {
              "id":"ec708edb-c334-43c1-b322-9f267c14748d",
              "price":20,
              "special_account":{
                 "active":1,
                 "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                 "public_title":"Вознаграждение за визит",
                 "title":"Вознаграждение за визит",
                 "type":"punches",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "type":"special-account"
           },
           {
              "currency":"RUB",
              "id":"375f47d9-8338-4861-a7d1-d690d6c77203",
              "price":80,
              "type":"currency"
           }
        ],
        "sort_order":0,
        "title":"Пицца 5 сыров",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     },
     {
        "active":1,
        "code":"12344",
        "color":4294967295,
        "id":"5b6a423d-9a05-470c-a0c4-aaa0400433a8",
        "image":{
           "id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
           "url":"https://api.incust.com/static/59/15/ec56e3964316a57ef51f90690cd1.jpeg"
        },
        "image_id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Пицца",
        "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
        "parent_title":"Пицца",
        "price":[
           {
              "id":"21185186-db47-409c-954c-24e1f1119152",
              "price":40,
              "special_account":{
                 "active":1,
                 "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                 "public_title":"Вознаграждение за визит",
                 "title":"Вознаграждение за визит",
                 "type":"punches",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "type":"special-account"
           },
           {
              "currency":"RUB",
              "id":"e25d31df-9f2c-4a05-a7c6-637acc27e1af",
              "price":95,
              "type":"currency"
           }
        ],
        "sort_order":0,
        "title":"Пицца мясная",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     },
     {
        "active":1,
        "code":"54321",
        "color":4294967295,
        "id":"880abda0-04c2-4779-a93d-92d5273ec5eb",
        "image":{
           "id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
           "url":"https://api.incust.com/static/50/76/5c1b743f450aa3c4be7c7ab887d9.jpeg"
        },
        "image_id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Напитки",
        "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
        "parent_title":"Напитки",
        "price":[
           {
              "id":"4c608c24-2a6b-4664-b409-b51ff4ffb170",
              "price":5,
              "special_account":{
                 "active":1,
                 "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                 "public_title":"Вознаграждение за визит",
                 "title":"Вознаграждение за визит",
                 "type":"punches",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "type":"special-account"
           },
           {
              "currency":"RUB",
              "id":"fe535973-5236-4b7f-a515-747a4741030d",
              "price":25,
              "type":"currency"
           }
        ],
        "sort_order":0,
        "title":"Чай имбирный",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     },
     {
        "active":1,
        "code":"3113",
        "color":4294967295,
        "id":"fbed57fb-207e-4b55-8da7-dae8e1896d84",
        "image":{
           "id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
           "url":"https://api.incust.com/static/04/1b/e6235b1c420e950bd50908d8c844.jpeg"
        },
        "image_id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Десерти",
        "parent_id":"e609f66f-9bd2-4352-8b71-bd3228774ff2",
        "parent_title":"Десерти",
        "price":[
           {
              "id":"71f4f14e-7038-4895-823b-5b22166620a9",
              "price":15,
              "special_account":{
                 "active":1,
                 "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                 "public_title":"Вознаграждение за визит",
                 "title":"Вознаграждение за визит",
                 "type":"punches",
                 "unconfirmed_redeem_amount":0
              },
              "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "type":"special-account"
           },
           {
              "currency":"RUB",
              "id":"b20975ab-ecda-4ee0-88f0-b6dbca51e1aa",
              "price":50,
              "type":"currency"
           }
        ],
        "sort_order":0,
        "title":"Десерт черничный",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список товаров, с которыми работает Терминал. Каждый элемент массива является объектом, имеющим поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупател
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: объем списания единиц с счета без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо заданой ранее в панели
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Получение данных о покупателе

Этот метод необходим для получения информации о покупателе: количество бонусов на счету, наличие средств на счетах покупателя, имени данных о возрасте и т. д.

Запрос на получение получения данных покупателя

URL:
- /term/cardinfo/{{id}}/{{id_type}}
- /term/cardinfo/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет
Пример запроса:
```
  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/cardinfo/+7112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }
```
Пример url для упрощенного вызова:
1. для номера телефона https://api.incust.com/v1/term/cardinfo/+7112233444
2. для номера карты https://api.incust.com/v1/term/cardinfo/123456
3. для кода заказа https://api.incust.com/v1/term/cardinfo/@123456
4. для QR кода https://api.incust.com/v1/term/cardinfo/1,+7112233444,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394

Пример ответа для нового покупателя (ни разу не проводил операций в пределах данного бизнеса):

  {
     "bonuses":null,
     "coupons":null,
     "customer":{
        "access_type":"full-bonuses-access",
        "new":1,
        "show_questionnaire":1,
        "user_status":"active"
     },
     "rate_info":null,
     "specials":null
  }

Пример ответа, если клиент зарегестрирован в бизнесе:

  {
      "bonuses":[
          {
              "currency":"RUB",
              "permanent_bonuses_amount":501.9,
              "temporary_bonuses_amount":0
          }
      ],
      "customer":{
          "access_type":"full-bonuses-access",
          "avatar":"https://api.incust.com/static/fe/c3/79e9a4c9416eb843b09d47dbd7da.jpeg",
          "last_sale_date":"2017-02-16T09:36:04Z",
          "new":0,
          "show_questionnaire":0,
          "user_birth_date":"1972-01-01",
          "user_created":"2016-10-24T06:33:18.498000Z",
          "user_gender":"male",
          "user_name":"Александр",
          "user_phone":"+7112233444",
          "user_status":"active"
      },
      "rate_info":{
          "currency":"RUB",
          "turnover":6561
      },
      "specials":[
          {
              "amount":4,
              "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
              "title":"Вознаграждение за визит"
          }
      ],
      "coupons":[
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
               "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание серии купонов",
               "public_title":"Название серии купонов",
               "share_allowed":0,
               "type":"check-modifier"
            },
            "code":"246990359478",
            "id":"4081a81a-1483-11e7-898a-020000ed147d",
            "status":"open"
         },
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание серии купонов",
               "public_title":"Название серии купонов",
               "recommendation_fee_amount":1,
               "recommendation_fee_bonuses_currency":"RUB",
               "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
               "recommendation_fee_promotional_bonuses_expire_type":"date",
               "recommendation_fee_promotional_bonuses_expire_value":0,
               "recommendation_fee_type":"promotional-bonuses",
               "share_allowed":1,
               "type":"certificate"
            },
            "code":"192059545592",
            "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
            "status":"open"
         }
      ],
      "tourist_cards": [
          {
              "accounts": [
                  {
                      "amount": 0,
                      "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                      "precision": "integer",
                      "public_title": "Название счета"
                  }
              ],
              "activated_dt": "2018-06-20T09:57:47.225000Z",
              "active": 1,
              "code": "570237733572",
              "expire_dt": "2018-08-20T09:57:47.225000Z",
              "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
              "public_title": "Название карты",
              "public_description": "Описание карты",
              "services": [
                  {
                      "available_amount": 0,
                      "available_now": 0,
                      "available_times": 0,
                      "category": {
                          "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                          "public_title": "Название категории услуг"
                      },
                      "decrement_step": 5,
                      "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                      "public_title": "Название услуги",
                      "public_description": "Описание услуги",
                      "usage_limit_per_loyalty": 0,
                      "usage_limit_per_loyalty_period_type": "all-card-time",
                      "usage_limit_per_loyalty_period_value": 0,
                      "usage_limit_per_pos": 3,
                      "usage_limit_per_pos_period_type": "hour",
                      "usage_limit_per_pos_period_value": 1,
                      "used_times": 10
                  }
              ],
              "valid": 1
          }
      ]
  }

Замечания:
В зависимости от типа идентификатора, использованного для получения карты покупателя, будут различаться ответы в случае, если покупателя не существует:
- телефон: ответ всегда будет позитивным. Если покупателя не существует, будут возвращены пустые данные со статусом нового покупателя. Если покупатель существует, будут возвращены данные этого покупателя
- номер карты: если карты не существует, или она не привязана к конкретному покупателю, будет возвращена ошибка. Чтобы исправить это, необходимо привязать карточку к существующему покупателю.
- QR код: если код истек, или покупатель не зарегистрирован в данном бизнесе, будет возвращена ошибка. Чтобы исправить это, необходимо хотя бы один раз провести покупателя через Терминал с помощью номера телефона или создать/импортировать покупателя в Панели управления
Ответ на запрос будет содержать следующие поля:
- bonuses: массив объектов с бонусами покупателя, каждый объект будет содержать следующие поля:
  - currency: валюта бонусов
  - permanent_bonuses_amount: количество постоянных бонусов
  - temporary_bonuses_amount: количество временных бонусов
- customer: объект покупатель содержит следующие поля:
  - access_type: тип доступа, возможные значения 'full-bonuses-access', 'add-bonuses-only', 'waiting-for-confirmation', 'in-black-list'
  - avatar: ссылка на картинку покупателя
  - last_sale_date: дата последней покупки
  - new: является ли покупатель новым для текущего бизнеса (1 - да, 0 - нет)
  - show_questionnaire: показывать ли кассиру диалог с возможностью введения информации о покупателе (1 - да, 0 - нет)
  - user_birth_date: день рождения покупателя
  - user_created: дата создания покупателя в системе inCust
  - user_gender: пол покупателя
  - user_name: имя покупателя
  - user_phone: номер телефона покупателя
  - user_status: статус покупателя, возможные значения 'active', 'suspended'
- rate_info: с информацией о обороте:
  - turnover: оборот покупателя за весь период
- specials: массив объектов с счетами покупателя, каждый объект будет содержать следующие поля:
  - amount: количество единиц на счете покупателя
  - id: ID счета покупателя
  - title: название счета покупателя
- coupons: массив объектов с купонами покупателя, каждый объект будет содержать следующие поля:
  - id: ID купона
  - code: код купона
  - batch: объект серии купонов, содержит данные о серии купонов к которой принадлежит купов, содержит следующие поля
    - id: ID серии купонов
    - type: тип серии купонов, возможные значения 'certificate', 'check-modifier'
    - public_title: публичное название серии купонов
    - public_description: публичное описание серии купонов
    - image: изображение серии купонов, ссылка на картинку
  - status: статус купона, возможные значения 'open', 'redeemed', 'cancelled', в данном случае будут возвращены только купоны с статусом 'open'
    - Для купонов типа 'certificate' со статусом 'redeemed' возвращаются данные о благах, начисленных при погашении купона:
  - redeemed_charge_type: тип начисленного блага, возможные значения 'regular-bonuses' - бонусы, 'promotional-bonuses' - акционные бонусы, 'special-account' - счет покупателя)
  - redeemed_charge_amount: сумма начисленных благ
  - redeemed_charge_bonuses_currency: валюта начисленных бонусов (код ISO)
  - redeemed_charge_expired: дата окончания действия акционных бонусов (в формате 'YYYY-MM-DD')
  - redeemed_charge_special_account_id: идентификатор счета покупателя
  - redeemed_charge_special_account_title: публичное название счета покупателя
  - redeemed_charge_special_account_currency: валюта счета покупателя (код ISO)
- tourist_cards: массив объектов типа туристическая карта с туристическими картами покупателя.

Получение идентификатора покупателя из Kiosk-а

Этот метод позволяет получить идентификатор покупателя из приложения Kiosk, а так же opt-пароль из SMS, необходимый для снятия бонусов и списания со счетов покупателя, подробнее см. inCust Киоск, самообслуживание покупателя

Запрос на получение идентификатора покупателя из Kiosk-а

URL: /term/display_customer
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  {
      "method":"GET",
      "url":"https://api.incust.com/v1/term/display_customer",
      "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXpQ.zZvP5SKGBACGo3W2-uYRmwSuXSs"
      }
  }

Пример ответа:

  {
      "cardotppassword":2173,
      "id":"+7112233444"
  }

Замечания:
В случае правильно сформированного запроса в ответе придет:
- пустой объект {} если покупателя в Kiosk-е нет
- объект, содержащий id покупателя { "id":"+7112233444" }, если покупатель ввел телефон
- объект, содержащий телефон в id покупателя и пароль из SMS { "id":"+7112233444", "cardotppassword":2173 } в cardotppassword, если покупатель ввел телефон и подвердил его вводом кода из SMS
- объект, содержащий QR код в id покупателя { "id":"1,+7112233444,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394" }, если покупатель авторизировался с помощью приложения inCust
В последствии полученный id нужно использовать для получения данных покупателя, а также добавить его в объект check на этапе процессинга чека. Если в ответе присутствует cardotppassword, его также нужно добавить в объект check.

Получение анкеты покупателя

Метод позволяет получить данные анкеты покупателя, хранимые в inCust.

Запрос на получения анкеты покупателя

URL:
- /term/questionnaire/{{id}}/{{id_type}}
- /term/questionnaire/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/questionnaire/+7112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     }
  }

Пример ответа:

  {
     "customer":{
        "user_birth_date":"1963-01-29",
        "user_gender":"male",
        "user_name":"Username"
     },
     "fields":[
        {
           "description":"Last name",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Last name"
        },
        {
           "description":"Have a child",
           "dictionary_values":[
              "Yes",
              "No"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"No"
        },
        {
           "description":"Year sallary",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Memorial date",
           "id":"2ca456f7-772b-4ae7-9a9e-b172763d5d3a",
           "sort_order":4,
           "type":"date",
           "value":"2016-11-20T00:00:00Z"
        }
     ]
  }

Замечания:
В случае правильно сформированного запроса в ответе будет содержатся два поля:
- customer системные поля покупателя:
  - user_name: имя покупателя в системе inCust
  - user_gender: пол покупателя, возможные значения: male, female, other
  - user_birth_date: день рождения покупателя
- fields настраиваемые поля покупателя. Платформа inCust позволяет добавлять произвольные поля к анкете покупателя, настройки доступны по ссылке. Каждое настраиваемое поле будет передано в виде объекта с следующими полями:
  - id: идентификатор поля
  - description: название поля
  - sort_order: число определяющее порядок отображения поля
  - type: тип поля, возможные типы:
    - string: произвольная строка
    - dictionary: словарь, набор фиксированных значений
    - integer: числовое поле
    - date: дата
  - value: значение поля
  - dictionary_values: массив возможных значений словаря, присутствует в ответе только если тип поля(type) равен dictionary

Изменение анкеты покупателя

Метод позволяет обновить данные анкеты покутеля.

Запрос на изменение анкеты покупателя

URL:
- /term/questionnaire/{{id}}/{{id_type}}
- /term/questionnaire/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: PATCH
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- customer: объект покупатель, содержит следующие поля:
  - user_name: type string, имя покупателя
  - user_gender: type string, пол покупателя, допустимые значения: male, female, other
  - user_birth_date: type string, формат YYYY-MM-DD, день рождения покупателя
- fields: настраиваемы поля покупателя, содержит пары ключ/значение
  - id: type string, идентификатор настраиваемого поля.
  - value: type string, значение настраиваемого поля.

Пример запроса:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/questionnaire/+711223344/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
        "customer":{
           "user_birth_date":"1963-01-29",
           "user_gender":"male",
           "user_name":"Bohdan"
        },
        "fields":{
           "66c5e653-e71a-49ac-89f6-8a646e29843d":null,
           "fc61fee6-2ed7-11e6-bfd1-020000ed147d":"No",
           "12739ce4-2754-48cd-a31f-a9ddf4c80ee3":null,
           "2ca456f7-772b-4ae7-9a9e-b172763d5d3a":"2016-11-19T02:00:00+02:00"
        }
     }
  }

Пример ответа:

  {
     "customer":{
        "user_birth_date":"1963-01-29",
        "user_gender":"male",
        "user_name":"Username"
     },
     "fields":[
        {
           "description":"Last name",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Last name"
        },
        {
           "description":"Have a child",
           "dictionary_values":[
              "Yes",
              "No"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"No"
        },
        {
           "description":"Year sallary",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Memorial date",
           "id":"2ca456f7-772b-4ae7-9a9e-b172763d5d3a",
           "sort_order":4,
           "type":"date",
           "value":"2016-11-20T00:00:00Z"
        }
     ]
  }

Замечания:
В случае правильно сформированного запроса в ответе будет содержатся тот же объект, что возвращает метод GET

Изменение типа доступа покупателя

Метод позволяет изменить типа доступа покупателя.

Запрос на изменение типа доступа покупателя

URL:
- /term/customers/{{id}}/{{id_type}}/access_type
- /term/customers/{{id}}/access_type - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: PATCH
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- access_type: type string, тип доступа покупателя

Пример запроса:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/customers/+711223344/phone/access_type",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "access_type": "full-bonuses-access"
     }
  }

Пример ответа:

  {
    "access_type": "full-bonuses-access"
  }

Замечания:
В случае правильно сформированного запроса в ответе будет содержатся обновленный тип доступа покупателя

Изменение категории покупателя

Метод позволяет изменить категорию покупателя.

Запрос на изменение категории покупателя

URL:
- /term/customers/{{id}}/{{id_type}}/card_category
- /term/customers/{{id}}/card_category - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: PATCH
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- id: type string, идентификатор новой категории покупателя

Пример запроса:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/customers/+711223344/phone/card_category",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "id": "00000000-0000-0000-0000-000000000000"
     }
  }

Пример ответа:

  {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "NEW CUSTOMERS",
    "type": "base"
  }

Замечания:
В случае правильно сформированного запроса в ответе будут содержатся данные обновленной категории покупателя

Метод позволяет зафиксировать факт согласия покупателя на использование платформы и на хранение и обработку платформой персональных данных.

Объект подтверждения согласия покупателя содержит следующие поля:

confirmation: type string, способ подтверждения согласия:
- pin - подтверждение путем отсылки PIN-кода
- email - подтверждение путем отсылки сообщения электронной почты, содержащего ссылку на подтверждение
- interface - подтверждение путем выбора в интерфейсе пользователя (приложение, Панель управления покупателя и т.п.)
- business - подтверждение путем раннее собранной информации в торговых точках
comment: type string, комментарий, содержащий данные о том когда и в какой торговой точке была собрана информация и получено согласие (для способа подтверждения согласия business).
code: type string, код подтверждения,высланный в сообщении (для способа подтверждения согласия pin)

Запрос на фиксацию согласия покупателя на использование платформы и на хранение и обработку платформой персональных данных

URL:
- /term/customers/{{id}}/{{id_type}}/consent
- /term/customers/{{id}}/consent - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- объект подтверждения согласия
Пример запроса:
```
  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/customers/+711223344/phone/consent",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "code": "",
         "comment": "Test",
         "confirmation": "pin"
     }
  }
```
- Если как способ подтверждения согласия выбран pin, и при этом поле code не установлено (содержит пустое значение или отсутсвует), то покупателю будет автоматически выслано сообщение с кодом подтверждения, и ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с PIN-кодом подтверждения согласия отправлено на номер +7115050999"
}
```
  После получения такого ответа необходимо добавить в объект подтверждения согласия поле code c кодом подтверждения, сообщенным покупателем кассиру, и отправить объект подтверждения согласия на повторную обработку.

Пример ответа:

  {
      "app_type": "web",
      "comment": "Test",
      "confirmation": "pin",
      "processed": "2019-08-08T14:55:55.058000Z",
      "request": {
          "method": "POST",
          "remote_addr": "192.168.111.41",
          "url": "https://t.incust.com/v1/term/customers/%2B7115050999/consent"
      },
      "type": "terminal-customer-registration",
      "user": {
          "country": null,
          "email": null,
          "id": "00000000-0000-0000-0000-000000000000",
          "language": null,
          "name": null,
          "phone": "+7115050999"
      }
  }

Замечания:
В случае правильно сформированного запроса в ответе будут содержаться данные о согласии покупателя на использование платформы и на хранение и обработку платформой персональных данных.

Получение правил программы лояльности

Этот метод необходим для того, чтобы получить список правил лояльности, доступных для применения вручную.

Запрос на получение правил программы лояльности

URL: /term/rules
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"/term/rules",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C6Bs-w.UP4cetKh0cVVvMxy85t2ELFNbjk"
     }
  }

Пример ответа:

  [
     {
        "action_type":"charge-percent-by-item",
        "active":1,
        "applicable_for_sale":"all",
        "automatic":0,
        "charge_type":"regular-bonuses",
        "combine":1,
        "comment":"Скидка на товар, на заданный %",
        "depends_type":"none",
        "id":"514b5b58-c615-40df-9450-cdf2592e76a9",
        "items_limit_max":0,
        "items_limit_min":0,
        "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
        "priority":5,
        "scheduled":0,
        "title":"Скидка Тест",
        "value":[
           {
              "threshold":0,
              "value":0
           }
        ],
        "week_days":[

        ]
     },
     {
        "action_type":"charge-percent-by-item",
        "active":1,
        "applicable_for_sale":"all",
        "automatic":0,
        "charge_type":"regular-bonuses",
        "combine":1,
        "comment":"Начислить на товар, заданный %",
        "depends_type":"none",
        "id":"b40db9f5-fe78-4804-bad8-966f16a25a0e",
        "items_limit_max":0,
        "items_limit_min":0,
        "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
        "priority":6,
        "scheduled":0,
        "title":"Начисление",
        "value":[
           {
              "threshold":0,
              "value":0
           }
        ],
        "week_days":[

        ]
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет массив содержащий список правил программы лояльности доступных для приминения. Из всех полей объекта впоследствии для использования необходимы idдля добавления в массив implemented_rules объекта check и comment для отображения кассиру информации о применяемом правиле.

Работа с чеком

В разделе описаны все этапы обработки чека.

Подготовка чека

Перед процессингом чека его необходимо сформировать, пример чека и необходимые поля описаны ниже.

пример сформированного чека:

{
  "payment_type":"currency",
  "payment_id":"RUB",

  "amount":285,
  "amount_to_pay":285, 
  "bonuses_added_amount":0,
  "bonuses_added":[

  ],
  "bonuses_redeemed_amount":1,
  "special_accounts_charges":[

  ],
  "manual_rules":true,
  "implemented_rules":[
      {"id":"c785aa00-d288-4384-814e-f33fc074c7b2"}
  ],
  "redeemed_coupons": [
      { "code": 246990359478 },
      { "code": 192059545592 }
  ],
  "check_items":[
   {
      "title":"Кофе",
      "weighing":0,
      "whole_number":1,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"1444",
      "price":10,
      "quantity":1,
      "category":"Напитки",
      "bonuses_redeemed_amount":1,
      "amount":10
   },
   {
      "title":"Чай имбирный",
      "weighing":0,
      "whole_number":1,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"54321",
      "price":25,
      "quantity":1,
      "category":"Напитки",
      "bonuses_redeemed_amount":0,
      "amount":25
   },
   {
      "title":"Бензин",
      "weighing":0,
      "whole_number":0,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"Petrol95",
      "price":25,
      "quantity":10,
      "category":"Топливо",
      "bonuses_redeemed_amount":0,
      "amount":250,
      "additions": {
        "job": {
              "auto_start": true,
              "details": {
                  "fuel": {
                      "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                  }
              },
              "type": "fuel"
        }
      }
   }
  ],
  "id_type":"phone",
  "id":"+7112233444",
  "amount_decimal_digits": 2,
  "bonuses_decimal_digits": 2,
  "special_accounts_decimal_digits": 2,
  "additions": {
      "odometer": 111111
  }
}

payment_type: обязательный параметр, тип платежа, возможные значения 'currency', 'special-account'
payment_id: обязательный параметр, id платежа,
- если payment_type=='currency', то в это поле необходимо передать код валюты Терминала
- если payment_type=='special-account', то в это поле необходимо передать id счета покупателя
amount: обязательный параметр, сумма стоимости всех товаров в чеке
amount_to_pay: сумма к оплате, при первом запросе должна быть равна amount в ответе сервера приходит с учетом скидок, снимаемых бонусов
discount_amount: скидка на чек, рассчитывается автоматически на сервере
bonuses_redeemed_amount: сумма снимаемых бонусов
- если в товарах чека присутствует параметр bonuses_redeemed_amount, то распределение суммы списываемых бонусов по товарам в чеке распределяется согласно значениям параметра bonuses_redeemed_amount, указанным в товарах
- если параметр bonuses_redeemed_amount отсутсвует в товарах чека, то распределение суммы списываемых бонусов по товарам в чеке распределяется пропорционально стоимости товара.
bonuses_added_amount: колличество начисляемых бонусов, рассчитывается автоматически на сервере
special_accounts_charges: массив объектов содержащих начисления по счетам покупателей, рассчитываются автоматически на сервере. Пол объекта:
- amount: сумма начисления
- id: ID счета покупателя на который произойдет начисление
manual_rules: применять ли ручные правила(по умолчанию false к чеку применяются автоматические правила)
implemented_rules:
- если параметр manual_rules==true, то в это поле необходимо передать массив с одним элементом содержащим поле id с идентификатором правила программы лояльности [{"id":"c785aa00-d288-4384-814e-f33fc074c7b2"}]
- если параметр manual_rules==false, то в ответе с сервера прийдет массив примененных к чеку правил
redeemed_coupons: в случае когда необходимо использовать купоны, в этот массив добавляются объект(ы) содержащий(е) одно поле 'code' с кодом купона, тип купона должен быть равен check-modifier, пример массива: [{ "code": 246990359478 }, { "code": 192059545592 }], в ответе на запрос к объектам купона будет добавлена информация о купоне(поля title, description, id) и поле applicable указывающее применим ли купон к данному чеку, значения true или false.
check_items: массив товаров добавленных к чеку, товар должен содержать перечисленные ниже поля:
- code: Код/Артикул товара
- category: код/артикул родительской категории
- price: цена за единицу товара
- quantity: количество единиц товара
- amount: стоимость товара == price - quantity
- bonuses_redeemed_amount: сумма снимаемых бонусов для выбранной товарной позиции.
  - если присутствует данный параметр, то распределение суммы списываемых бонусов по товарам в чеке распределяется согласно значениям, указанным в данном параметре
  - если данный параметр отсутсвует, то распределение суммы списываемых бонусов по товарам в чеке распределяется пропорционально стоимости товара.
- discount_amount: скидка на товар, рассчитывается автоматически на сервере
- bonuses_added: бонусы начисляемые на товар, рассчитываются автоматически на сервере
- price_decimal_digits: количество знаков после запятой в значении цены товара. Если значение не указано, системное используется значение по умолчанию.
- amount_decimal_digits: количество знаков после запятой в значении суммы по товару. Если значение не указано, системное используется значение по умолчанию.
- bonuses_decimal_digits: количество знаков после запятой в значениях начисляемых и списываемых бонусов. Если значение не указано, системное используется значение по умолчанию.
- special_accounts_decimal_digits: количество знаков после запятой в значениях начислений на счета покупателей.
- additions: Дополнительные (не специфицированные) данные по товару.
  - job: объект, содержащий данные задачи, которую необходимо создать или добавить, при создании транзакции.
    - если необходимо добавить уже существующую задачу, то в объекте необходимо и достаточно передать уникальный идентификатор задачи
    - если необходимо создать новую задачу, то в объекте необходимо указать данные новой задачи, такие как тип и детали
id_type: необязательный тип идентификатора покупателя. На данный момент в системе поддерживаются:
- phone - номер телефона в международном формате ('+' в начале номера обязателен)
- qr - QR код из приложения inCust
- email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
- card - номер пластиковой карты
- temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
- id - идентификатор покупателя в системе inCust
- social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
- ssn - номер социального страхования для граждан и резидентов США
- itin - индивидуальный налоговый номер
id: идентификатор покупателя. Если тип идентификатора не указан в параметра id_type, то значение параметра id может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
amount_decimal_digits: количество знаков после запятой в значении суммы чека. Если значение не указано, системное используется значение по умолчанию.
bonuses_decimal_digits: количество знаков после запятой в значениях начисляемых и списываемых бонусов. Если значение не указано, системное используется значение по умолчанию.
special_accounts_decimal_digits: количество знаков после запятой в значениях начислений на счета покупателей. Если значение не указано, системное используется значение по умолчанию.
additions: Дополнительные (не специфицированные) данные по чеку.

Процессинг чека

Для расчета объема скидок/начисляемых бонусов/начислений на специальный счет необходимо провести операцию процессинга чека. Операция процессинга чека проводится ОБЯЗАТЕЛЬНО перед отправкой чека на финализацию

Запрос на процессинг чека

URL: /term/process_check
URL: /term/process_check/{rules_type}
Метод: POST
URL параметры:
- rules_type - тип правил, которые необходимо применить при расчете чека:
  - by-all-rules - при расчете применяются правила всех типов
  - by-charge-only-rules - при расчете применяются правила только по начислению бонусов или на счет покупателя
  - without-rules - при расчете правила не применяются
Data параметры:
- описаны в разделе Подготовка чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/process_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "bonuses_added_amount":0,
        "bonuses_added":[

        ],
        "bonuses_redeemed_amount":1,
        "special_accounts_charges":[

        ],
        "manual_rules":false,
        "implemented_rules":[

        ],
        "redeemed_coupons": [
           { "code": 246990359478 },
           { "code": 192059545592 }
        ],
        "check_items":[
           {
              "title":"Кофе",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"1444",
              "price":10,
              "quantity":1,
              "category":"Напитки",
              "amount":10
           },
           {
              "title":"Чай имбирный",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"54321",
              "price":25,
              "quantity":1,
              "category":"Напитки",
              "amount":25
           }
        ],
        "id_type":"phone",
        "id":"+7115050999",
        "payment_type":"currency",
        "payment_id":"RUB",
        "amount":35,
        "amount_to_pay":35
     }
  }

Пример ответа:

  {
     "amount":35,
     "amount_to_pay":34,
     "bonuses_added":[
        {
           "amount":3.4
        }
     ],
     "bonuses_added_amount":3.4,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":10,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"1444",
           "discount_amount":0,
           "price":10,
           "quantity":1,
           "title":"Кофе",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":25,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"54321",
           "discount_amount":0,
           "price":25,
           "quantity":1,
           "title":"Чай имбирный",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+7112233444",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Бонусная программа лояльности",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Начисление",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"RUB",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект чека, модифицированный согласно начисляемым скидкам, списываемым бонусам, примененным купонам и т. д.

Запись чека с финализацией

Для завершения операции необходимо финализировать (запись чека с закрытием) чек. Перед отправкой чека на финализацию необходимо обязательно провести объект чека через метод процессинга чека

Запрос на запись чека с финализацией

URL: /term/confirm_check
Метод: POST
URL параметры:
- нет
Data параметры:
- в качестве параметра полностью передается объект чека полученый после процессинга чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/confirm_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

Если в качестве id покупателя в чеке используется телефон или номер карты и предполагается списание бонусов или списание благ с счета покупателя, то ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с кодом подтверждения транзакции отправлено на номер +7115050999"
}
```
После получения такого ответа необходимо:
- либо добавить в объект check поле cardotppassword c PIN-кодом, сообщенным покупателем кассиру, и отправить объект check на повторную обработку. Если PIN-код не правильный, будет возвращена соответствующая ошибка, иначе чек будет успешно финализирован и закрыт.
- либо, в случае списания бонусов, удалить поле bonuses_redeemed_amount и продолжить операцию без списания бонусов
Если в качестве id покупателя в чеке используется QR-код, чек будет успешно финализирован и закрыт, подтверждение операции PIN-кодом не требуется.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Запись чека

Для резервирования средств и фиксации оплат по операции необходимо записать чек. Перед отправкой чека на запись необходимо обязательно провести объект чека через метод процессинга чека
Если записанный чек не финализирован в течении 2 часов, он автоматически отменяется, а все зарезервированные средства высвобождаются.

Запрос на запись чека

URL: /term/write_check
Метод: POST
URL параметры:
- нет
Data параметры:
- в качестве параметра полностью передается объект чека полученый после процессинга чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/write_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

Если в качестве id покупателя в чеке используется телефон или номер карты и предполагается списание бонусов или списание благ с счета покупателя, то ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с кодом подтверждения транзакции отправлено на номер +7115050999"
}
```
После получения такого ответа необходимо:
- либо добавить в объект check поле cardotppassword c PIN-кодом, сообщенным покупателем кассиру, и отправить объект check на повторную обработку. Если PIN-код не правильный, будет возвращена соответствующая ошибка, иначе чек будет успешно записан.
- либо, в случае списания бонусов, удалить поле bonuses_redeemed_amount и продолжить операцию без списания бонусов
Если в качестве id покупателя в чеке используется QR-код, чек будет успешно финализирован и закрыт, подтверждение операции PIN-кодом не требуется.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Резервирование чека

Для резервирования средств и фиксации оплат по операции на длительный период (до одного месяца) необходимо зарезервировать чек. Перед отправкой чека на резервирование необходимо обязательно провести объект чека через метод процессинга чека
Если зарезервированный чек не финализирован в течении одного месяца, он автоматически отменяется, а все зарезервированные средства высвобождаются.

Запрос на резервирование чека

URL: /term/reserve_check
Метод: POST
URL параметры:
- нет
Data параметры:
- в качестве параметра передается полностью объект чека, полученный после процессинга чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/reserve_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

Если в качестве id покупателя в чеке используется телефон или номер карты и предполагается списание бонусов или списание благ с счета покупателя, то ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с кодом подтверждения транзакции отправлено на номер +7115050999"
}
```
После получения такого ответа необходимо выполнить одно из нижеследующих действий:
- добавить в объект check поле cardotppassword c PIN-кодом, сообщенным покупателем кассиру, и отправить объект check на повторную обработку. Если PIN-код не правильный, будет возвращена соответствующая ошибка, иначе чек будет успешно зарезервирован.
- в случае списания бонусов, удалить поле bonuses_redeemed_amount и продолжить операцию без списания бонусов
Если в качестве id покупателя в чеке используется QR-код, чек будет успешно финализирован и закрыт; при этом подтверждение операции PIN-кодом не требуется.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Финализация чека

Финализация ранее записанного или зарезервированного чека

Запрос на финализацию чека

URL: /term/finalize_check
Метод: POST
URL параметры:
- нет
Data параметры:
- id: идентификатор чека, полученный в результате операции записи чека или резервирования чека
- comment: комментарий

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/finalize_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "1a640590-293e-11e8-8196-020000ed147d",
        "comment": ""
        }
  }

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Создание чека с финализацией

Операция создания чека с его финализацией. Включает в себя полный цикл обработки чека: процессинг, запись и финализацию.

Запрос на создание чека с финализацией

URL: /term/make_check
Метод: POST
URL параметры:
- нет
Data параметры:
- описаны в разделе Подготовка чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/make_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Описание купона",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Название купона"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

Если в качестве id покупателя в чеке используется телефон или номер карты и предполагается списание бонусов или списание благ с счета покупателя, то ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с кодом подтверждения транзакции отправлено на номер +7115050999"
}
```
После получения такого ответа необходимо:
- либо добавить в объект check поле cardotppassword c PIN-кодом, сообщенным покупателем кассиру, и отправить объект check на повторную обработку. Если PIN-код не правильный, будет возвращена соответствующая ошибка, иначе чек будет успешно финализирован и закрыт.
- либо, в случае списания бонусов, удалить поле bonuses_redeemed_amount и продолжить операцию без списания бонусов
Если в качестве id покупателя в чеке используется QR-код, чек будет успешно финализирован и закрыт, подтверждение операции PIN-кодом не требуется.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Резервирование средств по чеку

Операция позволяет зарезервировать средства на товарном, денежном или бонусном счету покупателя или на банковской карте (при оплате через мобильное приложение). Перед отправкой чека на запись необходимо обязательно провести объект чека через метод процессинга чека
Средства резервируются до момента списания операцией Списание ранее зарезервированных средств по чеку и становятся не доступны для дальнейшего использования в других операциях.
Средства резервируются на срок до семи дней, после чего, в случае, если чек не был завершен и средства по нему не были списаны, они освобождаются для дальнейшего использования.

Запрос на резервирование средств по чеку

URL: /term/authorize_payment_check
Метод: POST
URL параметры:
- нет
Data параметры:
- описаны в разделе Подготовка чека

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "special_accounts_charges":[

        ],
        "payments": [
           {"type": "mobile-app", "amount": 34.0}
        ]
     }
  }

Если в качестве id покупателя в чеке используется телефон или номер карты и предполагается списание бонусов или списание благ с счета покупателя, то ответом на запрос будет объект с кодом 0
```
{
"code":0,
"message":"SMS-сообщение с кодом подтверждения транзакции отправлено на номер +7115050999"
}
```
После получения такого ответа необходимо:
- либо добавить в объект check поле cardotppassword c PIN-кодом, сообщенным покупателем кассиру, и отправить объект check на повторную обработку. Если PIN-код не правильный, будет возвращена соответствующая ошибка, иначе чек будет успешно создан и средства зарезервированы.
- либо, в случае списания бонусов, удалить поле bonuses_redeemed_amount и продолжить операцию без списания бонусов
Если в качестве id покупателя в чеке используется QR-код, средства по чеку будут успешно зарезервированы, подтверждение операции PIN-кодом не требуется.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":0.0,
      "bonuses_on_account":10.0,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"authorize-payment",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Процессинг чека с ранее зарезервированными средствами

Расчет объема скидок/начисляемых бонусов/начислений на специальный счет, ранее зарезервированных по чеку операцией Резервирование средств по чеку.

Запрос на процессинг чека

URL: /term/authorize_payment_check/{{id}}/process_check/{rules_type}
Метод: POST
URL параметры:
- id, уникальный идентификатор транзакции, полученный в результате выполнения операции Резервирование средств по чеку
- rules_type - тип правил, которые необходимо применить при расчете чека:
  - by-all-rules - при расчете применяются правила всех типов
  - by-charge-only-rules - при расчете применяются правила только по начислению бонусов или на счет покупателя
  - without-rules - при расчете правила не применяются
Data параметры:
- Данные чека (модифицированные или нет), по которым проводилось резервирование средств, полученные в результате запроса Получение чека транзакции. Описаны в разделе Подготовка чека.

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check/a15ebe59-fff6-11e6-bfd1-020000ed147d/process_check/by-all-rules",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "bonuses_added_amount":0,
        "bonuses_added":[

        ],
        "bonuses_redeemed_amount":1,
        "special_accounts_charges":[

        ],
        "manual_rules":false,
        "implemented_rules":[

        ],
        "redeemed_coupons": [
           { "code": 246990359478 },
           { "code": 192059545592 }
        ],
        "check_items":[
           {
              "title":"Кофе",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"1444",
              "price":10,
              "quantity":1,
              "category":"Напитки",
              "amount":10
           },
           {
              "title":"Чай имбирный",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"54321",
              "price":25,
              "quantity":1,
              "category":"Напитки",
              "amount":25
           }
        ],
        "id_type":"phone",
        "id":"+7115050999",
        "payment_type":"currency",
        "payment_id":"RUB",
        "amount":35,
        "amount_to_pay":35
     }
  }

Пример ответа:

  {
     "amount":35,
     "amount_to_pay":34,
     "bonuses_added":[
        {
           "amount":3.4
        }
     ],
     "bonuses_added_amount":3.4,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":10,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"1444",
           "discount_amount":0,
           "price":10,
           "quantity":1,
           "title":"Кофе",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":25,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"54321",
           "discount_amount":0,
           "price":25,
           "quantity":1,
           "title":"Чай имбирный",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+7112233444",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Бонусная программа лояльности",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Начисление",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"RUB",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект чека, модифицированный согласно начисляемым скидкам, списываемым бонусам, примененным купонам и т.д.

Списание ранее зарезервированных средств по чеку

Операция списания средств, ранее зарезервированных по чеку операцией Резервирование средств по чеку.
Средства которые будут списаны не должны превышать суммы зарезервированных средств, но могут быть изменены в сторону уменьшения.
Таким образом, данные чека могут быть модифицированы, по сравнению с данными чека, по которым проводилось резервирование средств, но только в сторону уменьшения стоимости и сумм списываемых средств.

Запрос на списание ранее зарезервированных средств по чеку

URL: /term/authorize_payment_check/{{id}}/capture
Метод: POST
URL параметры:
- id, уникальный идентификатор транзакции, полученный в результате выполнения операции Резервирование средств по чеку
Data параметры:
- Данные чека (модифицированные или нет), по которым проводилось резервирование средств, полученные в результате запроса Получение чека транзакции. Описаны в разделе Подготовка чека.

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check/a15ebe59-fff6-11e6-bfd1-020000ed147d/capture",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Кофе",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Напитки",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Чай имбирный",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+7112233444",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Бонусная программа лояльности",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Начисление",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"RUB",
        "payment_type":"currency",
        "special_accounts_charges":[

        ],
        "payments": [
           {"id": "cfdd5efa-1060-4e65-8d28-974bc72de587", "type": "mobile-app", "amount": 34.0}
        ]
     }
  }

В списке платежей (при его наявности), каждый объект должен обязательно содержать атрибут id - уникальный идентификатор платежа, полученный в данных чека, по которому проводилось резервирование средств.

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":0.0,
      "bonuses_on_account":10.0,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"374c86e1-3ba3-11ea-8e76-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"RUB\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Кофе\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Напитки\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Чай имбирный\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Начисление\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Бонусная программа лояльности\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Платежи

В системе inCust по чеку можно фиксировать платежи.

Запрос платежей по чеку

По чеку можно получить список платежей, зафиксированных за ним.

Запрос платежей по чеку

URL:
- /term/payment/check/{{id}}
Метод: GET
URL параметры:
- id: уникальный идентификатор транзакции, по которой надо получить платежи
Data параметры:
- нет

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Пример ответа:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "RUB",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "RUB",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив объектов, содержащих данные платежа :
- id: уникальный идентификатор платежа
- status: статус платежа
  - inprocess - платеж в процессе обработки
  - success - платеж успешен
  - authorized - платеж успешено зарезервирован
  - fail - платеж отклонен платежной системой/банком
  - error - в процессе обработки платежа произошла ошибка
  - cancelled - платеж отменен
- type: тип платежа
  - cash - платеж наличными
  - mobile-app - платеж мобильным приложением
  - bank-card - платеж банковской картой
  - special-account - платеж со счета покупателя
- amount: сумма платежа
- currency: ISO код валюты
- transaction_id: уникальный идентификатор чека/транзакции

Добавление платежа к чеку

К чеку можно добавить платеж.

Запрос на добавление платежа к чеку

URL:
- /term/payment/check/{{id}}/add
Метод: POST
URL параметры:
- id: уникальный идентификатор транзакции, по которой надо получитть платежи
Data параметры:
- Массив объектов, содержащих данные платежа, которые должны быть добавлены:
  - type: тип платежа
    - cash - платеж наличными
    - mobile-app - платеж мобильным приложением
    - bank-card - платеж банковской картой
    - special-account - платеж со счета покупателя
  - amount: сумма

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          {
              "type": "cash", 
              "amount": 200
          }
      ]
  }

Пример ответа:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "RUB",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "RUB",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив объектов, содержащих данные платежа

Отмена платежа по чеку

Ранее добавленный к чеку платеж можно отменить.

Запрос на отмену платежа по чеку

URL:
- /term/payment/check/{{id}}/cancel
Метод: POST
URL параметры:
- id: уникальный идентификатор транзакции, по которой надо получитть платежи
Data параметры:
- Массив идентификаторов платежей, которые должны быть отменены

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          "99089853-5ed2-4ffb-8623-b236e28056ff",
          "c2ecbcff-d39c-417b-9723-fd09a7c5278c"
      ]
  }

Пример ответа:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "RUB",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "RUB",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив объектов, содержащих данные платежа

Отправка сообщения с информацией о платеже в приложение для покупателей

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

Запрос на отправку сообщения с информацией о платеже в приложение для покупателей

URL:
- /term/payment/mobileapp/message
Метод: POST
URL параметры:
- нет
Data параметры:
- id: уникальный идентификатор транзакции, по которой осуществлен платеж

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/mobileapp/message",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "id": "1017db3a-fba0-11e7-8196-020000ed147d"
      }
  }

Пример ответа:

  {
      "id": "44886507-6776-4f67-b799-82f3efcf1693",
      "status": "success",
      "type": "ipay"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные о платеже:
- id: уникальный идентификатор платежа
- status: статус платежа
  - inprocess - платеж в процессе обработки
  - success - платеж успешен
  - authorized - платеж успешено зарезервирован
  - fail - платеж отклонен платежной системой/банком
  - error - в процессе обработки платежа произошла ошибка
  - cancelled - платеж отменен
- type: тип платежной системы

Запрос статуса платежа

Терминал может запросить статус мобильного платежа по транзакции/чеку.

Запрос статуса платежа

URL:
- /term/payment/mobileapp/status
Метод: POST
URL параметры:
- нет
Data параметры:
- id: уникальный идентификатор транзакции, по которой осуществлен платеж

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/mobileapp/status",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "id": "1017db3a-fba0-11e7-8196-020000ed147d"
      }
  }

Пример ответа:

  {
      "id": "44886507-6776-4f67-b799-82f3efcf1693",
      "status": "success",
      "type": "ipay"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные о платеже:
- id: уникальный идентификатор платежа
- status: статус платежа
  - inprocess - платеж в процессе обработки
  - success - платеж успешен
  - authorized - платеж успешено зарезервирован
  - fail - платеж отклонен платежной системой/банком
  - error - в процессе обработки платежа произошла ошибка
  - cancelled - платеж отменен
- type: тип платежной системы

Транзакции

Данный раздел посвящен работе с транзакциями.

Объект транзакции

Объект содержит общую информацию о транзакции

пример информации о транзакции:

{
  "amount": 1000.0,
  "amount_to_pay": 900.0,
  "bonus_account_id": "004f0d0e-0de9-11e6-bfd1-000000ed147d",
  "bonuses_added": 0.0,
  "bonuses_on_account": 36168.75,
  "bonuses_redeemed": 100.0,
  "business_id": "12343b7e-0d35-11e6-bfd1-020000e1237d",
  "cancelled": 0,
  "comment": "",
  "currency": "RUB",
  "discount_amount": 0.0,
  "errors": [
      {
          "code": 170,
          "level": "warning",
          "message": "Ошибка транзакции. Невозможно списать средств больше, чем авторизировано.",
          "type": "authorized-payment-capture"
      }
  ],
  "finalized": "2020-05-05T15:36:28.777000Z",
  "finalized_local": "2020-05-05T18:36:28.777000Z",
  "id": "ba723454-8ee5-11ea-b744-021230ed147d",
  "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
  "payment_type": "currency",
  "processed": "2020-05-05T15:33:11.470000Z",
  "processed_local": "2020-05-05T18:33:11.470000Z",
  "shipping_amount": 0.0,
  "special_account_amount": 0.0,
  "terminal_id": "b4e123ee-0d35-11e6-bfd1-0234506d147d",
  "type": "authorize-payment",
  "user_id": "9873eb97-fe7f-46fc-9fb2-5093474de415"
}

id: уникальный идентификатор транзакции
type: тип платежа
- reserve - резерв чека на период до одного месяца (обычно используется в online магазине)
- presale - резерв чека на период до одного часа (обычно используется для проведения платежа)
- authorize-payment - резерв средств по чеку до 7 дней
- sale - продажа по чеку
- cancel - отмена транзакции
- bonus-add - начисление бонусов
- special-account-refill - пополнение счета покупателя
- coupon-sale - продажа купона покупателю
transaction_id: уникальный идентификатор связанной транзакции
processed: Дата и время проведения транзакции в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
processed_local: Дата и время проведения транзакции в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс регистратора
finalized: Дата и время финализации транзакции в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
finalized_local: Дата и время финализации транзакции в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс регистратора
cancelled: признак того, что транзакция отменена
payment_type: тип платежа, возможные значения 'currency', 'special-account' для денежных средств и счета покупателя соответственно
currency: валюта транзакции,
- если payment_type=='currency', то это валюта списания средств и начисления бонусов
- если payment_type=='special-account', то это валюта начисления бонусов
amount: сумма чека
amount_to_pay: сумма к оплате, с учетом скидок, снимаемых бонусов
shipping_amount: стоимость доставки
discount_amount: скидка на чек
bonuses_redeemed: сумма снимаемых бонусов
bonuses_added: сумма начисляемых бонусов
bonus_account_id: уникальный идентификатор бонусного счета покупателя с которого списаны/начислены бонусы
special_account_id: уникальный идентификатор счета покупателя с которого списаны средства
comment: комментарий к операции
user_id: уникальный идентификатор учетной записи покупателя
errors: массив объектов содержащих ошибки и предупреждения, возникшие при обработке транзакции:
- type: тип операции, при выполнении которой возникла ошибка:
  - transaction-post-processing - действия по обработке транзакции после ее создания
  - authorized-payment-capture - действия, выполняемые при списании ранее зарезервированных средств
- level: уровень ошибки:
  - error - ошибка
  - warning - предупреждение
- message: текст ошибки
- code: код ошибки

Получение списка транзакций

Запрос на получение списка транзакций

URL: /term/transactions
Метод: GET
URL параметры:
- date_from, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- date_to, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- user_id, type string, уникальный идентификатор пользователя (опциональный параметр)
- page, type integer, страница в разбиении на страницы, счет страниц начинается c 1
- count, type integer, размер выборки в разбиении на страницы,
- sort, type string, сортировка транзакций, в формате "sorting_field sorting_direction"
  - sorting_field, type string, возможные значения amount, amount_to_pay, bonuses_added, bonuses_on_account, bonuses_redeemed, cancelled, comment, payment_type, processed, sms, type, user_name, user_phone
  - sorting_direction, type string, возможные значения ASC, DESC
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transactions?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=10&sort=processed DESC",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Пример ответа:

  {
     "data":[
        {
           "amount":255,
           "amount_to_pay":248,
           "bonus_account_id":"520d370f-05a3-11e7-aa6b-020000ed147d",
           "bonuses_added":24.8,
           "bonuses_on_account":24.8,
           "bonuses_redeemed":7,
           "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
           "cancelled":0,
           "comment":"",
           "currency":"RUB",
           "discount_amount":0,
           "id":"982c96da-05a3-11e7-aa6b-020000ed147d",
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "loyalty_title":"Super Pizza - Stock, Auth",
           "online":1,
           "payment_type":"currency",
           "pos_title":"Super Pizza",
           "processed":"2017-03-10T15:09:44Z",
           "processed_local":"2017-03-10T17:09:44Z",
           "sc_bonuses_redeem":null,
           "sc_code":null,
           "sc_created":null,
           "sc_terminal_id":null,
           "sc_terminal_login":null,
           "sc_terminal_phone":null,
           "sc_terminal_title":null,
           "sms":1,
           "special_account_amount":0,
           "special_account_id":null,
           "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
           "terminal_login":"uademo",
           "terminal_phone":null,
           "terminal_title":"Товарный Терминал, киоск аутентификации",
           "transaction_id":null,
           "type":"sale",
           "user_id":"7b136b01-8dd8-40de-a06c-6c4e1b58c5bc",
           "user_name":"Андрей",
           "user_phone":"+7994148003"
        },
        {
           "amount":10,
           "amount_to_pay":10,
           "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
           "bonuses_added":1,
           "bonuses_on_account":1,
           "bonuses_redeemed":0,
           "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
           "cancelled":0,
           "comment":"",
           "currency":"RUB",
           "discount_amount":0,
           "id":"4cf8995b-ff18-11e6-bfd1-020000ed147d",
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "loyalty_title":"Super Pizza - Stock, Auth",
           "online":1,
           "payment_type":"currency",
           "pos_title":"Super Pizza",
           "processed":"2017-03-02T07:17:31Z",
           "processed_local":"2017-03-02T09:17:31Z",
           "sc_bonuses_redeem":null,
           "sc_code":null,
           "sc_created":null,
           "sc_terminal_id":null,
           "sc_terminal_login":null,
           "sc_terminal_phone":null,
           "sc_terminal_title":null,
           "sms":1,
           "special_account_amount":0,
           "special_account_id":null,
           "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
           "terminal_login":"uademo",
           "terminal_phone":null,
           "terminal_title":"Товарный Терминал, киоск аутентификации",
           "transaction_id":null,
           "type":"sale",
           "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
           "user_name":"123",
           "user_phone":"+7115050999"
        }
     ],
     "summary":{
        "total_amount":14115,
        "total_amount_to_pay":13586,
        "total_bonuses_added":1363,
        "total_bonuses_redeemed":490,
        "total_discount_amount":0,
        "total_rows_count":177
     }
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет объект с двумя полями:
- data: массив объектов транзакций
- summary: общая информация о выборке
  - total_amount:суммарное значение сумм покупок
  - total_amount_to_pay: суммарное значение сумм к оплате
  - total_bonuses_added: суммарное значение начисленных бонусов
  - total_bonuses_redeemed: суммарное значение списанных бонусов
  - total_discount_amount: суммарное значение начисленных скидок
  - total_rows_count: общее количество транзакций в выборке

Отмена транзакции

Запрос на отмену

URL: /term/transaction_cancel
Метод: POST
URL параметры:
- нет
Data параметры:
- transaction_id, type string, id транзакции, он присутствует в объекте транзакции, который возвращается в массиве транзакций методом /term/transactions
- comment, type string, комментарий к операции отмены транзакции

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/transaction_cancel",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "transaction_id":"04fb8bdd-fffd-11e6-bfd1-020000ed147d",
        "comment":"Причина отмены"
     }
  }

Пример ответа:

  {
     "amount":2,
     "amount_to_pay":2,
     "bonus_account_id":"a26bed76-348c-11e6-bfd1-020000ed147d",
     "bonuses_added":0,
     "bonuses_on_account":3936.26,
     "bonuses_redeemed":0,
     "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
     "comment":"",
     "currency":"RUB",
     "discount_amount":0,
     "id":"219ee372-05ae-11e7-aa6b-020000ed147d",
     "info":"{\"transaction_id\":\"5510f163-fffb-11e6-bfd1-020000ed147d\"}",
     "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
     "online":1,
     "payment_type":"special-account",
     "processed":"2017-03-10T16:25:10Z",
     "sms":0,
     "special_account_amount":221,
     "special_account_id":"54358709-2f1a-41c5-8c82-3d8792d5a56d",
     "terminal_id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "transaction_id":"5510f163-fffb-11e6-bfd1-020000ed147d",
     "type":"cancel",
     "user_id":"d2b57641-8583-4c5e-a8db-04dafe2e140d"
  }

Получение информации о транзакции

Запрос на получение информации о транзакции

URL: /term/transaction/{id}
Метод: GET
URL параметры:
- id, уникальный идентификатор транзакции, по которой надо получить информацию
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transaction/982c96da-05a3-11e7-aa6b-020000ed147d",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Пример ответа:

  {
       "amount":255,
       "amount_to_pay":248,
       "bonus_account_id":"520d370f-05a3-11e7-aa6b-020000ed147d",
       "bonuses_added":24.8,
       "bonuses_on_account":24.8,
       "bonuses_redeemed":7,
       "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
       "cancelled":0,
       "comment":"",
       "currency":"RUB",
       "discount_amount":0,
       "id":"982c96da-05a3-11e7-aa6b-020000ed147d",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "loyalty_title":"Super Pizza - Stock, Auth",
       "online":1,
       "payment_type":"currency",
       "pos_title":"Super Pizza",
       "processed":"2017-03-10T15:09:44Z",
       "processed_local":"2017-03-10T17:09:44Z",
       "sc_bonuses_redeem":null,
       "sc_code":null,
       "sc_created":null,
       "sc_terminal_id":null,
       "sc_terminal_login":null,
       "sc_terminal_phone":null,
       "sc_terminal_title":null,
       "sms":1,
       "special_account_amount":0,
       "special_account_id":null,
       "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
       "terminal_login":"uademo",
       "terminal_phone":null,
       "terminal_title":"Товарный Терминал, киоск аутентификации",
       "transaction_id":null,
       "type":"sale",
       "user_id":"7b136b01-8dd8-40de-a06c-6c4e1b58c5bc",
       "user_name":"Андрей",
       "user_phone":"+7994148003"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет объект транзакции

Получение чека транзакции

Получение объекта чека, на основании которого была создана транзакция.

Запрос на получение информации о чеке транзакции

URL: /term/transaction/{{id}}/check
Метод: GET
URL параметры:
- id, уникальный идентификатор транзакции, по которой надо получить информацию о чеке
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transaction/982c96da-05a3-11e7-aa6b-020000ed147d/check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Пример ответа:

  {
     "amount":35,
     "amount_to_pay":34,
     "bonuses_added":[
        {
           "amount":3.4
        }
     ],
     "bonuses_added_amount":3.4,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":10,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"1444",
           "discount_amount":0,
           "price":10,
           "quantity":1,
           "title":"Кофе",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":25,
           "bonuses_added":0,
           "category":"Напитки",
           "code":"54321",
           "discount_amount":0,
           "price":25,
           "quantity":1,
           "title":"Чай имбирный",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+7112233444",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Бонусная программа лояльности",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Начисление",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"RUB",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Описание купона",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Название купона"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект чека, по которому была создана транзакция

Список купонов добавленных в кошелек покупателя

В список включены все купоны, добавленные в кошелек покупателя, которые не были погашены и просрочены.

Запрос на получение списка купонов добавленных в кошелек покупателя

URL:
- /term/coupons/{{id}}/{{id_type}}
- /term/coupons/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_amount":1,
           "recommendation_fee_bonuses_currency":"RUB",
           "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
           "recommendation_fee_promotional_bonuses_expire_type":"date",
           "recommendation_fee_promotional_bonuses_expire_value":0,
           "recommendation_fee_type":"promotional-bonuses",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"192059545592",
        "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
        "status":"open"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов купонов

Добавление купона в кошелек покупателя

Запрос на добавление купона в кошелек

URL:
- /term/coupons/{{id}}/{{id_type}}/add
- /term/coupons/{{id}}/add - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- массив объектов c полем code содержащим код купона, например [{ "code": 246990359478 }, { "code": 192059545592 }]

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":[
        { "code": 246990359478 },
        { "code": 192059545592 }
     ]
  }

Пример ответа:

  {
      "codes":[
         {
            "code":"246990359478",
            "valid":true
         },
         {
            "code":"192059545592",
            "valid":true
         }
      ],
      "coupons":[
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
               "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание купона",
               "public_title":"Название купона",
               "share_allowed":0,
               "type":"check-modifier"
            },
            "code":"246990359478",
            "id":"4081a81a-1483-11e7-898a-020000ed147d",
            "status":"open"
         },
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание купона",
               "public_title":"Название купона",
               "recommendation_fee_amount":1,
               "recommendation_fee_bonuses_currency":"RUB",
               "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
               "recommendation_fee_promotional_bonuses_expire_type":"date",
               "recommendation_fee_promotional_bonuses_expire_value":0,
               "recommendation_fee_type":"promotional-bonuses",
               "share_allowed":1,
               "type":"certificate"
            },
            "code":"192059545592",
            "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
            "status":"open"
         }
      ],
      "message":"Купоны и сертификаты были добавлены в кошелек покупателя в количестве 2 шт. Из них в данной точке продажи покупатель сумеет увидеть и использовать 2 шт.\nПолный список своих купонов и сертификатов покупатель может просмотреть в кошельке в мобильном приложении inCust."
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет объект с полями:
- codes: массив объектов, содержащих поля:
  - code: код купона
  - valid: валидность купона, значения true или false
- coupons: массив объектов купонов

Использование купона типа "сертификат"

Купоны типа «сертификат» позволяют однократно начислять вознаграждение покупателю, вознаграждение может быть бонусами, акционными бонусами(с ограниченным сроком действий), пополнением специальных счетов покупателя.

Использование купона типа "сертификат"

URL:
- /term/coupons/{{id}}/{{id_type}}/redeem
- /term/coupons/{{id}}/redeem - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер

Data параметры:

массив объектов c полем id, содержащим id купона, например [{ "id": "4081a81a-1483-11e7-898a-020000ed147d" }, { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }]

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"ru",
    "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
 },
 "data":[
    { "id": "4081a81a-1483-11e7-898a-020000ed147d" },
    { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }
 ]
}

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив с объектами типа купон, объект "купон" будет дополнительно содержать поле redeemed, содержащее результат применения купона, возможные значения true или false

Код заказа

Код заказа - это временный код, сгенерированный Терминалом в режиме Регистратор или Стюард, который позволяет идентифицировать покупателя, а таже (если это выбрано при генерации) списывать ценности, такие как бонусы, средства со счета покупателя.

Генерация кода заказа

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

Запрос на генерацию кода заказа

URL:
- /term/generate_temporary_code/{{id}}/{{id_type}}
- /term/generate_temporary_code/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
- redeem_allowed: разрешает ли код списание ценностей. Тип boolean (true – да, false – нет).
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/generate_temporary_code/+7112233444/phone?redeem_allowed=false",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }

Пример ответа для кода, не разрешающего списывать ценности или любого кода:
```
  {
     "message":"",
     "code":"123456",
     "redeem_allowed":false
  }
```

Пример ответа для кода, разрешающего списывать ценности:

  {
     "message":"На гостя было отправлено SMS-сообщение с кодом карты заказа. Данный код позволяет не только начислить, но и списать бонусы. Попросите гостя продиктовать код.",
     "code":"",
     "redeem_allowed":true
  }

Замечания:
Если в качестве идентификатора покупателя был передан QR код, то ответ всегда будет первого типа, т.е. содержать код заказа.

Ответ на запрос будет содержать следующие поля:
- message: сообщение системы
- code: код заказа
- redeem_allowed: разрешено ли списание ценностей. Тип boolean (true – да, false – нет).

Получение последнего кода заказа, сгенерированного Терминалом в режиме Стюард

Терминал позволяет получить последний код, сгенерированный Терминалом в режиме Регистратора или Стюарда, работающим под той же учетной записью, что и Терминал.

Запрос на получение последнего кода, сгенерированного программой Терминал

URL:
- /term/last_temporary_code?time_delta={{time_delta}}
Метод: GET
URL параметры:
- time_delta: Время, за которое производится поиск (в минутах). Значение по умолчанию 5 минут.
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/last_temporary_code?time_delta=30",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Пример ответа:

  {
      "code": "176820",
      "redeem_allowed": true
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий код:
- code: код заказа
- redeem_allowed: разрешено ли списание ценностей. Тип boolean (true – да, false – нет).
  
  В случае отсутствия кода за период поиска, будет возвращен объект с сообщением об отсутствии кода.
```
{
  "code": 114,
  "message": "Код карты отсутствует."
}
```

Идентификаторы покупателя

Покупатель имеет один или несколько идентификатор, таких как номер телефона, email, идентификатор в социальной сети, номер пластиковой карты и т.д.

Поиск покупателя по идентификаторам

Имея идентификатор (или несколько), такой как номер телефона, email, идентификатор в социальной сети и т.д., Терминал может произвести поиск покупателей в системе inCust, содержащих указанные идентификаторы.

Запрос на поиск покупателя по идентификаторам

URL:
- /term/customers
Метод: POST
URL параметры:
- нет
Data параметры:
- identification: массив объектов идентификаторов, содержит следующие поля:
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах программы лояльности
    - business - карточка действует в пределах бизнеса

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "identification": [
              {
                  "code": "+7112233444",
                  "type": "phone"
              },
              {
                  "code": "+7112233555",
                  "type": "phone"
              },
              {
                  "code": "test.user@gmail.com",
                  "type": "email"
              },
              {
                  "code": "G_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "TEST001",
                  "type": "card",
                  "scope": "loyalty"
              }
          ]
      }
  }

Пример ответа:

  [
      {
          "birth_date": "2016-06-23",
          "country": "UA",
          "gender": "male",
          "id": "6c6b9de5-0426-4798-b307-056cad79ca2a",
          "identification": [
              {
                  "code": "+7112233444",
                  "type": "phone"
              },
              {
                  "code": "qqq@qqq.com",
                  "type": "email"
              },
              {
                  "code": "TEST111",
                  "scope": "loyalty",
                  "type": "card"
              }
          ],
          "language": "ru",
          "name": "Тест 1"
      },
      {
          "birth_date": "1913-09-20",
          "country": "UA",
          "gender": "male",
          "id": "0573eb97-fe7f-46fc-9fb2-5495074de415",
          "identification": [
              {
                  "code": "+7112233555",
                  "type": "phone"
              },
              {
                  "code": "TEST001",
                  "scope": "loyalty",
                  "type": "card"
              },
              {
                  "code": "TEST010",
                  "scope": "loyalty",
                  "type": "card"
              }
          ],
          "language": "uk",
          "name": "Test 2"
      },
      {
          "birth_date": "2015-12-31",
          "country": "UA",
          "id": "233bcf69-38c6-4268-9ac9-dcb03382430f",
          "identification": [
              {
                  "code": "+7111111111",
                  "type": "phone"
              },
              {
                  "code": "G_111222333444",
                  "type": "social-network"
              }
          ],
          "language": "ru",
          "name": "SN test"
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив объектов, содержащих данные о найденных покупателях:
- id: уникальный идентификатор покупателя в системе inCust
- name: имя покупателя
- language: язык покупателя (ISO код языка)
- country: страна покупателя (ISO код страны)
- birth_date: день рождения покупателя
- gender: пол покупателя
- identification: массив объектов идентификаторов покупателя:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса

Регистрация покупателя с заданными идентификаторами

Терминал может зарегестрировать нового покупателя в системе inCust, используя набор его идентификаторов, таких как номер телефона, email, идентификатор в социальной сети и т.д..

Запрос на регистрацию покупателя с заданными идентификаторами

URL:
- /term/customers/add
Метод: POST
URL параметры:
- нет
Data параметры:
- name: имя покупателя
- language: язык покупателя (ISO код языка)
- country: страна покупателя (ISO код страны)
- birth_date: день рождения покупателя
- gender: пол покупателя
- identification: массив объектов идентификаторов, содержит следующие поля:
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "country": "UA",
          "language": "ru",
          "name": "test",
          "identification": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+7112221111",
                  "type": "phone"
              }
          ]
      }
  }

Пример ответа:

  {
      "country": "UA",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "code": "+7112221111",
              "type": "phone"
          },
          {
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "ru",
      "name": "test"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные о зарегистрированном покупателе:
- id: уникальный идентификатор покупателя в системе inCust
- name: имя покупателя
- language: язык покупателя (ISO код языка)
- country: страна покупателя (ISO код страны)
- birth_date: день рождения покупателя
- gender: пол покупателя
- identification: массив объектов идентификаторов покупателя:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса
  В случае если в системе существуют покупатели с такими идентификаторами, будет возвращен объект с сообщением об ошибке.
```
{
  "code": 28,
  "message": "Покупатель с такими идентификаторами уже существует"
}
```

Получение идентификаторов покупателя

Терминал может получить все идентификаторы покупателя в системе inCust.

Запрос на получение идентификаторов покупателя

URL:
- /term/customers/{{id}}/{{id_type}}/identification
- /term/customers/{{id}}/identification - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет
Пример запроса:
```
  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/customers/+7112233444/phone/identification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }
```
Пример url для упрощенного вызова:
1. для номера телефона https://api.incust.com/v1/term/customers/+7112233444/identification
2. для номера карты https://api.incust.com/v1/term/customers/123456/identification
3. для кода заказа https://api.incust.com/v1/term/customers/@123456/identification
4. для QR кода https://api.incust.com/v1/term/customers/1,+7112233444,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394/identification

Пример ответа:

  {
      "country": "UA",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d63",
              "code": "+7112221111",
              "type": "phone"
          },
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d65",
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "ru",
      "name": "test"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные о зарегистрированном покупателе:
- id: уникальный идентификатор покупателя в системе inCust
- name: имя покупателя
- language: язык покупателя (ISO код языка)
- country: страна покупателя (ISO код страны)
- birth_date: день рождения покупателя
- gender: пол покупателя
- identification: массив объектов идентификаторов покупателя:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карт, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса

Добавление идентификаторов покупателя

Терминал может добавить идентификаторы покупателю в системе inCust.

Запрос на добавление идентификаторов покупателя

URL:
- /term/customers/{{id}}/{{id_type}}/identification
- /term/customers/{{id}}/identification - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- массив объектов идентификаторов, содержит следующие поля:
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/+7112233444/phone/identification",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+7112221111",
                  "type": "phone"
              }
      ]
  }

Пример ответа:

  [
      {
          "added": true,
          "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b91",
          "code": "+7112221111",
          "type": "phone"
      },
      {
          "added": false,
          "error": "Покупатель с такими идентификаторами уже существует",
          "code": "FB_111222333444",
          "type": "social-network"
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий массив объектов идентификаторов:
- массив объектов идентификаторов покупателя:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса
  - added, type: boolean, статус добавления идентификатора
  - error, type: string, описание ошибки

Удаление идентификаторов покупателя

Терминал может удалить некоторые идентификаторы покупателя в системе inCust, такие как номера пластиковых карт и т.д.

Запрос на удаление идентификаторов покупателя

URL:
- /term/customers/{{id}}/{{id_type}}/identification/delete
- /term/customers/{{id}}/identification/delete - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- массив объектов идентификаторов, содержит следующие поля:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/+7112233444/phone/identification/delete",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
              {
                  "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b90",
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b91",
                  "code": "+7112221111",
                  "type": "phone"
              }
      ]
  }

Пример ответа:

  [
      {
          "deleted": false,
          "error": "Operation not permitted",
          "code": "+7112221111",
          "type": "phone"
      },
      {
          "deleted": true,
          "code": "FB_111222333444",
          "type": "social-network"
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий массив объектов идентификаторов:
- массив объектов идентификаторов покупателя:
  - id, type: string, уникальный идентификатор идентификатора
  - code, type: string, значение идентификатора
  - type, type: string, тип идентификатора:
    - phone - номер телефона в международном формате ('+' в начале номера обязателен)
    - qr - QR код из приложения inCust
    - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
    - card - номер пластиковой карты
    - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
    - id - идентификатор покупателя в системе inCust
    - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
    - ssn - номер социального страхования для граждан и резидентов США
    - itin - индивидуальный налоговый номер
  - scope, type: string, только для пластиковых карточек, область действия идентификатора:
    - loyalty - карточка действует в пределах лояльности
    - business - карточка действует в пределах бизнеса
  - deleted, type: boolean, статус удаления идентификатора
  - error, type: string, описание ошибки

Купоны

Работа с купонами.

Выпуск купонов серии

Выпуск купонов по указанной серии. Выпущенные купоны не добавлены к покупателю в кошелек.

Запрос на выпуск купонов серии

URL:
- /term/coupons/batch/{{code}}/emission
Метод: GET
URL параметры:
- code: код серии купонов
- count: количество купонов, которое надо выпустить
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/coupons/batch/1111-1111-1111/emission?count=5,
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_amount":1,
           "recommendation_fee_bonuses_currency":"RUB",
           "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
           "recommendation_fee_promotional_bonuses_expire_type":"date",
           "recommendation_fee_promotional_bonuses_expire_value":0,
           "recommendation_fee_type":"promotional-bonuses",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"192059545592",
        "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
        "status":"open"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов купонов

Получение данных о купоне

Получение данных о купоне по коду или внешнему коду.

Запрос на получение данных о купоне

URL:
- /term/coupons/coupon/get
Метод: POST
URL параметры:
- нет
Data параметры:
- code: код купона
- external_code: внешний код купона

Пример запроса:

  {
     "method":"POST",
     "url":"/term/coupons/coupon/get",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data": { "code": 246990359478 }
  }

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов купонов

Использование купона без покупателя

Купоны типа «внешний купон» могут быть использованы без покупателя.

Использование купона без покупателя

URL:
- /term/coupons/redeem
Метод: POST
URL параметры:
- нет

Data параметры:

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"ru",
    "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
 },
 "data":[
    { "id": "4081a81a-1483-11e7-898a-020000ed147d" },
    { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }
 ]
}

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив с объектами типа купон, объект "купон" будет дополнительно содержать поле redeemed, содержащее результат применения купона, возможные значения true или false

Список купонов добавленных в кошелек покупателя

В список включены все купоны, добавленные в кошелек покупателя, которые не были погашены и просрочены.

Запрос на получение списка купонов добавленных в кошелек покупателя

URL:
- /term/coupons/{{id}}/{{id_type}}
- /term/coupons/{{id}} - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_amount":1,
           "recommendation_fee_bonuses_currency":"RUB",
           "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
           "recommendation_fee_promotional_bonuses_expire_type":"date",
           "recommendation_fee_promotional_bonuses_expire_value":0,
           "recommendation_fee_type":"promotional-bonuses",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"192059545592",
        "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
        "status":"open"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов купонов

Добавление купона в кошелек покупателя

Запрос на добавление купона в кошелек

URL:
- /term/coupons/{{id}}/{{id_type}}/add
- /term/coupons/{{id}}/add - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- массив объектов c полем code, содержащим код купона, например [{ "code": 246990359478 }, { "code": 192059545592 }]

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":[
        { "code": 246990359478 },
        { "code": 192059545592 }
     ]
  }

Пример ответа:

  {
      "codes":[
         {
            "code":"246990359478",
            "valid":true
         },
         {
            "code":"192059545592",
            "valid":true
         }
      ],
      "coupons":[
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
               "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание купона",
               "public_title":"Название купона",
               "share_allowed":0,
               "type":"check-modifier"
            },
            "code":"246990359478",
            "id":"4081a81a-1483-11e7-898a-020000ed147d",
            "status":"open"
         },
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Описание купона",
               "public_title":"Название купона",
               "recommendation_fee_amount":1,
               "recommendation_fee_bonuses_currency":"RUB",
               "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
               "recommendation_fee_promotional_bonuses_expire_type":"date",
               "recommendation_fee_promotional_bonuses_expire_value":0,
               "recommendation_fee_type":"promotional-bonuses",
               "share_allowed":1,
               "type":"certificate"
            },
            "code":"192059545592",
            "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
            "status":"open"
         }
      ],
      "message":"Купоны и сертификаты были добавлены в кошелек покупателя в количестве 2 шт. Из них в данной точке продажи покупатель сумеет увидеть и использовать 2 шт.\nПолный список своих купонов и сертификатов покупатель может просмотреть в кошельке в мобильном приложении inCust."
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет объект с полями:
- codes: массив объектов, содержащих поля:
  - code: код купона
  - valid: валидность купона, значения true или false
- coupons: массив объектов купонов

Использование купона типа "сертификат"

URL:
- /term/coupons/{{id}}/{{id_type}}/redeem
- /term/coupons/{{id}}/redeem - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер

Data параметры:

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/+7112233444/phone/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"ru",
    "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
 },
 "data":[
    { "id": "4081a81a-1483-11e7-898a-020000ed147d" },
    { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }
 ]
}

Пример ответа:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Описание купона",
           "public_title":"Название купона",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив с объектами типа купон, объект "купон" будет дополнительно содержать поле redeemed, содержащее результат применения купона, возможные значения true или false

Выгоды

Выгоды это некоторые баллы или ценности, начисляемые на специальные счета покупателей или на бонусный счет покупателя.
Бонусные баллы могут быть акционными (имеют свой срок действия и "сгорают" по его истечению) или стандартными, срок жизни которых не ограничен.

Начисление выгоды покупателю

Метод позволяет начислить выгоды покупателю.

Запрос на начисление выгоды покупателю

URL: /term/charge_benefits
Метод: POST
URL параметры:
- нет
Data параметры:
- id_type: необязательный тип идентификатора покупателя.
  На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
- type: тип выгоды, возможные значения 'regular-bonuses', 'promotional-bonuses', 'special-account'
- special_account_id: ID счета покупателя (для типа выгоды special-account)
- currency: валюта бонусных баллов (ISO 4217) (для типа выгоды regular-bonuses, promotional-bonuses)
- amount: количество начисляемых баллов / ценностей
- promotional_bonuses_expire_date: дата (указанная дата не включается, т.е. время действия до 0000 указанной даты) в форматеYYYY-MM-DD, до которой действительны бонусы (для типа выгоды promotional-bonuses)
- comment: комментарий
- id: идентификатор покупателя. Если тип идентификатора не указан в параметра id_type, то значение параметра id может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust

Пример запроса на начисление бонусов:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+7112233444",
        "type": "regular-bonuses",
        "currency": "RUB",
        "amount": 10,
        "comment": "Комментарий к начислению"
     }
  }

Пример запроса на начисление акционных бонусов:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+7112233444",
        "type": "promotional-bonuses",
        "promotional_bonuses_expire_date": "2018-10-09",
        "currency": "RUB",
        "amount": 20,
        "comment": "Комментарий к начислению"
     }
  }

Пример запроса на начисление на счет покупателя:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+7112233444",
        "type": "special-account",
        "special_account_id": "1118c8d9-360e-4edc-9a32-d6187b833222",
        "amount": 10,
        "comment": "Комментарий к начислению"
     }
  }

Пример ответа:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"RUB",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"promotional_bonuses_expire_date\":\"2018-10-09\",\"type\":\"promotional-bonuses\",\"currency\":\"RUB\",\"id\":\"+7112233444\",\"comment\":\"Комментарий к начислению\",\"amount\":20}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type": "bonus-add",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с информацией о проведенной операции.
- id: идентификатор чека/транзакции
- amount: сумма операции
- amount_to_pay: сумма к оплате
- bonuses_added: бонусов начислено
- bonuses_on_account: бонусов на счету у покупателя
- bonuses_redeemed: бонусов списано
- comment: комментарий к транзакции

Туристическая карта (карта предоплаченных услуг)

Туристическая карта это некая виртуальная карта, которая содержит в себе набор предоплаченных услуг.

Объект туристической карты содержит следующие поля:

- **id**: ID туристической карты  
- **code**: код туристической карты
- **public_title**: публичное название карты  
- **public_description**: публичное описание карты  
- **image**: изображение карты, ссылка на картинку  
- **active**: признак, активирована ли карта  
- **activated_dt**: дата/время активации (в формате `'YYYY-MM-DD HH-mm-ss'`)  
- **expire_dt**: дата/время срока действия карты (в формате `'YYYY-MM-DD HH-mm-ss'`)  
- **valid**: признак, действительна ли карта  
- **accounts**: массив объектов счета, содержит данные о счетах, доступных по карте, содержит следующие поля  
    - **id**: ID счета  
    - **public_title**: публичное название счета  
    - **precision**: точность счета, возможные значения `'integer'`, `'two-decimal-places'`, `'three-decimal-places'`  
    - **amount**: остаток на счету  
- **services**: массив объектов услуги, содержит данные об услугах, доступных по карте, содержит следующие поля  
    - **id**: ID услуги  
    - **public_title**: публичное название услуги  
    - **public_description**: публичное описание услуги  
    - **category**: объект категории услуг, содержит данные о категории, к которой принадлежит услуга, содержит следующие поля  
        - **id**: ID категории  
        - **public_title**: публичное название категории  
    - **decrement_step**: шаг декрементации (использования) счета  
    - **usage_limit_per_loyalty**: ограничение по количеству раз на использование в программе лояльности (если `0` - без ограничения)  
    - **usage_limit_per_loyalty_period_type**: тип периода ограничения, возможные значения `'all-card-time'`, `'hour'`, `'day'`, `'month'`  
    - **usage_limit_per_loyalty_period_value**: величина периода ограничения (напр. 7 для дней означает неделю) 
    - **usage_limit_per_pos**: ограничение по количеству раз на использование в точке продажи (если `0` - без ограничения)  
    - **usage_limit_per_pos_period_type**: тип периода ограничения, возможные значения `'all-card-time'`, `'hour'`, `'day'`, `'month'`  
    - **usage_limit_per_pos_period_value**: величина периода ограничения  
    - **used_times**: использовано раз, количество  
    - **available_times**: доступно к использованию раз, количество, рассчетное значение  
    - **available_amount**: остаток на счету  
    - **available_now**: доступность услуги в данный конкретный момент времени

Список туристических карт покупателя

В список включены все туристические карты, добавленные в кошелек покупателя.

Запрос на получение списка туристических карт покупателя

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards
- /term/tour_card/{{id}}/cards - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/tour_card/+7112233444/cards,
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Пример ответа:

  [
      {
          "accounts": [
              {
                  "amount": 0,
                  "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                  "precision": "integer",
                  "public_title": "Название счета"
              }
          ],
          "activated_dt": "2018-06-20T09:57:47.225000Z",
          "active": 1,
          "code": "570237733572",
          "expire_dt": "2018-08-20T09:57:47.225000Z",
          "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
          "public_title": "Название карты",
          "public_description": "Описание карты",
          "services": [
              {
                  "available_amount": 0,
                  "available_now": 0,
                  "available_times": 0,
                  "category": {
                      "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                      "public_title": "Название категории услуг"
                  },
                  "decrement_step": 5,
                  "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                  "public_title": "Название услуги",
                  "public_description": "Описание услуги",
                  "usage_limit_per_loyalty": 0,
                  "usage_limit_per_loyalty_period_type": "all-card-time",
                  "usage_limit_per_loyalty_period_value": 0,
                  "usage_limit_per_pos": 3,
                  "usage_limit_per_pos_period_type": "hour",
                  "usage_limit_per_pos_period_value": 1,
                  "used_times": 10
              }
          ],
          "valid": 1
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов туристическая карта

Добавление туристической карты в кошелек покупателя

Метод позволяет добавить туристическую карту в кошелек покупателя. Возврашает список туристических карт, добавленных в кошелек покупателя.

Запрос на добавление туристической карты в кошелек покупателя

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/add
- /term/tour_card/{{id}}/cards/add - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- card_id: ID туристической карты

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+7112233444/cards/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "card_id": "609d58d7-7470-11e8-a7b9-020000000000"
     }
  }

Пример ответа:

  [
      {
          "accounts": [
              {
                  "amount": 0,
                  "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                  "precision": "integer",
                  "public_title": "Название счета"
              }
          ],
          "activated_dt": "2018-06-20T09:57:47.225000Z",
          "active": 1,
          "code": "570237733572",
          "expire_dt": "2018-08-20T09:57:47.225000Z",
          "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
          "public_title": "Название карты",
          "public_description": "Описание карты",
          "services": [
              {
                  "available_amount": 0,
                  "available_now": 0,
                  "available_times": 0,
                  "category": {
                      "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                      "public_title": "Название категории услуг"
                  },
                  "decrement_step": 5,
                  "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                  "public_title": "Название услуги",
                  "public_description": "Описание услуги",
                  "usage_limit_per_loyalty": 0,
                  "usage_limit_per_loyalty_period_type": "all-card-time",
                  "usage_limit_per_loyalty_period_value": 0,
                  "usage_limit_per_pos": 3,
                  "usage_limit_per_pos_period_type": "hour",
                  "usage_limit_per_pos_period_value": 1,
                  "used_times": 10
              }
          ],
          "valid": 1
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет массив объектов туристическая карта

Получение данных о туристической карте

Поиск туристической карты по коду и получение информации о ней.

Запрос на получение данных о туристической карте

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/code
- /term/tour_card/{{id}}/cards/code - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
- /term/tour_card/cards/code - без идентификации покупателя.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- code: код туристической карты

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+7112233444/cards/code",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "code": "570237733572"
     }
  }

Пример ответа:

  {
      "accounts": [
          {
              "amount": 0,
              "id": "2a72c955-5bed-4988-802b-3841f92ca016",
              "precision": "integer",
              "public_title": "Название счета"
          }
      ],
      "activated_dt": "2018-06-20T09:57:47.225000Z",
      "active": 1,
      "code": "570237733572",
      "expire_dt": "2018-08-20T09:57:47.225000Z",
      "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
      "public_title": "Название карты",
      "public_description": "Описание карты",
      "services": [
          {
              "available_amount": 0,
              "available_now": 0,
              "available_times": 0,
              "category": {
                  "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                  "public_title": "Название категории услуг"
              },
              "decrement_step": 5,
              "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
              "public_title": "Название услуги",
              "public_description": "Описание услуги",
              "usage_limit_per_loyalty": 0,
              "usage_limit_per_loyalty_period_type": "all-card-time",
              "usage_limit_per_loyalty_period_value": 0,
              "usage_limit_per_pos": 3,
              "usage_limit_per_pos_period_type": "hour",
              "usage_limit_per_pos_period_value": 1,
              "used_times": 10
          }
      ],
      "valid": 1
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос прийдет объект туристическая карта

Использование услуги из туристической карты

Однократное использование услуги, доступной по туристической карте

Запрос на использование услуги из туристической карты

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/service/use
- /term/tour_card/{{id}}/cards/service/use - упрощенный, без указания типа идентификатора; поддерживает только идентификаторы типа номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
- /term/tour_card/cards/service/use - без идентификации покупателя.
Метод: POST
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
Data параметры:
- card_id: ID туристической карты
- service_id: ID услуги

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+7112233444/cards/service/use",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "card_id": "609d58d7-7470-11e8-a7b9-020000000000",
        "service_id": "709d58d7-7470-11e8-a7b9-020000000000"
     }
  }

Пример ответа:

  {
      "accounts": [
          {
              "amount": 0,
              "id": "2a72c955-5bed-4988-802b-3841f92ca016",
              "precision": "integer",
              "public_title": "Название счета"
          }
      ],
      "activated_dt": "2018-06-20T09:57:47.225000Z",
      "active": 1,
      "code": "570237733572",
      "expire_dt": "2018-08-20T09:57:47.225000Z",
      "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
      "public_title": "Название карты",
      "public_description": "Описание карты",
      "services": [
          {
              "available_amount": 0,
              "available_now": 0,
              "available_times": 0,
              "category": {
                  "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                  "public_title": "Название категории услуг"
              },
              "decrement_step": 5,
              "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
              "public_title": "Название услуги",
              "public_description": "Описание услуги",
              "usage_limit_per_loyalty": 0,
              "usage_limit_per_loyalty_period_type": "all-card-time",
              "usage_limit_per_loyalty_period_value": 0,
              "usage_limit_per_pos": 3,
              "usage_limit_per_pos_period_type": "hour",
              "usage_limit_per_pos_period_value": 1,
              "used_times": 10
          }
      ],
      "valid": 1
  }

Замечания:
В случае правильно сформированного запроса и корректных данных услуга будет однократно использована и в ответе на запрос прийдет объект туристическая карта

Магазин

Программа лояльности может иметь активированным Магазин, в котором покупатели могут оформлять заказы, используя мобильное приложение.
Используя API Терминала эти заказы можно оплатить, отгрузить или отменить.

Объект заказа содержит следующие поля:

id: ID заказа
created: дата/время создания заказа (в формате 'YYYY-MM-DD HH-mm-ss')
number: номер заказа
payment_method: способ оплаты заказа:
- payment-at-checkout - оплата при оформлении
- payment-upon-receipt - оплата при получении
paid: признак, оплачен ли заказ
status: статус заказа:
- created - создан
- inprocess - обрабатывается
- delivered - отгружен/доставлен
- canceled - отменен
user_id: идентификатор покупателя
check: объект чека, описанный в разделе Подготовка чека. Этот объект используется для дальнейшей оплаты заказа и фиксации транзакции по заказу (Запись чека с финализацией).
transaction: массив объектов транзакций, зафиксированных за заказом (описание объекта в разделе Получение списка транзакций)
shipping: объект доставки заказа, включает в себя следующие поля:
- delivery: объект способа доставки
- ship_to: объект адреса доставки
- delivery_date: дата доставки
- delivery_time: время доставки

Список заказов покупателя

Постраничный список заказов покупателя, отфильтрованный по дате, а также признаку оплаты/неоплаты.

Запрос на получение списка заказов покупателя

URL:
- /online_store/{id}/{id_type}/orders
- /term/online_store/{id}/orders - упрощенный, без указания типа идентификатора (поддерживает только идентификаторы типа: номер телефона в международном формате ('+' в начале номера обязателен), номер пластиковой карты, код заказа ('@' в начале кода обязателен) или QR код из приложения inCust.
Метод: GET
URL параметры:
- id: идентификатор покупателя. Для упрощенного метода может быть только номером телефона в международном формате ('+' в начале номера обязателен), номером пластиковой карты, кодом заказа ('@' в начале кода обязателен) или QR кодом из приложения inCust
- id_type: тип идентификатора покупателя. На данный момент в системе поддерживаются:
  - phone - номер телефона в международном формате ('+' в начале номера обязателен)
  - qr - QR код из приложения inCust
  - email - адрес электронной почты покупателя (тот, что используется для входа в систему inCust)
  - card - номер пластиковой карты
  - temporary-card - код заказа, сгенерированный программой inCust Терминал в режиме Стюард
  - id - идентификатор покупателя в системе inCust
  - social-network - идентификатор покупателя в социальной сети, с префиксом FB_ для Facebook и G_ для Google
  - ssn - номер социального страхования для граждан и резидентов США
  - itin - индивидуальный налоговый номер
- date_from, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- date_to, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- page, type integer, страница в разбиении на страницы, счет страниц начинается c 1
- count, type integer, размер выборки в разбиении на страницы,
- not_paid_only, type boolean, возвращать только неоплаченные заказы
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/+7112233444/orders?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=3&not_paid_only=true",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с двумя полями:
- orders: массив объектов заказ
- total: общее количество заказов в выборке

Список заказов

Постраничный список заказов, отфильтрованный по дате, а также признаку оплаты/неоплаты.

Запрос на получение списка заказов

URL:
- /term/online_store/orders
Метод: GET
URL параметры:
- date_from, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- date_to, type string, дата и время в формате YYYY-MM-DD[T]HH:mm:ss[Z]
- page, type integer, страница в разбиении на страницы, счет страниц начинается c 1
- count, type integer, размер выборки в разбиении на страницы,
- not_paid_only, type boolean, возвращать только неоплаченные заказы
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/orders?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=3&not_paid_only=true",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с двумя полями:
- orders: массив объектов заказ
- total: общее количество заказов в выборке

Получение данных о заказе

Данные о заказе.

Запрос на получение данных по заказу

URL:
- /term/online_store/orders/{order_id}
Метод: GET
URL параметры:
- order_id, type string, ID заказа
Data параметры:
- нет

Пример запроса:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/orders/0009ce9d-4e4c-4aab-94ad-c82c5db1ceac",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект заказ

Изменение статуса заказа

API терминала дает возможность изменения статуса заказа

Запрос на изменение статуса заказа

URL:
- /term/online_store/orders/{order_id}
Метод: PATCH
URL параметры:
- order_id, type string, ID заказа
Data параметры:
- status, type string, новый статус заказа:
  - inprocess - обрабатывается
  - delivered - отгружен/доставлен
  - canceled - отменен

Пример запроса:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/online_store/orders/0009ce9d-4e4c-4aab-94ad-c82c5db1ceac",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     },
     "data":{
        "status":"delivered"
     }
  }

Замечания:
В случае правильно сформированного запроса и корректных данных статус заказа будет изменен, и в ответе на запрос придет объект заказ

Задачи

В системе inCust можно фиксировать задачи для внешних модулей и устройств (колонки АЗС, места электрозарядки автомобилей, парковки и т.д).
Задачи могут быть закреплены за чеком либо быть независимым объектом, который в последствии может быть закреплены за чеком.

Объект задачи

Задача это сложный объект, данные которого зависят от типа (налив топлива, электрозарядка автомобиля и т.д.) выполняемой задачи.

пример информации о задаче:

{
  "auto_capture_parent_transaction": true,
  "auto_start": true,
  "created": "2020-05-06T08:32:12.369000Z",
  "details": {
      "fuel": {
          "captured_amount": 0,
          "captured_price": 0,
          "captured_volume": 0,
          "controller": "0034003A0034003A0034003A",
          "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
          "controller_type": "pts-2",
          "filled_amount": 0.0,
          "filled_volume": 0.0,
          "filling_doze": 1000.0,
          "filling_price": 10.0,
          "filling_price_currency": "RUB",
          "filling_price_type": "currency",
          "filling_type": "amount",
          "goods_code": "Petrol 95",
          "nozzle": "4",
          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
          "pump": "1",
          "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
          "status": "filling-finished"
      },
      "source_data": {
          "auto_start": true,
          "details": {
              "fuel": {
                  "filling_doze": 1000.0,
                  "filling_price": 10.0,
                  "filling_price_currency": "RUB",
                  "filling_price_type": "currency",
                  "filling_type": "amount",
                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
              }
          },
          "type": "fuel"
      },
      "start": {
          "command": "job_starting",
          "comment": "auto_start",
          "processed": "2020-05-06 08:32:15"
      }
  },
  "finalize_transaction_id": "6c3988e0-8f74-11ea-b744-020000ed147d",
  "finished": "2020-05-06T08:34:11.167000Z",
  "id": "dd116021-e344-486e-90ae-325ed9570f05",
  "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
  "pos_id": "b4e31526-0d35-11e6-bfd1-020000ed147d",
  "started": "2020-05-06T08:32:15.388000Z",
  "status": "finished",
  "terminal_id": "b40961ee-0d35-11e6-bfd1-020000ed147d",
  "transaction_id": "12374b93-8f74-11ea-b744-020000ed147d",
  "type": "fuel"
}

id: уникальный идентификатор задачи
type: тип платежа
- fuel - налив топлива
status: статус задачи
- created - задача создана
- starting - задача запускается на обработку
- inprocess - задача в процессе обработки
- stopping - задача в процессе принудительной остановки
- finished - задача завершена
created: Дата и время создания задачи в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
started: Дата и время запуска задачи в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
finished: Дата и время завершения задачи в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
auto_start: флаг, передаваемый при создании задачи, указывает системе на необходимость автоматически запустить задачу в обработку сразу после ее создания
auto_capture_parent_transaction: флаг, указывающий на то, что по завершении задачи автоматически должно произойти списание средств, зарезервированных по чеку. действителен только при создании задачи, закрепленной за чеком, по которому произведено резервирование средств.
transaction_id: уникальный идентификатор транзакции, за которой закреплена задача
finalize_transaction_id: уникальный идентификатор транзакции, по которой было произведено списание ранее зарезервированных средств
finalize_transaction_failed: признак того, что попытка списания ранее зарезервированных средств не удалась
finalize_transaction_errors: массив ошибок, вызванных попыткой списания ранее зарезервированных средств. Объект ошибок описан в объекте транзакции
details: объект детализации задачи (зависит от типа задачи), содержит следующие поля:
- source_data: объект с исходными данными задачи
- fuel: объект детализации состояния налива топлива (действителен только для задачи с типом fuel):
  - filling_price, type: number, цена единицы объема топлива
  - filling_price_type, type: string, тип цены единицы топлива:
    - currency - оплата деньгами
    - special-account - оплата со счета покупателя
  - filling_price_currency, type: string, ISO код валюты, в которой указана цена единицы топлива
  - filling_price_special_account_id, type: string, уникальный идентификатор счета покупателя, в котором указана цена единицы топлива
  - filling_price_unit, type: string, единица, в которой указана цена единицы топлива
  - filling_type, type: string, тип дозы топлива, которая должна быть отпущена:
    - amount - доза топлива это сумма, на которую необходимо отпустить топливо
    - volume - доза топлива это объем топлива, который необходимо отпустить
  - filling_doze, type: number, сумма, на которую необходимо отпустить топливо или объем топлива, который необходимо отпустить, в зависимости от filling_type
  - status: статус выполнения
    - waiting-for-process - задача ожидает обработки колонкой
    - pump-is-offline - колонка не подключена или не отвечает
    - pump-is-busy - колонка занята обработкой другой задачи (открыт другой чек)
    - nozzle-not-taken-up - на колонке не снято никакого пистолета
    - wrong-nozzle-taken-up - на колонке снят другой пистолет
    - ready-for-filling - колонка готова к отпуску топлива
    - filling - отпуск топлива
    - filling-stopping - отпуск топлива в процессе принудительной остановки
    - filling-finished - отпуск топлива завершен
    - filling-failed - сбой отпуска топлива
  - filled_volume, type: number, объем топлива, который фактически отпущен
  - filled_amount, type: number, сумма, на которую фактически отпущено топливо
  - captured_price, type: number, цена единицы объема в чеке
  - captured_volume, type: number, объем топлива, который списан по чеку
  - captured_amount, type: number, сумма, на которую произведено списание по чеку
  - transaction, type: integer, номер транзакции, присвоенный контроллером
  - controller, type: string, внутренний идентификатор устройства контроллера
  - pump, type: integer, номер колонки
  - nozzle, type: integer, номер пистолета
  - controller_id, type: string, уникальный идентификатор контроллера
  - pump_id, type: string, уникальный идентификатор колонки
  - nozzle_id, type: string, уникальный идентификатор пистолета
  - goods_code, type: string, код/артикул товара

Запрос задач по чеку

По чеку можно получить список задач, закрепленных за ним.

Запрос задач по чеку

URL:
- /term/jobs/check/{{id}}
Метод: GET
URL параметры:
- id: уникальный идентификатор транзакции, по которой надо получить задачи
Data параметры:
- нет

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/check/f5cfec5b-4cab-11ea-8e76-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Пример ответа:

  [
      {
          "auto_capture_parent_transaction": true,
          "auto_start": true,
          "created": "2020-03-11T16:35:48.715000Z",
          "details": {
              "fuel": {
                  "controller": "0034003A3435510938393730",
                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                  "controller_type": "pts-2",
                  "filled_amount": 0,
                  "filled_volume": 0,
                  "filling_doze": 3.0,
                  "filling_price": 1.0,
                  "filling_type": "amount",
                  "goods_code": "Petrol 95",
                  "nozzle": "4",
                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                  "pump": "1",
                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                  "status": "waiting-for-process"
              },
              "source_data": {
                  "auto_start": true,
                  "details": {
                      "fuel": {
                          "filling_doze": 3.0,
                          "filling_price": 1.0,
                          "filling_type": "amount",
                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                      }
                  },
                  "type": "fuel"
              },
              "start": {
                  "command": "job_starting",
                  "comment": "auto_start",
                  "processed": "2020-03-11 16:41:06"
              }
          },
          "id": "7e1d3313-c7c8-4f5c-b4ba-1e22f75c571b",
          "started": "2020-03-11T16:41:06.365000Z",
          "status": "starting",
          "transaction_id": "5a3475e8-63b6-11ea-8e76-020000ed147d",
          "type": "fuel"
      }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив объектов, содержащих данные задачи

Создание задачи с добавлением к чеку

К ранее созданному чеку можно добавить задачи.

Запрос на создание задачи с добавлением к чеку

URL:
- /term/jobs/check/{{id}}
Метод: POST
URL параметры:
- id: уникальный идентификатор транзакции, к которой надо добавить задачу
Data параметры:
- Объект задачи, которая должны быть создана и добавлена к чеку

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/check/fa2d893e-47ef-11ea-8e76-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "type": "fuel",
          "auto_capture_parent_transaction": false,
          "details": {
              "fuel": {
                  "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                  "filling_price": 20.0,
                  "filling_type": "amount",
                  "filling_doze": 200.0
              }
          },
          "auto_start": false
       }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи, которая была создана
Примечание:
- К чеку с типом резервирование средств по чеку может быть добавлена задача, которая автоматически, по завершении выполнения, будет списывать зарезервированные по чеку средства.
  Данная возможность определяется параметром задачи auto_capture_parent_transaction. Для других типов чека данный параметр игнорируется.
- Задача с включенным параметром auto_capture_parent_transaction не может быть скомбинирована с другими задачами.

Создание задачи

Задача может быть создана как отдельный независимый объект. Позднее ее можно закрепить за чеком.

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

URL:
- /term/jobs
Метод: POST
URL параметры:
- нет
Data параметры:
- Объект задачи, которая должны быть создана

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "type": "fuel",
          "auto_capture_parent_transaction": false,
          "details": {
              "fuel": {
                  "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                  "filling_price": 20.0,
                  "filling_type": "amount",
                  "filling_doze": 200.0
              }
          },
          "auto_start": false
       }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи, которая была создана

Информация о задаче

Данный метод возвращает информацию о задаче

Запрос на получение информации о задаче

URL:
- /term/jobs/{{id}}
Метод: GET
URL параметры:
- id: уникальный идентификатор задачи
Data параметры:
- нет

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи

Запуск задачи

Запуск ранее созданной задачи в работу.

Запрос на запуск задачи

URL:
- /term/jobs/{{id}}/start
Метод: POST
URL параметры:
- id: уникальный идентификатор задачи
Data параметры:
- comment: комментарий

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/start",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "comment": "test"
       }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "starting",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи

Остановка задачи

Принудительная остановка задачи.

Запрос на остановку задачи

URL:
- /term/jobs/{{id}}/stop
Метод: POST
URL параметры:
- id: уникальный идентификатор задачи
Data параметры:
- comment: комментарий

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/stop",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "comment": "test"
       }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "stopping",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи

Закрепление существующей задачи за чеком

Ранее созданную задачу, которая не закреплена за чеком, в любой момент можно закрепить за существующим чеком.

Запрос на закрепление существующей задачи за чеком

URL:
- /term/jobs/{{id}}/transaction
Метод: POST
URL параметры:
- id: уникальный идентификатор задачи
Data параметры:
- id: уникальный идентификатор транзакции, за которой необходимо закрепить задачу

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/transaction",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "id": "fa2d893e-47ef-11ea-8e76-020000ed147d"
       }
  }

Пример ответа:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, содержащий данные задачи

Топливо и энергия

В системе inCust можно подключить внешние контроллеры, которые управляют заправочными колонками и зарядными станциями.

Комплексная информация о состоянии топливных колонок и зарядных станций

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

Запрос на получение информация о состоянии топливных колонок и зарядных станций

URL:
- /term/fuel
Метод: GET
URL параметры:
- нет
Data параметры:
- нет

Пример запроса:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/fuel",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"ru",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Пример ответа:

  {
      "configuration": {
          "decimal_digits": {
              "amount": 2,
              "price": 2,
              "volume": 2
          }
      },
      "configuration_reading_status": "success",
      "configuration_updated": "2020-02-11T15:40:26.858000Z",
      "id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
      "internal_id": "0034003A3435510938393730",
      "pumps": [
          {
              "available": true,
              "id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "internal_id": "1",
              "jobs": {
                  "current": null,
                  "pending": [
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T16:53:51.504000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "start": {
                                  "command": "job_starting",
                                  "comment": "test",
                                  "processed": "2020-02-10 16:58:19"
                              }
                          },
                          "id": "26acb27d-f00b-495d-b8a4-658a96bc9248",
                          "status": "starting",
                          "type": "fuel"
                      }
                  ],
                  "recent": [
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T16:55:34.148000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "stop": {
                                  "command": "job_stopping",
                                  "comment": "test",
                                  "processed": "2020-02-10 16:56:03"
                              }
                          },
                          "id": "90840d95-1a60-4d6c-bd20-13bc84aa5b11",
                          "status": "finished",
                          "type": "fuel"
                      },
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T17:14:06.219000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "stop": {
                                  "command": "job_stopping",
                                  "comment": "test",
                                  "processed": "2020-02-10 17:14:28"
                              }
                          },
                          "finished": "2020-02-10T17:14:28.491000Z",
                          "id": "e6631ea7-4e1f-4694-8ac5-914d5df07a4b",
                          "status": "finished",
                          "type": "fuel"
                      }
                  ]
              },
              "nozzles": [
                  {
                      "code": "Petrol 92",
                      "goods": {
                          "active": 1,
                          "code": "Petrol 92",
                          "color": 4294967295,
                          "id": "8d4f580f-28c8-4966-933e-d3929a95f3a2",
                          "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
                          "price": [
                              {
                                  "currency": "RUB",
                                  "id": "dbe00788-24d3-4655-a1d1-3396e718bc6b",
                                  "price": 20.0,
                                  "type": "currency"
                              }
                          ],
                          "service_types": [
                              "fuel"
                          ],
                          "sort_order": 0,
                          "title": "Бензин А92",
                          "variable_price": 0,
                          "variable_total": 0,
                          "weighing": 0,
                          "whole_number": 1
                      },
                      "id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "internal_id": "1"
                  }
              ],
              "status": "idle",
              "status_description": "Pump is in idle state",
              "terminal_id": "b4e361ee-0d35-11e6-bfd1-020000ed147d"
          },
          {
              "available": true,
              "id": "a8e76661-e678-4ca5-9257-cf4c5ff28130",
              "internal_id": "3",
              "jobs": {
                  "current": null,
                  "pending": [],
                  "recent": []
              },
              "nozzles": [
                  {
                      "code": "Petrol 92",
                      "goods": {
                          "active": 1,
                          "code": "Petrol 92",
                          "color": 4294967295,
                          "id": "8d4f580f-28c8-4966-933e-d3929a95f3a2",
                          "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
                          "price": [
                              {
                                  "currency": "RUB",
                                  "id": "dbe00788-24d3-4655-a1d1-3396e718bc6b",
                                  "price": 20.0,
                                  "type": "currency"
                              }
                          ],
                          "service_types": [
                              "fuel"
                          ],
                          "sort_order": 0,
                          "title": "Бензин А92",
                          "variable_price": 0,
                          "variable_total": 0,
                          "weighing": 0,
                          "whole_number": 1
                      },
                      "id": "09482f0e-003a-408d-b56c-f6ee4f5f80b6",
                      "internal_id": "1"
                  }
              ],
              "status": "idle",
              "status_description": "Pump is in idle state",
              "terminal_id": "b4e361ee-0d35-11e6-bfd1-020000ed147d"
          }
      ],
      "skip_pumps_in_selection": 0
  }

Замечания:
В ответе возвращается объект, содержащий комплексную информацию о состоянии топливных колонок или зарядных станций :
- id: уникальный идентификатор контроллера
- internal_id: внутренний идентификатор устройства контроллера
- configuration: объект с конфигурацией контроллера:
  - decimal_digits: настройки десятичных цифр:
    - amount: количество десятичных цифр в значении суммы
    - price: количество десятичных цифр в значении цены
    - volume: количество десятичных цифр в значении объема
- configuration_reading_status: статус последней попытки чтения конфигурации контроллера:
  - connection-not-configured - коммуникационные настройки контроллера не заданы
  - ready-to-read - коммуникационные настройки контроллера заданы, конфигурация еще не получена
  - success - соединение успешно установлено, конфигурация получена
  - fail - ошибка соединения с контроллером
- configuration_updated: Дата и время последнего чтения конфигурации в формате YYYY-MM-DD[T]HH:mm:ss[Z], часовой пояс UTC
- skip_pumps_in_selection: флаг, указывающий на тип выбора заправочного или зарядного места:
  - 0 - сначала выбор колонки или станции, потом пистолета или коннектора
  - 1 - выбор пистолета или коннектора без выбора колонки или станции (вывод всех доступных пистолетов или коннекторов всех колонок или станций единым списком)
- pumps: список объектов с информацией о колонках или станциях:
  - id: уникальный идентификатор колонки или станции
  - internal_id: номер колонки или станции
  - terminal_id: уникальный идентификатор Терминала, который подключен к колонке или станции
  - available: признак того, что колонка или станция доступна для операции отпуска топлива или энергии (включена, на связи и не занята другой операцией)
  - status: состояние колонки или станции:
    - idle - колонка или станция находится в состоянии ожидания
    - filling - колонка или станция находится в состоянии отпуска топлива или энергии
    - end-of-transaction - колонка или станция завершила отпуск топлива или энергии
    - offline - колонка или станция не подключена или не отвечает
  - status_description: описание состояния колонки или станции
  - nozzles: список пистолетов, находящихся на данной колонке или станции:
    - id: уникальный идентификатор пистолета или коннектора
    - internal_id: номер пистолета или коннектора
    - up: признак того, что пистолет или коннектор снят с колонки или станции
    - code: код топлива или энергии, отпускаемого с данного пистолета или коннектора
    - goods: объект товара, соответствующего коду топлива или энергии, отпускаемого с данного пистолета или коннектора
  - jobs: список задач, относящихся к данной колонке или станции:
    - current: текущая задача, обрабатываемая колонкой или станцией
    - recent: список задач, обработанных колонкой или станцией (десять последних задач)
    - pending: список задач, ожидающих свою очередь быть обработанными колонкой или станцией

Товары и категории в бренде

Используя API Терминала можно создавать и редактировать товары и категории в бренде

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

URL: /term/loyalty/goods
Метод: GET
URL параметры:
- only_active
  - 'true' – возвращает только активные товары
  - 'false' – возвращает все товары (по умолчанию)
Data параметры:
- нет

Пример запроса:

{
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods",
   "headers":{
      "Content-Type":"application/json",
      "Accept-Language":"ru",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5g1YA.q6yWPEECM12jhAzphz2BOWNO8mg"
   }
}

Пример ответа:

[
   {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Напитки",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Напитки",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Предоплата за кофе",
               "title":"Предоплата за кофе",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":10,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Кофе",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"11111",
      "color":4294967295,
      "id":"4ce153e5-8ed9-4840-bcd3-e0f77536e055",
      "image":{
         "id":"9d377a96-ee6e-4322-88a2-c56563131537",
         "url":"https://api.incust.com/static/b0/67/d83f371e4bc998896556f16970e7.jpeg"
      },
      "image_id":"9d377a96-ee6e-4322-88a2-c56563131537",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Пицца",
      "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
      "parent_title":"Пицца",
      "price":[
         {
            "id":"ec708edb-c334-43c1-b322-9f267c14748d",
            "price":20,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"375f47d9-8338-4861-a7d1-d690d6c77203",
            "price":80,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Пицца 5 сыров",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"12344",
      "color":4294967295,
      "id":"5b6a423d-9a05-470c-a0c4-aaa0400433a8",
      "image":{
         "id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
         "url":"https://api.incust.com/static/59/15/ec56e3964316a57ef51f90690cd1.jpeg"
      },
      "image_id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Пицца",
      "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
      "parent_title":"Пицца",
      "price":[
         {
            "id":"21185186-db47-409c-954c-24e1f1119152",
            "price":40,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"e25d31df-9f2c-4a05-a7c6-637acc27e1af",
            "price":95,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Пицца мясная",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"54321",
      "color":4294967295,
      "id":"880abda0-04c2-4779-a93d-92d5273ec5eb",
      "image":{
         "id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
         "url":"https://api.incust.com/static/50/76/5c1b743f450aa3c4be7c7ab887d9.jpeg"
      },
      "image_id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Напитки",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Напитки",
      "price":[
         {
            "id":"4c608c24-2a6b-4664-b409-b51ff4ffb170",
            "price":5,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"fe535973-5236-4b7f-a515-747a4741030d",
            "price":25,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Чай имбирный",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"3113",
      "color":4294967295,
      "id":"fbed57fb-207e-4b55-8da7-dae8e1896d84",
      "image":{
         "id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
         "url":"https://api.incust.com/static/04/1b/e6235b1c420e950bd50908d8c844.jpeg"
      },
      "image_id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Десерти",
      "parent_id":"e609f66f-9bd2-4352-8b71-bd3228774ff2",
      "parent_title":"Десерти",
      "price":[
         {
            "id":"71f4f14e-7038-4895-823b-5b22166620a9",
            "price":15,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"b20975ab-ecda-4ee0-88f0-b6dbca51e1aa",
            "price":50,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Десерт черничный",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   }
]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список товаров, с
которыми работает Терминал. Каждый элемент массива является объектом, имеющим
поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету; присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо цены,
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Создание товара

URL: /term/loyalty/goods
Метод: POST
URL параметры:
- нет
Data параметры:
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- parent_id: ID родительской категории
- sort_order: порядок сортировки товара
- unit, единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо цены,
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)

Пример запроса:

{
     "method":"POST",
     "url":"https://api.incust.com/v1/term/goods",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
        "parent_id":"4729488e-051a-4238-bebb-9d40306109b3",
        "title":"Кофе",
        "code":"1444",
        "active":1,
        "color":785150463,
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     }
}

Пример ответа:

  [
     {
        "active":1,
        "code":"1444",
        "color":785150463,
        "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Напитки",
        "parent_id":"4729488e-051a-4238-bebb-9d40306109b3",
        "parent_title":"Напитки",
        "sort_order":0,
        "title":"Кофе",
        "unit":"шт",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     }
  ]

Замечания:
В случае правильно сформированного запроса в ответе будут содержаться данные товара.

URL: /term/loyalty//goods/categories
Метод: GET
URL параметры:
- only_active
  - 'true' – возвращает только активные категории
  - 'false' – возвращает все категории (по умолчанию)
Data параметры:
- нет

Пример запроса:

 { 
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods/categories",
   "headers":{ 
      "Content-Type":"application/json",
      "Accept-Language":"ru",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
   }
 }

Пример ответа:

 [ 
   { 
      "active":1,
      "code":"Категория товаров 1",
      "color":3545497855,
      "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
      "title":"Категория товаров 1",
      "image":{ 
         "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
         "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
      },
      "nodes":[ 
         { 
            "active":1,
            "code":" Подкатегория товаров 1.1",
            "color":4294967295,
            "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
            "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
            "title":" Подкатегория товаров 1.1"
         }
      ]
   },
   { 
      "active":1,
      "code":"Категория товаров 2",
      "color":4294967295,
      "id":"4729488e-051a-4238-bebb-9d40306109b3",
      "title":"Категория товаров 2"
   },
   { 
      "active":1,
      "code":"Категория товаров 3",
      "color":4294967295,
      "id":"82daa2d8-774a-44df-a078-b26d41ed4290",
      "title":"Категория товаров 3"
   }
 ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список категорий
товаров, с которыми работает Терминал. Каждый элемент массива является объектом, имеющим поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- image:
  - id: ID картинки
  - url: ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый
  дочерний объект также может содержать массив nodes и т. д.

Создание категории товаров

URL: /term/loyalty/goods/categories
Метод: POST
URL параметры:
- нет
Data параметры:
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- parent_id: id родительской категории

Пример запроса:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "4729488e-051a-4238-bebb-9d40306109b3",
      "title": "Категория товаров 1",
      "active": 1,
      "color": 785150463
    }
 }

Пример ответа:

 [ 
   { 
      "active":1,
      "code":"Категория товаров 1",
      "color":3545497855,
      "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
      "title":"Категория товаров 1",
      "image":{ 
         "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
         "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
      },
      "nodes":[ 
         { 
            "active":1,
            "code":" Подкатегория товаров 1.1",
            "color":4294967295,
            "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
            "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
            "title":" Подкатегория товаров 1.1"
         }
      ]
   },
   { 
      "active":1,
      "code":"Категория товаров 2",
      "color":4294967295,
      "id":"4729488e-051a-4238-bebb-9d40306109b3",
      "title":"Категория товаров 2"
   },
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет массив, содержащий список категорий
товаров, с которыми работает Терминал. Каждый элемент массива является объектом, имеющим поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- image:
  - id: ID картинки
  - url: ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый
  дочерний объект также может содержать массив nodes и т. д.

Получение данных о категории товаров

URL: /term/loyalty/goods/category/{id}
Метод: GET
URL параметры:
- id: ID категории
Data параметры:
- нет

Пример запроса:

 { 
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods/category/38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
   "headers":{ 
      "Content-Type":"application/json",
      "Accept-Language":"ru",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
   }
}

Пример ответа:

 [ 
   { 
      "active":1,
      "code":"Категория товаров 1",
      "color":3545497855,
      "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
      "title":"Категория товаров 1",
      "image":{ 
         "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
         "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
      },
      "nodes":[ 
         { 
            "active":1,
            "code":" Подкатегория товаров 1.1",
            "color":4294967295,
            "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
            "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
            "title":" Подкатегория товаров 1.1"
         }
      ]
   }
 ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, имеющий поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- image:
  - id: ID картинки
  - url: ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый
  дочерний объект также может содержать массив nodes и т. д.

Изменение категории товаров

URL: /term/loyalty/goods/category/{id}
Метод: PATCH
URL параметры:
- id: ID категории
Data параметры:
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- parent_id: id родительской категории

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category/82daa2d8-774a-44df-a078-b26d41ed4290",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "4729488e-051a-4238-bebb-9d40306109b3",
      "title": "Категория товаров 1",
      "active": 1,
      "color": 785150463
    }
 }

Пример ответа:

{
  "active": 1,
  "color": 785150463,
  "id": "82daa2d8-774a-44df-a078-b26d41ed4290",
  "image": {
    "id": "6df52c1d-28d5-410c-9e35-a476452544a8",
    "url": "https://incust.com/v1/storage/asset/image/6df52c1d-28d5-410c-9e35-a476452544a8?1603782421"
  },
  "image_id": "6df52c1d-28d5-410c-9e35-a476452544a8",
  "loyalty_id": "3ac1a51f-3410-11e8-8196-020000ed147d",
  "title": "Категория товаров 1"
}

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе придет объект, имеющий поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- image:
  - id: ID картинки
  - url: ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый
  дочерний объект также может содержать массив nodes и т. д.

Добавление/изменение картинки категории товаров

URL: /term/loyalty/goods/category/{id}/photo
Метод: POST
URL параметры:
- id: ID категории
Data параметры:
- картинка как binary

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category/82daa2d8-774a-44df-a078-b26d41ed4290",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "картинка как binary"
 }

Пример ответа:

{
  "active": 1,
  "color": 785150463,
  "id": "82daa2d8-774a-44df-a078-b26d41ed4290",
  "image": {
    "id": "6df52c1d-28d5-410c-9e35-a476452544a8",
    "url": "https://incust.com/v1/storage/asset/image/6df52c1d-28d5-410c-9e35-a476452544a8?1603782421"
  },
  "image_id": "6df52c1d-28d5-410c-9e35-a476452544a8",
  "loyalty_id": "3ac1a51f-3410-11e8-8196-020000ed147d",
  "title": "Категория товаров 1"
}

Замечания:
Допустимые Content-Type в заголовке — image/jpeg или image/png
В случае правильно сформированного запроса и корректных данных в ответе придет объект, имеющий поля:
- id: ID категории
- active: включена ли категория (1 – да, 0 – нет)
- code: Код/Артикул категории
- color: цвет категории (integer)
- title: название категории
- image:
  - id: ID картинки
  - url: ссылка на картинку
- nodes: массив, содержащий дочерние категории. Структура объектов массива аналогична описанной выше, каждый
  дочерний объект также может содержать массив nodes и т. д.

Получение товара по артикулу

URL: /term/loyalty/goods/code
Метод: POST
URL параметры:
- нет
Data параметры:
- code: Код/Артикул товара

Пример запроса:

  {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/code",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "code": "1444"
    }
  }

Пример ответа:

  [
   {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Напитки",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Напитки",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Предоплата за кофе",
               "title":"Предоплата за кофе",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":10,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Кофе",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   }
  ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться данные товара, имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Получение товара по ID

URL: /term/loyalty/goods/{id}
Метод: GET
URL параметры:
- id: ID товара
Data параметры:
- нет

Пример запроса:

 {
    "method": "GET",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    }
 }

Пример ответа:

    {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Напитки",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Напитки",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Предоплата за кофе",
               "title":"Предоплата за кофе",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Вознаграждение за визит",
               "title":"Вознаграждение за визит",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"RUB",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":10,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Кофе",
      "unit":"шт",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
    }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться данные товара, имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Изменение товара

URL: /term/loyalty/goods/{id}
Метод: PATCH
URL параметры:
- id: ID товара
Data параметры:
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- parent_id: ID родительской категории
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "title": "Кофе",
      "active": 1,
      "color": 4294967295
    }
 }

Пример ответа:

{
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Напитки",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Напитки",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Предоплата за кофе",
          "title": "Предоплата за кофе",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Вознаграждение за визит",
          "title": "Вознаграждение за визит",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "RUB",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Кофе",
    "unit": "шт",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Активация/деактивация товара

URL: /term/loyalty/goods/{id}/active
Метод: PATCH
URL параметры:
- id: ID товара
Data параметры:
- active: включен ли товар (1 – да, 0 – нет)

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/5130ac00-f142-4ec1-a320-8bcaa1ff6ea8/active",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "active": 0
    }
 }

Пример ответа:

{
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Напитки",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Напитки",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Предоплата за кофе",
          "title": "Предоплата за кофе",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Вознаграждение за визит",
          "title": "Вознаграждение за визит",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "RUB",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Кофе",
    "unit": "шт",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Добавление дополнительной картинки товара

URL: /term/loyalty/goods/{id}/additional_image/{image_id}
Метод: POST
URL параметры:
- id: ID товара
Data параметры:
- картинка как binary

Пример запроса:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/additional_image/1544b001-e25f-4f94-a32e-abaf801c0875",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "картинка как binary"
 }

Пример ответа:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "1544b001-e25f-4f94-a32e-abaf801c0875",
        "url": "https://api.incust.com/v1/storage/asset/image/1544b001-e25f-4f94-a32e-abaf801c0875?1603782421"
      },
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Напитки",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Напитки",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Предоплата за кофе",
          "title": "Предоплата за кофе",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Вознаграждение за визит",
          "title": "Вознаграждение за визит",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "RUB",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Кофе",
    "unit": "шт",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Замечания:
Допустимые Content-Type в заголовке — image/jpeg или image/png
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Удаление дополнительной картинки товара

URL: /term/loyalty/goods/{id}/additional_image/{image_id}
Метод: DELETE
URL параметры:
- id: ID товара
- image_id: ID дополнительной картинки товара
Data параметры:
- нет

Пример запроса:

 {
    "method": "DELETE",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/additional_image/1544b001-e25f-4f94-a32e-abaf801c0875",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    }
 }

Пример ответа:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Напитки",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Напитки",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Предоплата за кофе",
          "title": "Предоплата за кофе",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Вознаграждение за визит",
          "title": "Вознаграждение за визит",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "RUB",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Кофе",
    "unit": "шт",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Добавление основной картинки товара

URL: /term/loyalty/goods/{id}/photo
Метод: POST
URL параметры:
- id: ID товара
Data параметры:
- картинка как binary

Пример запроса:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/photo",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "картинка как binary"
 }

Пример ответа:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "1544b001-e25f-4f94-a32e-abaf801c0875",
        "url": "https://api.incust.com/v1/storage/asset/image/1544b001-e25f-4f94-a32e-abaf801c0875?1603782421"
      },
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Напитки",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Напитки",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Предоплата за кофе",
          "title": "Предоплата за кофе",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Вознаграждение за визит",
          "title": "Вознаграждение за визит",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "RUB",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Кофе",
    "unit": "шт",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Замечания:
Допустимые Content-Type в заголовке — image/jpeg или image/png
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

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

URL: /term/loyalty/goods/{id}/preconfigured_values
Метод: PATCH
URL параметры:
- id: ID товара
Data параметры:
- color: цвет товара (integer)
- currency: валюта
- sort_order: порядок сортировки
- type: тип рекомендованного значения
- value: значение

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/089729e3-4033-4fba-af3b-a5f6b03d4705/preconfigured_values",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "preconfigured_values": [
        {
          "color": 3224972287,
          "currency": "USD",
          "public_title": {
            "en": "en string",
            "pl": "pl string",
            "ru": "ru string",
            "uk": "uk string"
          },
          "sort_order": 1,
          "type": "currency",
          "value": 20.0
        },
        {
          "color": 3224972290,
          "currency": "UAH",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ]
    }
 }

Пример ответа:

 [
    {
      "active": 1,
      "code": "1444",
      "color": 4294967295,
      "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image": {
        "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
        "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code": "Напитки",
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title": "Напитки",
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ],
      "preconfigured_values": [
        {
          "color": 3224972290,
          "currency": "UAH",
          "id": "8e0c16b7-075f-4a3f-8976-8961f013ccdb",
          "item_id": "79c3b8cb-6235-458a-a0c2-105e5c5d3df5",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ],
      "sort_order": 0,
      "title": "Кофе",
      "unit": "шт",
      "variable_price": 0,
      "variable_total": 0,
      "weighing": 0,
      "whole_number": 1
    }
 ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Добавление списка цен для товара

URL: /term/loyalty/goods/{id}/price
Метод: PATCH
URL параметры:
- id: ID товара
Data параметры:
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'

Пример запроса:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/089729e3-4033-4fba-af3b-a5f6b03d4705/price",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "ru",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ]
    }
 }

Пример ответа:

 [
    {
      "active": 1,
      "code": "1444",
      "color": 4294967295,
      "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image": {
        "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
        "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code": "Напитки",
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title": "Напитки",
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ],
      "preconfigured_values": [
        {
          "color": 3224972290,
          "currency": "UAH",
          "id": "8e0c16b7-075f-4a3f-8976-8961f013ccdb",
          "item_id": "79c3b8cb-6235-458a-a0c2-105e5c5d3df5",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ],
      "sort_order": 0,
      "title": "Кофе",
      "unit": "шт",
      "variable_price": 0,
      "variable_total": 0,
      "weighing": 0,
      "whole_number": 1
    }
 ]

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе будут содержаться обновленные данные товара,
имеющиe поля:
- id: ID товара
- code: Код/Артикул товара
- active: включен ли товар (1 – да, 0 – нет)
- color: цвет товара (integer)
- title: название товара
- image:
  - id: ID картинки
  - url: ссылка на картинку
- additional_images:
  - id: ID дополнительной картинки
  - url: ссылка на дополнительную картинку
- parent_id: ID родительской категории
- parent_code: код/артикул родительской категории
- parent_title: название родительской категории
- price: массив цен на товар, может содержать объекты двух типов
  - цена на товар в валюте, содержит поля:
    - id: ID цены
    - type: тип цены, значение равно currency
    - currency: валюта, в которой задана цена товара
    - price: цена товара (integer)
  - цена на товар в счете покупателя
    - id: ID цены
    - type: тип цены, значение равно special-account
    - price: цена товара (integer)
    - special_account_id: ID счета покупателя
    - special_account: объект, содержащий данные о счете покупателя
      - active: включен ли счет (1 – да, 0 – нет)
      - id: ID счета
      - public_title: локализованное название счета
      - title: название счета
      - type: тип счета. Возможные значения 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: количество единиц товара, которые можно списать без подтверждения по SMS
      - goods_items: массив кодов (code товара) товаров, привязанных к счету, присутствует в ответе
        только если type == 'goods'
- sort_order: порядок сортировки товара
- unit: единицы измерения товара ('килограммы', 'граммы', 'литры' и т. д.)
- variable_price: изменяемая цена товара (1 – да, 0 – нет), означает, что кассир может ввести цену товара вместо
  заданной ранее в Панели управления
- variable_total: изменяемый итог цены товара (1 – да, 0 – нет)
- weighing: весовой товар (1 – да, 0 – нет)
- whole_number: товар может продаваться только целым количеством единиц (1 – да, 0 – нет)

Дополнительные возможности

Подтверждение телефона покупателя

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

Отправка на номер телефона СМС с кодом подтверждения
Проверка кода подтверждения, полученного от покупателя.

Запрос на отправку на номер телефона СМС с кодом подтверждения

URL:
- /term/phone/verification
Метод: POST
URL параметры:
- нет
Data параметры:
- phone: номер телефона

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/phone/verification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+7112233444"
     }
  }

Пример ответа:

  {
      "code": 0,
      "message": "Смотрите код подтверждения в SMS"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с двумя полями:
- code: код ответа (при успешном выполнении содержит значение '0')
- message: текст ответа, "Смотрите код подтверждения в SMS"

Запрос на проверку кода подтверждения, полученного от покупателя

URL:
- /term/phone/verification
Метод: POST
URL параметры:
- нет
Data параметры:
- phone: номер телефона
- pincode: код подтверждения

Пример запроса:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/phone/verification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"ru",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+7112233444",
        "pincode": "0000"
     }
  }

Пример ответа:

  {
      "code": 0,
      "message": "OK"
  }

Замечания:
В случае правильно сформированного запроса и корректных данных в ответе на запрос придет объект с двумя полями:
- code: код ответа (при успешном выполнении содержит значение '0')
- message: текст ответа, "OK"

Коды ответов

Ниже приведен перечень кодов ответов АПИ

Код	Описание
`0`	Возвращено сообщение
`1`	Ошибка создания покупателя
`2`	Ошибка входа покупателя
`3`	Токен не корректен
`4`	PIN-код не корректен
`5`	Телефон покупателя не найден
`6`	Пароль не корректен
`7`	Учетная запись покупателя приостановлена
`8`	Покупатель не найден
`9`	Невозможно определить местоположение
`10`	Ошибка чтения базы данных
`11`	Ошибка записи базы данных
`12`	Ошибочное значение поля
`13`	Отсутствует обязательное значение поля
`14`	Учетная запись пользователя заблокирована
`15`	Учетная запись пользователя удалена
`16`	Требуется согласие пользователя
`18`	Ошибка загрузки изображения
`20`	Ошибка генерации PIN-кода
`21`	Ошибка отправки PIN-кода
`22`	Требуется PIN-код
`25`	Покупатель с таким номером телефона уже существует
`26`	Покупатель с таким электронным адресом уже существует
`27`	Покупатель временно заблокирован вследствие отправки им запросов с неверными параметрами
`28`	Покупатель с таким идентификатором уже существует
`30`	Бизнес не найден
`31`	Покупатель не найден
`32`	Код рекомендации не найден
`33`	Счет покупателя не найден
`34`	За указанный период статистики нет
`35`	Ошибка списания бонусов inCust
`36`	Бизнес отключен
`40`	Программа лояльности не найдена
`41`	Правило программы лояльности не найдено
`42`	Категория товаров не найдена
`43`	Товар не найден
`44`	Товар с таким кодом существует
`45`	Ошибка реферальной программы
`46`	Реферальный код не найден
`47`	Тип доставки не найден
`48`	Магазин не найден
`49`	Ошибка в данных доставки
`50`	Точка продажи не найдена
`51`	Заказ не найден
`52`	У заказа транзакция уже установлена
`60`	Терминал не найден
`61`	Терминал отключен
`62`	Такой номер телефона Терминала inCust или продавца уже существует
`63`	Терминал не использует пароль. Используйте API ключ для доступа.
`64`	Номер телефона Терминала не задан
`65`	Терминал временно заблокирован вследствие отправки им запросов с неверными параметрами
`70`	Категория карт не существует
`71`	Карта с таким номером уже зарегестрирована за другим покупателем
`80`	Правило программы лояльности не найдено
`90`	Сообщение не найдено
`100`	Транзакция не найдена
`101`	Ошибка создания транзакции
`102`	Недостаточно средств на счету inCust. Для продолжения работы необходимо пополнить счет вашей компании в панели управления inCust.
`103`	Ошибочный тип транзакции
`104`	Транзакция зарегистрирована за другим пользователем
`113`	Неправильный номер телефона
`114`	Категория покупателей не найдена
`115`	QR код использован или устарел
`116`	Неправильный QR код
`120`	Новость не найдена
`130`	Покупательское поле не найдено
`131`	Поле "Номер телефона" не задано
`132`	Поле "Email" не задано
`140`	Купон не найден
`141`	Серия купонов не найдена
`142`	Недопустимый внешний код
`143`	В отсканированном коде не содержится купон inCust
`144`	Купон уже использован
`145`	Не задана валюта
`146`	Подарочный сертификат не найден
`147`	Указаны ошибочные серии купонов
`148`	Подарочный сертификат не корректен
`149`	Операция неприменима для указанного типа серии купонов
`150`	Неверная или просроченная ссылка
`151`	Неверный адрес электронной почты или ссылка просрочена
`160`	Туристическая карта: карта уже зарегестрирована за другим покупателем
`170`	Ошибка в данных чека
`171`	Ошибочный тип платежа
`172`	Ошибка счета покупателя в чеке
`173`	Правило не найдено
`174`	Недостаточно средств на счету покупателя
`180`	Объект, которым делились, не найден
`181`	Поделиться этим купоном не позволяется настройками
`182`	Вы не можете добавить купон, которым поделились
`185`	Указан не верный тип выгоды
`190`	Категория услуги туристической карты не найдена
`191`	Счет туристической карты не найден
`192`	Услуга туристической карты не найдена
`193`	Серия туристической карты не найдена
`194`	Неверный тип серии туристической карты
`195`	Туристическая карта не найдена
`196`	Ошибка отключения туристической карты
`197`	Туристическая карта не действительна
`198`	Услуга туристической карты не действительна
`199`	Услуга туристической карты не доступна
`200`	Этот функционал не доступен в текущем тарифном плане
`201`	Тарифный план не найден
`210`	Превышен лимит количества данных
`220`	Номер заказа, указанный для платежа, не найден
`230`	Ставка обмена валют с такими параметрами уже существует
`250`	Не задана валюта
`260`	Платежная карта не найдена
`261`	Платеж не найден
`262`	Недопустимый статус платежа
`263`	Недопустимая сумма платежа
`264`	Неверный пароль платежной карты
`265`	Ошибка обработки платежа
`266`	Детали платежа не найдены
`267`	Программа лояльности не настроена для использования платежной системы
`268`	Платеж мобильным приложением невозможно выполнить без покупателя
`270`	Задача не найдена
`271`	Задача уже закреплена за транзакцией
`272`	К транзакции уже закреплены задачи
`273`	У транзакции имеются незавершенные задачи
`280`	Социальная сеть не поддерживается
`281`	Токен социальной сети ошибочный
`282`	Аутентификация в социальной сети не удалась
`300`	Касса сейчас обслуживает другого покупателя
`401`	Отказано в доступе
`404`	URL не найден
`500`	Ошибка сервера
`9000`	Покупатель не найден
`9001`	Бизнес не найден
`9002`	Программа лояльности не найдена
`9003`	Точка продажи не найдена
`9004`	Такой логин Терминала inCust или продавца уже существует
`9005`	Такой номер телефона Терминала inCust или продавца уже существует
`9006`	Терминал inCust или продавец не найден
`9007`	Транзакция не найдена
`9008`	Купон не найден
`9009`	Ошибка отмены транзакции. Транзакция не найдена.
`9010`	Транзакция уже была отменена
`9011`	Ошибка отмены транзакции. Транзакция по начислению бонусов не найдена.
`9012`	Ошибка отмены транзакции. Бонусы уже списаны.
`9013`	Ошибка транзакции. Недостаточно бонусов на счету.
`9014`	Транзакция уже была подтверждена
`9015`	Ошибка транзакции. Невозможно списать бонусы в оффлайн режиме.
`9016`	Ошибка транзакции. Не установлена валюта для данного Терминала inCust или продавца.
`9017`	Ошибка транзакции. Невозможно списать бонусов больше, чем на сумму покупки.
`9018`	Ошибка транзакции. Невозможно отменить транзакцию этого типа.
`9019`	Ошибка транзакции. Покупатель в черном списке.
`9020`	Ошибка транзакции. Учетная запись покупателя не активна, ожидается подтверждение.
`9021`	Ошибка транзакции. Покупатель не имеет прав на списание бонусов.
`9022`	Ошибка транзакции. Учетная запись покупателя приостановлена.
`9023`	Ошибка транзакции. Учетная запись покупателя заблокирована.
`9024`	Бонусный счет покупателя не найден
`9025`	Код рекомендации не найден
`9026`	Счета покупателя не найден в перечне счетов вашего бизнеса
`9027`	Категория карт не найдена
`9029`	Тарифный план не найден
`9030`	Ошибка транзакции. Не задана валюта.
`9031`	Счет покупателя не найден
`9032`	Ошибка отмены транзакции. Недостаточно средств на счету покупателя.
`9033`	Указанная транзакция не найдена
`9034`	Ошибка транзакции, недостаточно средств на счету покупателя.
`9035`	Ошибка транзакции. Указанный тип транзакции не может быть подтвержден.
`9036`	Ошибка транзакции. Невозможно добавить нулевое или отрицательное число бонусов.
`9037`	Ошибка транзакции. Невозможно пополнить счет на нулевую или отрицательную сумму.
`9038`	Сумма использованных для пополнения счета бонусов в течение календарного месяца не может превышать стоимости услуг, оказанных с начала месяца.
`9039`	Серия купонов не найдена
`9040`	Купон использован максимальное для серии купонов количество раз
`9041`	Купон использован максимальное для данного покупателя количество раз
`9042`	Купон просрочен
`9043`	Исчерпаны все внешние коды
`9044`	Купон не найден
`9045`	В отсканированном коде не содержится купон inCust
`9046`	Купон уже использован другим покупателем
`9047`	Не задана валюта
`9048`	Серия купонов отключена
`9049`	Использован код серии для купонов с уникальным кодом
`9050`	Объект, которым делились, не найден
`9051`	Подарочный сертификат не найден
`9052`	Поделиться этим купоном не позволяется настройками
`9053`	Купон уже использован
`9054`	Учетная запись покупателя уже связана с бизнесом
`9055`	Транзакция уже завершена
`9056`	Серия туристической карты не найдена
`9057`	Туристическая карта просрочена
`9058`	Туристическая карта выпущена максимальное количество раз
`9059`	Исчерпаны все коды туристической карты
`9060`	Программа рекомендаций неактивна
`9061`	Исчерпаны все возможные коды программы рекомендаций
`9062`	Приложение не найдено или не активно
`9063`	Заказ не найден
`9064`	Учетная запись пользователя заблокирована
`9065`	Учетная запись пользователя удалена
`9066`	Параметр не найден
`9067`	Пользователь с таким номером телефона уже существует
`9068`	Пользователь с таким адресом электронной почты уже существует
`9069`	Ошибка транзакции. Невозможно списать средств больше, чем авторизировано.
`9997`	Функциональность разрабатывается
`9998`	Недостаточно средств на счету inCust. Для продолжения работы необходимо пополнить счет вашей компании в панели управления inCust.
`9999`	Общая ошибка SQL

ПОРЯДОК РАБОТЫ С API ТЕРМИНАЛА

Общая информация

Авторизация

Авторизация с помощью логина/пароля

Запрос на получение токена авторизации

Авторизация с помощью API KEY

Получение настроек Терминала

Запрос на получение настроек Терминала

Получение категорий покупателей

Запрос на получение категорий покупателей

Получение счетов покупателей

Запрос на получение счетов покупателей

Получение товаров и категорий

Получение списка категорий

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

Получение данных о покупателе

Запрос на получение получения данных покупателя

Получение идентификатора покупателя из Kiosk-а

Запрос на получение идентификатора покупателя из Kiosk-а

Получение анкеты покупателя

Запрос на получения анкеты покупателя

Изменение анкеты покупателя

Запрос на изменение анкеты покупателя

Изменение типа доступа покупателя

Запрос на изменение типа доступа покупателя

Изменение категории покупателя

Запрос на изменение категории покупателя

Согласие покупателя на обработку персональных данных

Запрос на фиксацию согласия покупателя на использование платформы и на хранение и обработку платформой персональных данных

Получение правил программы лояльности

Запрос на получение правил программы лояльности

Работа с чеком

Подготовка чека

Процессинг чека

Запрос на процессинг чека

Запись чека с финализацией

Запрос на запись чека с финализацией

Запись чека

Запрос на запись чека

Резервирование чека

Запрос на резервирование чека

Финализация чека

Запрос на финализацию чека

Создание чека с финализацией

Запрос на создание чека с финализацией

Резервирование средств по чеку

Запрос на резервирование средств по чеку

Процессинг чека с ранее зарезервированными средствами

Запрос на процессинг чека

Списание ранее зарезервированных средств по чеку

Запрос на списание ранее зарезервированных средств по чеку

Платежи

Запрос платежей по чеку

Запрос платежей по чеку

Добавление платежа к чеку

Запрос на добавление платежа к чеку

Отмена платежа по чеку

Запрос на отмену платежа по чеку

Отправка сообщения с информацией о платеже в приложение для покупателей

Запрос на отправку сообщения с информацией о платеже в приложение для покупателей

Запрос статуса платежа

Запрос статуса платежа

Транзакции

Объект транзакции

Получение списка транзакций

Запрос на получение списка транзакций

Отмена транзакции

Запрос на отмену

Получение информации о транзакции

Запрос на получение информации о транзакции

Получение чека транзакции

Запрос на получение информации о чеке транзакции

Список купонов добавленных в кошелек покупателя

Запрос на получение списка купонов добавленных в кошелек покупателя

Добавление купона в кошелек покупателя

Запрос на добавление купона в кошелек

Использование купона типа "сертификат"

Использование купона типа "сертификат"

Код заказа

Генерация кода заказа