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 Отримання останнього коду, згенерованого в inCust Термінал в режимі Стюард
Ідентифікатори покупця
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 Терміналу слід використовувати токен авторизації, котрий потрібно додавати в заголовки всіх запитів.

Токен може бути короткостроковим, якщо його отримано за допомогою логіна і пароля, або довгостроковим, якщо його отримано через API KEY.

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

Авторизація за допомогою логіна/пароля

Для роботи з API Терміналу за допомогою логіна/пароля слід отримати токен авторизації, котрий в подальшому додаватиметься в заголовки всіх запитів. Логін та пароль мають збігатися встановленим для одного з Терміналів, які ви додали в Панелі Управління Бізнесу.

Запит на отримання токена авторизації

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":"uk"
     },
     "data": {"login":"login","password":"1234"}
  }

Приклад відповіді:

  { 
     "business_code":"123456",
     "currency":"UAH",
     "display_active":1,
     "display_type":"customer-identity",
     "id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "loyalty":{ 
        "title":"Pizza Hattta"
     },
     "phone":"+380501111111",
     "pos":{ 
        "addresses":"вул. Хрещатик, 24",
        "country":"uk",
        "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":"UAH",
     "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":"+380112233444",
     "pos":{
        "addresses":"Адреса точки продажу",
        "country":"UA",
        "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":"uk",
        "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 CUSTOMERS",
        "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":"uk",
        "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":"uk",
        "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":"uk",
        "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":"UAH",
              "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":"UAH",
              "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":"UAH",
              "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":"UAH",
              "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":"UAH",
              "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_code: код/артикул батьківської категорії
- parent_id: ID батьківської категорії
- 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.
URL: /term/cardinfo/{{id}}
Метод: 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/+380112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }
```
Приклад url для спрощеного виклику:
1. для номера телефону https://api.incust.com/v1/term/cardinfo/+380112233444
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,+380112233444,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":"UAH",
           "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":"+380112233444",
        "user_status":"active"
     },
     "rate_info":{
        "currency":"UAH",
        "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":"UAH",
               "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: код купону
  - status: статус купону, можливі значення 'open', 'redeemed', 'cancelled', в цьому випадку буде повернено тільки купони з статусом 'open'
  - batch: об'єкт серії купонів, містить дані про серію купонів до якої належить купон, містить наступні поля
    - id: ID серії купонів
    - type: тип серії купонів, можливі значення 'certificate', 'check-modifier'
    - public_title: публічна назва серії купонів
    - public_description: публічний опис серії купонів
    - image: зображення серії купонів, посилання на зображення
      - Для купонів типу '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, а також одноразовий пароль (PIN) з 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":"uk",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXpQ.zZvP5SKGBACGo3W2-uYRmwSuXSs"
      }
  }

Приклад відповіді:

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

Зауваження: В разі правильно сформованого запиту у відповіді прийде:
- порожній об'єкт {}, якщо покупця в Kiosk-у немає
- об'єкт, що містить id користувача { "id":"+380112233444" }, якщо покупець ввів телефон
- об'єкт, що містить телефон в полі id покупця і пароль з SMS-повідомлення { "id":"+380112233444", "cardotppassword":2173 } в полі cardotppassword, якщо покупець ввів телефон і підтвердив його введенням коду з SMS-повідомлення
- Об'єкт, що містить QR код у id покупця { "id":"1,+380112233444,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/+380112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     }
  }

Приклад відповіді

  {
     "customer":{
        "user_birth_date":"1963-01-29",
        "user_gender":"male",
        "user_name":"Username"
     },
     "fields":[
        {
           "description":"Прізвище",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Прізвище"
        },
        {
           "description":"Є дитина",
           "dictionary_values":[
              "Так",
              "Ні"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"Ні"
        },
        {
           "description":"Річна зарплатня",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Пам'ятна дата",
           "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/+38011223344/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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":"Прізвище",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Прізвище"
        },
        {
           "description":"Є дитина",
           "dictionary_values":[
              "Так",
              "Ні"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"Ні"
        },
        {
           "description":"Річна зарплатня",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Пам'ятна дата",
           "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/+38011223344/phone/access_type",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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/+38011223344/phone/card_category",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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/+38011223344/phone/consent",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "code": "",
         "comment": "Test",
         "confirmation": "pin"
     }
  }
```
- Якщо способом підтвердження згоди вибрано pin, і при цьому поле code не встановлене (містить пусте значення або є відсутнім), то покупцеві буде автоматично надіслано повідомлення з кодом підтвердження, і відповіддю на запит буде об'єкт із кодом 0 (нуль)
```
{
"code":0,
"message":"SMS-повідомлення з кодом підтверждения згоди відправлено на номер +38011223344"
}
```
  Після отримання такої відповіді слід додати в об'єкт підтвердження згоди поле code з кодом підтвердження, що його повідомив покупець касирові, і відправити об'єкт підтвердження згоди на повторне обробляння.

Приклад відповіді:

  {
      "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/%2B38011223344/consent"
      },
      "type": "terminal-customer-registration",
      "user": {
          "country": null,
          "email": null,
          "id": "00000000-0000-0000-0000-000000000000",
          "language": null,
          "name": null,
          "phone": "+38011223344"
      }
  }

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

