1. v2
ECHECK
  • for clients
    • 1. Авторизация
      • 1.3 Інформація по ЕП
      • 1.2 Оновлення сесії ЕП
      • 1.1 Login
      • 1.1.1 Login with Virtual key
    • 3. Робота з касою, у межах зміни
      • 3.1 Відкриття та закриття зміни
        • - Відкриття зміни
        • - Відкриття зміни із вказанням початкової суми готівки
        • - Закриття зміни
      • 3.3 Чеки
        • 3.3.1 Чек продажу
          • - Створення чернетки
          • - Фіскалізація чеку
          • - Фіскалізація чернетки
        • 3.3.2 Чек відміни
          • - Повна відміна чеку
          • - Часткова відміна чеку
          • - Відміна чеку, який відсутній у Єчек
        • 3.3.3 Чернетки
          • - Збереження чернеток
          • - Перелік чернеток
          • - Видалення чернеток
        • 3.3.4 Інформація по чекам
          • - Відправка чеку на емейл
          • - Перелік чеків по зміні
          • - Отримання чеку по id
        • 3.3.5 ФКЧ-3
          • - Фіскалізація ФКЧ3 (трансфер)
      • 3.4 Звіти Х / Z / періодичний
        • - Отримати html i pdf З-звітy по id
        • - Згенерувати З-звіт
        • - Отримати З-звіт по id
        • - Згенерувати X-звіт
        • - Згенерувати періодичний-звіт
      • 3.5 Інформація про зміни
        • - Перелік змін по касі
        • - Статус зміни по касі
    • admin
      • - login для адміністратора
      • - Перелік змін по касі
      • - Перелік кас
      • Отримати довідник одиниць виміру
      • - групи платежів
      • - типи платежів
      • - перелік чеків по касі
      • - додаткова інформація по чекам
      • - детальна інформація по чекам
      • - статус по касі
      • - перелік касирів
      • - баланс та готівка по зміні
      • - змінити свій apikey для компанії
      • - перевірити чи є з'єднання АПІ із ДПС
      • відкриття посилки на термінал
    • registration
      • new user
    • public
      • company-payments-type
  • async-method
    • v2
      • - Статус асинхронної фіскалізації зміни
        GET
      • - Статус асинхронної фіскалізації сервісного чеку
        GET
      • - Статус асинхронної фіскалізації чеку
        GET
      • - Асинхронне внесення/винесення готівки
        PATCH
      • - Асинхронна фіскалізація чеку продажу
        POST
      • - Асинхронна фіскалізація чеку переказу коштів
        POST
      • - Асинхронна відміна або повернення чеку
        POST
      • - Асинхронне відкриття зміни
        POST
      • - Асинхронне закриття зміни
        POST
  1. v2

- Статус асинхронної фіскалізації зміни

Develop Env
https://dev.e-check.com.ua
Develop Env
https://dev.e-check.com.ua
GET
/v2/open-api/shift/fiscalisation-operations/{operationId}

Отримання статусу асинхронної операції зміни#

GET /v2/open-api/shift/fiscalisation-operations/{operationId}
Повертає стан асинхронного відкриття або закриття зміни. Для закриття операція включає формування Z-звіту та службові дії за потреби.

Параметр та авторизація#

operationId — ідентифікатор із data.operationId відповіді запуску. Збережіть його разом із вихідним запитом і клієнтським ідентифікатором. Використовуйте авторизацію відповідного API. GET перевіряє наявну операцію; повторний GET не запускає її заново.

Стани операції#

data.statusЗначенняРекомендована дія клієнта
PENDINGОперацію створено; виконання ще не почалося.Продовжити перевірку того самого operationId.
PROCESSINGОперація обробляється.Продовжити перевірку, не створюючи дубль.
COMPLETEDОперацію завершено.Зберегти результат і завершити звичайний polling.
FAILEDСпроба завершилася помилкою.Розібрати причину та перевірити фактичний стан перед повторним запуском.
FAILED — стан операції, але за наявності збереженої помилки API повертає HTTP 400 замість HTTP 200 із data.status = FAILED. Клієнт повинен обробляти обидва варіанти. Саме значення success: true означає успішне отримання статусу, а успішне завершення операції визначається data.status = COMPLETED.
Для незавершеної операції відповідь може мати вигляд:
{
  "success": true,
  "data": { "status": "PROCESSING" },
  "errors": null
}
До завершення data.result може бути відсутнім. Не очікуйте, що причину невдачі буде повернуто всередині result. Цей GET також не гарантує повернення operationId, createdAt, updatedAt або окремого поля error.

