Перейти к содержимому

Филиалы

Филиал — торговая точка организации: магазин, кафе, склад. Роль сотрудника можно ограничить одним филиалом: её доступы действуют только в нём, хотя саму организацию и список её филиалов такой сотрудник видит. См. Сотрудники и PIN.

  1. Список. GET /v1/orgs/{id}/branches — все филиалы организации, в том числе закрытые.

  2. Создание. POST /v1/orgs/{id}/branches с названием и адресом.

  3. Изменение и закрытие. PATCH /v1/orgs/{id}/branches/{branchId}; чтобы закрыть филиал, передайте active: false.

GET/v1/orgs/{id}/branches

Нужен доступ orgs.read в организации или в одном из её филиалов. Массив без пагинации, по алфавиту.

Окно терминала
curl https://api.rekassa.uz/v1/orgs/8c1e4a27-5d3b-4f60-9a82-1b7e0c3d9f45/branches \
-H 'Authorization: Bearer <accessToken>'
[
{
"id": "5f2a9c61-8e3d-4b07-a4c9-0d6b1e7f3a28",
"organizationId": "8c1e4a27-5d3b-4f60-9a82-1b7e0c3d9f45",
"name": "Магазин на Чиланзаре",
"address": "г. Ташкент, Чиланзарский р-н, 9-й квартал, 14",
"active": true,
"createdAt": "2026-09-24T09:20:00.000Z"
}
]
Поле Описание
active false — филиал закрыт
POST/v1/orgs/{id}/branches

Нужен доступ branches.manage в организации — из ролей клиента он есть у «Владельца», «Директора» и «Управляющего».

Поле Тип Обязательное Ограничения
name string да 1–200 символов, уникально в организации
address string нет 1–500 символов
Окно терминала
curl -X POST https://api.rekassa.uz/v1/orgs/8c1e4a27-5d3b-4f60-9a82-1b7e0c3d9f45/branches \
-H 'Authorization: Bearer <accessToken>' \
-H 'Content-Type: application/json' \
-d '{"name": "Магазин на Чиланзаре", "address": "г. Ташкент, Чиланзарский р-н, 9-й квартал, 14"}'

Ответ 201 — созданный филиал в том же виде, что в списке, с active: true.

Статус Код Когда
400 validation_failed пустое или слишком длинное название
403 forbidden нет доступа branches.manage в этой организации
404 organization_not_found организации нет
409 conflict филиал с таким названием в организации уже есть
PATCH/v1/orgs/{id}/branches/{branchId}

Нужен доступ branches.manage в организации или в этом филиале. Все поля необязательные.

Поле Тип Описание
name string 1–200 символов, уникально в организации
address string 1–500 символов
active boolean false закрывает филиал, true открывает
Окно терминала
curl -X PATCH https://api.rekassa.uz/v1/orgs/8c1e4a27-5d3b-4f60-9a82-1b7e0c3d9f45/branches/5f2a9c61-8e3d-4b07-a4c9-0d6b1e7f3a28 \
-H 'Authorization: Bearer <accessToken>' \
-H 'Content-Type: application/json' \
-d '{"active": false}'

Ответ 200 — филиал после изменения.

Статус Код Когда
403 forbidden нет доступа branches.manage
404 branch_not_found в этой организации нет филиала с таким branchId
409 conflict филиал с таким названием в организации уже есть