Отримання правил програми лояльності

Цей метод необхідний для того, щоб отримати перелік правил лояльності, котрі є доступні для застосування вручну.

Запит на отримання правил програми лояльності

URL: /term/rules
Метод: GET
URL параметри:
- відсутні
Data параметри:
- відсутні

Приклад запиту:

  {
     "method":"GET",
     "url":"/term/rules",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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":"UAH",
"amount":35,
"amount_to_pay":35, 
"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,
      "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":"+380112233444",
"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: сума бонусів, що знімаються для вибраної товарної позиції.
  - якщо параметр bonuses_redeemed_amount присутній, то розподіл суми бонусів, що списуються за товарами в чеку, здійснюється відповідно до значення, вказаного в цьому параметрі
  - якщо параметр 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":"uk",
        "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":"+380115050999",
        "payment_type":"currency",
        "payment_id":"UAH",
        "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":"+380112233444",
     "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":"UAH",
     "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":"uk",
        "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":"+380112233444",
        "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":"UAH",
        "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-повідомлення з кодом підтверждения транзакції відправлено на номер +380115050999"
}
```
Після отримання такої відповіді необхідно виконати одну з двох дій:
- додати в об'єкт check поле cardotppassword з 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":"UAH",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk",
        "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":"+380115050999",
        "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":"UAH",
        "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-повідомлення з кодом підтверждения транзакції відправлено на номер +380115050999"
}
```
Після отримання такої відповіді необхідно виконати одну з двох дій:
- додати в об'єкт check поле cardotppassword з 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":"UAH",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk",
        "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":"+380115050999",
        "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":"UAH",
        "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-повідомлення з кодом підтверждения транзакції відправлено на номер +380115050999"
}
```
Після отримання такої відповіді необхідно виконати одну з наведених дій:
- додати в об'єкт check поле cardotppassword із 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":"UAH",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk",
        "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":"UAH",
      "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\":\"+380505050999\",\"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":"uk",
        "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":"+380112233444",
        "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":"UAH",
        "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-повідомлення з кодом підтверждения транзакції відправлено на номер +380115050999"
}
```
Після отримання такої відповіді необхідно виконати одну з двох дій:
- додати в об'єкт check поле cardotppassword з 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":"UAH",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk",
        "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":"+380112233444",
        "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":"UAH",
        "payment_type":"currency",
        "special_accounts_charges":[

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

Якщо в якості id покупця у чеку використовується телефон або номер картки і передбачається списання бонусів або вигод з рахунку покупця, то відповіддю на запит буде об'єкт із кодом 0
```
{
"code":0,
"message":"SMS-повідомлення з кодом підтверждения транзакції відправлено на номер +380115050999"
}
```
Після отримання такої відповіді необхідно виконати одну з двох дій:
- додати в об'єкт check поле cardotppassword з 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":"UAH",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk",
        "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":"+380115050999",
        "payment_type":"currency",
        "payment_id":"UAH",
        "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":"+380112233444",
     "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":"UAH",
     "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":"uk",
        "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":"+380112233444",
        "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":"UAH",
        "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":"UAH",
      "discount_amount":0,
      "id":"374c86e1-3ba3-11ea-8e76-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"UAH\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+380115050999\",\"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":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Приклад відповіді:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "UAH",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "UAH",
          "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":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          {
              "type": "cash", 
              "amount": 200
          }
      ]
  }

Приклад відповіді:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "UAH",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "UAH",
          "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":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          "99089853-5ed2-4ffb-8623-b236e28056ff",
          "c2ecbcff-d39c-417b-9723-fd09a7c5278c"
      ]
  }

Приклад відповіді:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "UAH",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "UAH",
          "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":"uk"
          "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":"uk"
          "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": "UAH",
  "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 - резерв чека на період до одного місяця (зазвичай використовується в інтернет-крамниці)
- 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', номер сторінки з розбиття на сторінки. Лічба сторінок починається з 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":"uk",
        "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":"UAH",
           "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":"+380994148003"
        },
        {
           "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":"UAH",
           "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":"+380115050999"
        }
     ],
     "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":" uk",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "transaction_id":"04fb8bdd-fffd-11e6-bfd1-020000ed147d",
        "comment":"Причина cкасування"
     }
  }

Приклад відповіді:

  {
       "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":"UAH",
       "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":"+380994148003"
  }

