Арендаторы

GET /api/external/v2/sc/{sc_id}/renters BASIC

Параметры#

Имя	Тип	По умолчанию	Описание
`sc_id`	string, в пути	—	Идентификатор центра из списка ТЦ
`page`	integer	`1`	Номер страницы
`per_page`	integer	`100`	Размер страницы, от 1 до 500
`archived`	boolean	`false`	`true` — добавить архивных арендаторов к действующим

В выдачу попадают все арендаторы центра, в том числе те, за кем сейчас не закреплена ни одна точка. Сортировка по наименованию юрлица, при совпадении по id.

bash

curl -G "https://api.rentu.ru/api/external/v2/sc/$SC/renters" \
  -d per_page=500 \
  -H 'Authorization: Bearer YOUR_TOKEN'

Ответ#

Поле	Тип	Описание
`id`	string	Идентификатор арендатора. Тот же, что `renter.id` в торговых точках
`legal_name`	string \| null	Наименование юридического лица
`inn`	string \| null	ИНН
`kpp`	string \| null	КПП
`legal_address`	string \| null	Юридический адрес
`is_contractor`	boolean	Признак подрядчика: помещение сдано подрядчику, а не обычному арендатору
`is_archived`	boolean	Арендатор в архиве
`owner`	object	Владелец: `name`, `email`, `phone`
`manager`	object	Менеджер: `name`, `email`, `phone`

Незаполненные значения приходят как null, а не как пустая строка. Это касается и полей внутри owner и manager: сами объекты есть всегда, даже если все три поля пустые.

json

{
  "success": true,
  "data": [
    {
      "id": "6512a1f0b3c4d5e6f7a8b911",
      "legal_name": "ООО «Зарина»",
      "inn": "7712345678",
      "kpp": "771201001",
      "legal_address": "Москва, ул. Тверская, 7",
      "is_contractor": false,
      "is_archived": false,
      "owner": {
        "name": "Иван Петров",
        "email": "owner@zarina.ru",
        "phone": "+79991234567"
      },
      "manager": {
        "name": null,
        "email": "shop101@zarina.ru",
        "phone": null
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 500,
      "total": 84
    }
  }
}

Практика#

Точки арендатора забираются фильтром. Чтобы получить помещения конкретного арендатора, его id передаётся в renter_id списка торговых точек.

Справочник имеет смысл кэшировать. Реквизиты и контакты меняются редко, одного вызова в сутки достаточно.

Ошибки#

Код	HTTP	Когда
`validation_error`	422	`per_page` больше 500