GET /v2/open-api/shift/fiscalisation-operations/{operationId}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.| Відповідь | Можливе значення | Рекомендована дія |
|---|---|---|
| 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. Таймаут клієнта не скасовує операцію. |
{
"success": false,
"data": null,
"errors": {
"id": "<код конкретної причини>",
"message": "<опис причини>"
}
}SHIFT_NOT_FOUND у errors.id під час невдалого виконання не означає HTTP 404 цього GET. Відрізняйте це від NOT_FOUND із повідомленням Operation not found.SOMETHING_WENT_WRONG, INTERNAL_ERROR, неповне повідомлення або серверна помилка. Клієнт має мати загальну гілку для невідомого коду та не визначати поведінку лише за точним текстом повідомлення.data.result містить інформацію про зміну: shiftId, companyId, workerId, cashRegisterId, cashRegisterName, status. Для закриття також може повертатися zReportId. Не плутайте data.status (стан асинхронної операції) та data.result.status (стан зміни, наприклад OPEN/CLOSE).zReportId не гарантований у кожній відповіді. Якщо він потрібний, але відсутній, перевірте доступні дані зміни та Z-звіту окремо. 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 для обходу помилки не слід.operationId, клієнтський ідентифікатор, вихідні параметри й тип операції.operationId, тип операції, час запиту, ідентифікатори каси/зміни/чека, HTTP-код та отримані errors. API-клю чі й дані підпису не включати.operationId; далі слід перевіряти саме новий ID.curl --location 'https://dev.e-check.com.ua/v2/open-api/shift/fiscalisation-operations/f44c9d98-7e46-43b1-a19c-b8636a89eed0' \
--header 'apikey: {{apikey}}'{
"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
}