Отримання інформації про транзакцію

Запит на отримання інформації про транзакцію

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":"uk",
        "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":"UAH",
       "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":"+380501111111"
  }

Зауваження: В разі правильно сформованого запиту і коректних даних, у відповіді на запит прийде об'єкт транзакції

Отримання чека транзакції

Отримання об'єкта чеку, за яким було створено транзакцію.

Запит на отримання інформації про чек транзакції

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":"uk",
        "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":"+380112233444",
     "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":"UAH",
     "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/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 - номер пластикової картки
  - temporary-card - код покупця, згенерований додатком inCust Термінал в режимі Стюард
  - id - ідентифікатор покупця в системі inCust
  - social-network - ідентифікатор покупця в соціальній мережі, з префіксом FB_ для facebook і G_ для google
  - ssn - номер соціального страхування для громадян і резидентів США
  - itin - індивідуальний податковий номер
Data параметри:
- відсутні

Приклад запиту:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/generate_temporary_code/+380112233444/phone?redeem_allowed=false",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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":"uk",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Приклад відповіді:

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

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

Ідентифікатори покупця

Покупець має один або декілька ідентифікаторів, таких як номер телефону, 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":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "identification": [
              {
                  "code": "+380112233444",
                  "type": "phone"
              },
              {
                  "code": "+380112233555",
                  "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": "+380112233444",
                  "type": "phone"
              },
              {
                  "code": "qqq@qqq.com",
                  "type": "email"
              },
              {
                  "code": "TEST111",
                  "scope": "loyalty",
                  "type": "card"
              }
          ],
          "language": "uk",
          "name": "Тест 1"
      },
      {
          "birth_date": "1913-09-20",
          "country": "UA",
          "gender": "male",
          "id": "0573eb97-fe7f-46fc-9fb2-5495074de415",
          "identification": [
              {
                  "code": "+380112233555",
                  "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": "+380111111111",
                  "type": "phone"
              },
              {
                  "code": "G_111222333444",
                  "type": "social-network"
              }
          ],
          "language": "uk",
          "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, використовуючи набір його ідентифікаторів, таких як номер телефону, адреса електронної пошти, ідентифікатор в соціальній мережі, тощо

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

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":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "country": "UA",
          "language": "uk",
          "name": "test",
          "identification": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+380112221111",
                  "type": "phone"
              }
          ]
      }
  }

Приклад відповіді:

  {
      "country": "UA",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "code": "+380112221111",
              "type": "phone"
          },
          {
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "uk",
      "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/+380112221111/phone/identification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }
```
Приклад url для спрощеного виклику:
1. для номеру телефону https://api.incust.com/v1/term/customers/+380112221111/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,+380112221111,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394/identification

Приклад відповіді:

  {
      "country": "UA",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d63",
              "code": "+380112221111",
              "type": "phone"
          },
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d65",
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "uk",
      "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/+380112221111/phone/identification",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"uk"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+380112221111",
                  "type": "phone"
              }
      ]
  }

Приклад відповіді:

  [
      {
          "added": true,
          "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b91",
          "code": "+380112221111",
          "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/+380112221111/phone/identification/delete",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"uk"
          "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": "+380112221111",
                  "type": "phone"
              }
      ]
  }

Приклад відповіді:

  [
      {
          "deleted": false,
          "error": "Operation not permitted",
          "code": "+380112221111",
          "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":"uk",
        "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 параметри:

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

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"uk",
    "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/+380441122334/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":"UAH",
           "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 параметри:
- масив об'єктів з полем code, що містить код купону, наприклад [{ "code": 246990359478 }, { "code": 192059545592 }]

Приклад запиту:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/coupons/+380442233444/phone/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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":"UAH",
               "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 параметри:

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

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/+380441122334/phone/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"uk",
    "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* - індивідуальний податковий номер
```
- id: ідентифікатор покупця. Якщо тип ідентифікатора не вказано в параметрі id_type, то в параметрі id може бути лише номером телефону в міжнародному форматі ('+' на початку номеру є обов'язковим), номером пластикової картки, кодом замовлення ('@' на початку коду є обов'язковим) або QR кодом з додатку inCust.
- 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: дата (зазначена дата не включається, тобто час дії до 00:00:00 зазначеної дати) у форматіYYYY-MM-DD, до котрої дійсні бонуси (для типу вигоди promotional-bonuses)
- comment: коментар

Приклад запиту на нарахування бонусів:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+380112221111",
        "type": "regular-bonuses",
        "currency": "UAH",
        "amount": 10,
        "comment": "Коментар до нарахування"
     }
  }

Приклад запиту на нарахування тимчасових бонусів:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+380112221111",
        "type": "promotional-bonuses",
        "promotional_bonuses_expire_date": "2018-10-09",
        "currency": "UAH",
        "amount": 20,
        "comment": "Коментар до нарахування"
     }
  }