HTTP-помилки та дії клієнта#

ВідповідьМожливе значенняРекомендована дія
400Збережена помилка виконання операції; також можливі помилки обробки запиту.Прочитати errors.id та errors.message. Не вважати будь-який 400 автоматично статусом FAILED без аналізу причини. Для підтвердженої невдачі припинити звичайний polling і перейти до перевірки/відновлення.
404, NOT_FOUND, Operation not foundЗапис операції не знайдено.Звірити ID із відповіддю запуску, endpoint і середовище. Не створювати нову фіскальну дію лише через 404. Якщо ID правильний — передати його підтримці.
401 / 403Проблема авторизації або доступу, зокрема на рівні шлюзу чи захисту API.Перевірити API-ключ і контекст доступу; після виправлення повторити GET із тим самим ID. Ці відповіді не визначають стан фіскалізації.
429, якщо повертається інфраструктуроюОбмеження частоти запитів.Збільшити інтервал, врахувати Retry-After, якщо він є. Не повторювати запуск операції.
5xxПомилка сховища, внутрішнього сервісу або формування відповіді.Повторити GET із затримкою; якщо помилка зберігається — звернутися до підтримки. Не робити висновок, що фіскальна дія не виконана.
Таймаут / обрив з’єднанняВідповідь не отримана; стан невідомий.Зберегти ID і повторити GET. Таймаут клієнта не скасовує операцію.
401/429 наведені як сценарії, які варто обробляти клієнту на рівні доступу та інфраструктури; це не додаткові статуси операції та не обіцянка їх повернення самим обробником polling.
Типова відповідь із помилкою:
{
  "success": false,
  "data": null,
  "errors": {
    "id": "<код конкретної причини>",
    "message": "<опис причини>"
  }
}
Первинний HTTP-код сервісу виконання не обов’язково зберігається: збережена помилка FAILED повертається polling через HTTP 400. Наприклад, SHIFT_NOT_FOUND у errors.id під час невдалого виконання не означає HTTP 404 цього GET. Відрізняйте це від NOT_FOUND із повідомленням Operation not found.
Перелік причин нижче не є вичерпним контрактом кодів. Помилки залежать від типу операції й відповіді сервісу виконання; початковий код або повідомлення можуть бути втрачені. За неповних збережених даних можливі узагальнені SOMETHING_WENT_WRONG, INTERNAL_ERROR, неповне повідомлення або серверна помилка. Клієнт має мати загальну гілку для невідомого коду та не визначати поведінку лише за точним текстом повідомлення.

Успішний результат#

Для COMPLETED data.result містить інформацію про зміну: shiftId, companyId, workerId, cashRegisterId, cashRegisterName, status. Для закриття також може повертатися zReportId. Не плутайте data.status (стан асинхронної операції) та data.result.status (стан зміни, наприклад OPEN/CLOSE).
zReportId не гарантований у кожній відповіді. Якщо він потрібний, але відсутній, перевірте доступні дані зміни та Z-звіту окремо. COMPLETED може повернутися з неповними даними, якщо збережений результат не вдалося прочитати. Це не підстава повторно відкривати чи закривати зміну.
Закриття складається з кількох дій. Невдала спроба могла вже виконати частину з них, зокрема сформувати звіт або службовий чек. Для відкриття COMPLETED також не слід трактувати як окреме підтвердження кожної супутньої дії перенесення залишку: стан і потрібні касові дані варто перевіряти за відповідними результатами.
{
  "success": true,
  "data": {
    "status": "COMPLETED",
    "result": {
      "shiftId": "3c617b4b-a9f5-46e7-ad23-3d081356dd8f",
      "companyId": "362",
      "workerId": 646,
      "cashRegisterId": "37647",
      "status": "CLOSE",
      "cashRegisterName": "Е_ЧЕК_05296",
      "zReportId": "f44c9d98-7e46-43b1-a19c-b8636a89eed0"
    }
  },
  "errors": null
}

