Bokling CRM
Bokling CRM
Справочник API
Справочник API

Путёвки

Download schema

Статус, выпуск, PDF и отметка «отправлена»

Путёвка брони

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/bookings/{id}/voucher

Путёвка брони › path Parameters

id
​string · required

Номер брони

Путёвка брони › Responses

Готово

Voucher
booking_id
​string · required
number
​string · required

Номер путёвки

pdf_available
​boolean · required

Файл можно скачать (GET /bookings/{id}/voucher.pdf)

status
​string · required

none — не выпущена, generated — выпущена, sent — отмечена отправленной семье. Список может пополняться

pdf_url
​string | null

Ссылка на скачивание PDF без ключа, живёт 10 минут (pdf_url_expires_at). Приходит только в GET /bookings/{id}/voucher. null — ссылки нет (путёвка не выпущена или файл собирается для вашего отдела на лету) — тогда скачайте GET /bookings/{id}/voucher.pdf. Ссылку не храните: за новой — снова GET /bookings/{id}/voucher

pdf_url_expires_at
​string | null · date-time

До какого момента действует pdf_url

Выпустить путёвку

POST
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/bookings/{id}/voucher

Выпуск и перевыпуск путёвки (новый QR-код заезда, прежний перестаёт действовать). Сейчас доступно руководителю отдела и лагерю, ключу с правами менеджера — нет (voucher_head_only).

Выпустить путёвку › path Parameters

id
​string · required

Номер брони

Выпустить путёвку › Headers

Idempotency-Key
​string · required

Ключ повтора

Выпустить путёвку › Responses

Готово

Voucher
booking_id
​string · required
number
​string · required

Номер путёвки

pdf_available
​boolean · required

Файл можно скачать (GET /bookings/{id}/voucher.pdf)

status
​string · required

none — не выпущена, generated — выпущена, sent — отмечена отправленной семье. Список может пополняться

pdf_url
​string | null

Ссылка на скачивание PDF без ключа, живёт 10 минут (pdf_url_expires_at). Приходит только в GET /bookings/{id}/voucher. null — ссылки нет (путёвка не выпущена или файл собирается для вашего отдела на лету) — тогда скачайте GET /bookings/{id}/voucher.pdf. Ссылку не храните: за новой — снова GET /bookings/{id}/voucher

pdf_url_expires_at
​string | null · date-time

До какого момента действует pdf_url

PDF путёвки

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/bookings/{id}/voucher.pdf

Файл выпущенной путёвки — отправить семье. Тяжёлый запрос: проще взять готовую ссылку pdf_url из GET /bookings/{id}/voucher.

PDF путёвки › path Parameters

id
​string · required

Номер брони

PDF путёвки › Responses

PDF путёвки

Pdf · binary

Двоичный PDF.

Отметить путёвку отправленной

POST
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/bookings/{id}/voucher/sent

Путёвка передана семье. Сейчас доступно руководителю отдела и лагерю, ключу с правами менеджера — нет (voucher_head_only).

Отметить путёвку отправленной › path Parameters

id
​string · required

Номер брони

Отметить путёвку отправленной › Headers

Idempotency-Key
​string · required

Ключ повтора

Отметить путёвку отправленной › Responses

Готово

Voucher
booking_id
​string · required
number
​string · required

Номер путёвки

pdf_available
​boolean · required

Файл можно скачать (GET /bookings/{id}/voucher.pdf)

status
​string · required

none — не выпущена, generated — выпущена, sent — отмечена отправленной семье. Список может пополняться

pdf_url
​string | null

Ссылка на скачивание PDF без ключа, живёт 10 минут (pdf_url_expires_at). Приходит только в GET /bookings/{id}/voucher. null — ссылки нет (путёвка не выпущена или файл собирается для вашего отдела на лету) — тогда скачайте GET /bookings/{id}/voucher.pdf. Ссылку не храните: за новой — снова GET /bookings/{id}/voucher

pdf_url_expires_at
​string | null · date-time

До какого момента действует pdf_url

Выписка банкаОтчёты