Приклад запиту на нарахування на счет покупця:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+380112221111",
        "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\":\"UAH\",\"id\":\"+380112221111\",\"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/+380112221111/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/+380112221111/cards/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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/+380112221111/cards/code",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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/+380112221111/cards/service/use",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"uk",
        "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', сторінка в розбитті на сторінки, лічба сторінок починається з 1
- count, type 'integer', кількість елементів на сторінці,
- not_paid_only, type boolean, включати лише не сплачені замовлення
Data параметри:
- відсутні

Приклад запиту:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/+380112221111/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', сторінка в розбитті на сторінки, лічба сторінок починається з 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": "UAH",
          "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": "UAH",
                  "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":"uk",
          "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":"uk",
          "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":"uk",
          "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"
  }

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

Інформація про завдання

Цей метод повертає інформацію про завдання

Запит на отримання інформації про завдання

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":"uk",
          "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":"uk",
          "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":"uk",
          "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":"uk",
          "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":"uk",
          "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": "UAH",
                                  "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": "UAH",
                                  "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":"uk",
      "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":"UAH",
            "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":"UAH",
            "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":"UAH",
            "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":"UAH",
            "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":"UAH",
            "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":"uk",
        "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":"uk",
      "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"
   },
  ]

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит прийде масив, що містить перелік категорій товарів, з якими працює Термінал. Кожен елемент масиву є об'єктом, що містить поля:
- 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":"uk",
      "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": "uk",
      "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": "uk",
      "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": "uk",
      "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":"UAH",
            "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
   }
  ]

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються дані товару, що містять наступні поля:
- 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": "uk",
      "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":"UAH",
            "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
    }

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
        "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
  }

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
        "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
  }

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
        "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
В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
        "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
  }

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
        "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
В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "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": "UAH",
          "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
    }
 ]

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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": "uk",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "UAH",
          "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": "UAH",
          "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
    }
 ]

Зауваження: В разі правильно сформованого запиту і коректних даних у відповіді на запит надсилаються оновлені дані товару, що містять наступні поля:
- 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 – ні)

Додаткові можливості

Підтвердження телефону покупця

Цей метод використовується для перевірки, що номер, названий покупцем, дійсно йому належить. Процедура підтвердження відбувається в два етапи:

Відправлення на номер телефону SMS-повідомлення з кодом підтвердження
Перевірка коду підтвердження, отриманого від покупця.

Запит на відправлення на номер телефону SMS-повідомлення з кодом підтвердження

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":"uk",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+380112221111"
     }
  }

Приклад відповіді:

  {
      "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":"uk",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+380112221111",
        "pincode": "0000"
     }
  }

Приклад відповіді:

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

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

Коди відповідей сервера

Нижче наведено перелік кодів відповідей API

Код	Опис
`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 KEY для доступу.
`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-у

Отримання анкети покупця

Запит на отримання анкети покупця

Зміна анкети покупця

Запит на зміну анкети покупця

Зміна типу доступу покупця

Запит на зміну типу доступу покупця

Зміна категорії покупця

Запит на зміну категорії покупця

Згода покупця на обробку персональних даних

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

Отримання правил програми лояльності

Запит на отримання правил програми лояльності

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

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

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

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

Запис чеку з фіналізацією

Запит на фіналізацію чеку

Запис чеку

Запит на запис чеку

Резервування чеку

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

Фіналізація чеку

Запит на фіналізацію чеку

Створення чека з фіналізацією

Запит на створення чеку з фіналізацією

Резервування коштів за чеком

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

Процесинг чеку із раніше зарезервованими коштами

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

Списання раніше зарезервованих коштів за чеком

Запит на списання раніше зарезервованих коштів за чеком

Платежі

Запит платежів за чеком

Запит платежів за чеком

Додавання платежу до чеку

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

Скасування платежу за чеком

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

Відправлення повідомлення з інформацією про платіж в додаток покупця

Запит на відправлення повідомлення з інформацією про платіж в додаток покупця

Запит статусу платежу

Запит статусу платежу

Транзакції

Об'єкт транзакції

Отримання переліку транзакцій

Запит на отримання переліку транзакцій

Скасування транзакції

Запит на скасування

Отримання інформації про транзакцію

Запит на отримання інформації про транзакцію

Отримання чека транзакції

Запит на отримання інформації про чек транзакції

Код замовлення

Генерація коду замовлення

Запит на генерацію коду замовлення

Отримання останньго коду замовлення, що його було згенеровано Терміналом в режимі Термінал або Стюард

Запит на отримання останнього коду, зареєстрованого програмою Термінал в режимі Стюард

Ідентифікатори покупця

Пошук покупця за ідентифікаторами

Запит на пошук покупця за ідентифікаторами