Можливі причини помилок виконання#

Причина / можливий кодЩо перевіритиРекомендована дія
SHIFT_ALREADY_OPENЧи вже відкрита зміна на цій касі.Отримати поточну зміну та звірити її з очікуваною. Не запускати відкриття повторно автоматично.
SHIFT_NOT_OPEN, SHIFT_NOT_FOUNDНаявність і фактичний стан зміни. Один із сервісів також використовує SHIFT_NOT_FOUND для вже закритої зміни.Звірити поточну зміну, Z-звіт і результат попереднього закриття; врахувати errors.message.
CASH_REGISTER_DEACTIVATEDАктивність каси.Перевірити налаштування та можливість виконання операцій на касі.
KEY_NOT_FOUNDНаявність і доступність ключа підпису.Відновити підпис; перед повторною спробою звірити стан зміни.
balance cant minusВід’ємний залишок при підготовці закриття.Звірити касові рухи й залишок. Це можлива внутрішня причина; її текст не гарантовано збережеться у відповіді GET.
Помилка формування Z-звіту, службового винесення або фінального закриттяЯкі кроки вже виконано.Перевірити звіти, службові чеки та стан зміни. Не вважати всю послідовність невиконаною лише через FAILED.
Помилка ДПС, підпису, з’єднання або невідомий кодФактичний результат відкриття/закриття.Звірити стан каси, зміни й звітів; за невизначеності звернутися до підтримки.
Для повторення відкриття збережіть початковий clientCheckId. Для закриття ключ визначається касою та shiftId, а не clientCheckId. Після FAILED допускається нова спроба, але лише після перевірки вже виконаних кроків. Змінювати shiftId для обходу помилки не слід.

Рекомендована стратегія перевірки#

1.
Після запуску зберегти operationId, клієнтський ідентифікатор, вихідні параметри й тип операції.
2.
Виконувати GET з інтервалом, наприклад, 1–2 секунди; для тривалого очікування поступово збільшувати інтервал і додавати невелику випадкову затримку. Це рекомендація клієнту, а не гарантований час виконання API.
3.
Для PENDING/PROCESSING продовжувати перевірку. Якщо локальний ліміт очікування вичерпано, показати «Стан уточнюється» та зберегти можливість продовжити перевірку пізніше.
4.
Для COMPLETED зберегти результат. Якщо результат неповний, перевірити відповідний чек або зміну через доступні методи читання; не запускати нову фіскальну дію лише для отримання відсутніх полів.
5.
Для відомої помилки виконання перевірити причину та фактичний стан. Для тимчасової помилки читання повторювати цей GET, а не запит запуску.
6.
Якщо відновлення потребує підтримки, передати operationId, тип операції, час запиту, ідентифікатори каси/зміни/чека, HTTP-код та отримані errors. API-ключі й дані підпису не включати.
Нову спробу запускають відповідним методом створення операції після усунення причини та перевірки результатів попередньої. Повторний GET невдалої операції сам її не перезапускає. Після FAILED повторне надсилання запиту запуску може створити новий operationId; далі слід перевіряти саме новий ID.

Request

Path Params

Header Params

Responses

🟢200OK
application/json
Operation status
Bodyapplication/json

🟠403Forbidden
🟠400Bad Request
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.e-check.com.ua/v2/open-api/shift/fiscalisation-operations/f44c9d98-7e46-43b1-a19c-b8636a89eed0' \
--header 'apikey: {{apikey}}'
Response Response Example
200 - Success
{
    "success": true,
    "data": {
        "status": "COMPLETED",
        "result": {
            "shiftId": "3c617b4b-a9f5-46e7-ad23-3d081356dd8f",
            "zReportId": "f44c9d98-7e46-43b1-a19c-b8636a89eed0",
            "cashRegisterId": "37647",
            "cashRegisterName": "Е_ЧЕК_05296",
            "companyId": "362",
            "workerId": "646",
            "status": "CLOSE",
            "startTime": 1721996978643,
            "endTime": 1722015161754
        }
    },
    "errors": null
}
Modified at 2026-10-23 08:36:49
Previous
async-method
Next
- Статус асинхронної фіскалізації сервісного чеку
Built with