Зміни

Create Shift

Відкриття нової зміни касиром.

Для створення зміни необхідно вказати ключ ліцензії конкретного пРРО розташованого в тій же торговій точці, що знаходиться касир.

Створюється об'єкт зміни в стані "CREATED" та транзакція відкриття зміни (поле "initial_transaction").

Для переведення зміни в статус OPENED необхідно щоб транзакція була підписана за допомогою КЕП та доставлена в ДПС, це як правило триває декілька секунд.

Після створення запиту необхідно відслідковувати статус зміни доки він не змінить на OPENED або CLOSED.

Статус зміни можна відслідковувати за допомогою GET запиту по шляху /api/v1/shifts/{shift_id}, де {shift_id} - ідентифікатор зміни. Або /api/v1/cashier/shift

У разі, якщо зміна перейшла у статус CLOSED - це значить, що зміна не може бути відкрита. Деталізація причини відмови у створенні зміни знаходиться в полі initial_transaciton.

Після того як робочу зміну буде успішно відкрито можна її закрити або створювати чеки.

post/api/v1/shifts

Request

  • Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
  • URL: https://api.checkbox.ua/api/v1/shifts
  • Auth: HTTP bearer

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

string uuid required
OR
string required
X-Device-IDstring

ID RRO Agent або мобільного пристрою каси (Для блокування дублікатів)

Request body

idstring uuid
auto_close_atstring date-time
fiscal_codestring
fiscal_datestring date-time

Response

Successful Response

idstring uuid required
serialinteger required
status'CREATED' | 'OPENING' | 'OPENED' | 'CLOSING' | 'CLOSED' required

An enumeration.

opened_atstring date-time
closed_atstring date-time
created_atstring date-time required
updated_atstring date-time
fiscal_api_type'FSCO_EC' | 'EVPEZ' | 'EVPEZ_EXTERNAL'

An enumeration.

evpez_shift_idstring
emergency_closeboolean
emergency_close_detailsstring

Changes

No recorded changes to this operation across all 1 revision of this API.