GET /api/external/v2/sc/{sc_id}/shops BASIC
Параметры#
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
sc_id | string, в пути | — | Идентификатор центра из списка ТЦ |
page | integer | 1 | Номер страницы |
per_page | integer | 100 | Размер страницы, от 1 до 500 |
archived | boolean | false | true — добавить архивные точки к действующим |
renter_id | string | — | Только точки этого арендатора |
Передайте archived=true, чтобы получить действующие и архивные точки. Проверяйте статус точки по is_archived.
Используйте renter_id вместе с archived и пагинацией. Для арендатора другого
центра или неизвестного ID получите пустой список с HTTP 200.
curl -G "https://api.rentu.ru/api/external/v2/sc/$SC/shops" \
-d per_page=200 \
-H 'Authorization: Bearer YOUR_TOKEN'Ответ#
| Поле | Тип | Описание |
|---|---|---|
id | string | Идентификатор точки. Используйте как shop_id в запросах отчётов, чеков и касс |
name | string | Название |
external_id | string / null | Идентификатор точки во внешней системе |
is_archived | boolean | Точка в архиве |
is_food_court | boolean | Точка относится к фудкорту |
is_anchor | boolean | Якорный арендатор |
is_near_cashbox | boolean | Прикассовая зона |
position | object / null | Площадка точки; null, если площадка отсутствует или удалена |
renter | object / null | Арендатор точки; null, если арендатора нет |
Определяйте фудкорт, якорь и прикассу по флагам is_food_court, is_anchor
и is_near_cashbox. Флаги могут сочетаться и принимают true или false.
Для незаданного признака получите false.
Поля position#
| Поле | Тип | Описание |
|---|---|---|
id | string | Идентификатор площадки |
name | string | Обозначение площадки, например 1-14 |
type | string | Тип площадки: island — остров, pavilion — павильон, outdoor — уличная площадка |
area_size | number | Площадь в м² |
floor | object / null | Этаж: id (string) и name (integer) |
sector | object / null | Сектор: id (string) и name (string) |
В floor.name получите целочисленное название этажа. Поле level не входит
в ответ. Сектор принадлежит ТЦ; у площадки есть связь с этажом и сектором.
Для отсутствующего или скрытого этажа/сектора получите null. У уличной площадки
это касается служебного этажа -100 и сектора hidden.
Тип площадки выбирают отдельно от признаков фудкорта, якоря и прикассы.
Поля renter#
| Поле | Тип | Описание |
|---|---|---|
id | string | Идентификатор арендатора из справочника арендаторов |
legal_name | string | Наименование юридического лица |
inn | string / null | ИНН |
kpp | string / null | КПП |
is_contractor | boolean | Арендатор — подрядчик |
{
"success": true,
"data": [
{
"id": "6512a2000000000000000101",
"name": "Zarina",
"external_id": "SL-101",
"is_archived": false,
"position": {
"name": "1-14",
"id": "6512a3000000000000000101",
"type": "pavilion",
"area_size": 85.5,
"floor": {
"id": "6512a4000000000000000001",
"name": 1
},
"sector": {
"id": "6512a5000000000000000001",
"name": "А"
}
},
"renter": {
"id": "6512a1f0b3c4d5e6f7a8b911",
"legal_name": "ООО «Зарина»",
"inn": "7712345678",
"kpp": "771201001",
"is_contractor": false
},
"is_food_court": true,
"is_anchor": false,
"is_near_cashbox": false
},
{
"id": "6512a2000000000000000102",
"name": "Ostin",
"external_id": "SL-102",
"is_archived": true,
"position": {
"name": "2-03",
"id": "6512a3000000000000000102",
"type": "pavilion",
"area_size": 120.0,
"floor": {
"id": "6512a4000000000000000002",
"name": 2
},
"sector": {
"id": "6512a5000000000000000001",
"name": "А"
}
},
"renter": {
"id": "6512a1f0b3c4d5e6f7a8b912",
"legal_name": "ООО «Остин»",
"inn": "7712345679",
"kpp": "771201002",
"is_contractor": true
},
"is_food_court": false,
"is_anchor": true,
"is_near_cashbox": false
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 200,
"total": 137
}
}
}Практика#
Сопоставление точек. Используйте external_id, если указали собственные
идентификаторы точек. В запросах отчётов, чеков и касс передавайте id как shop_id.
Архивные точки. Передайте archived=true, чтобы получить идентификаторы
закрытых точек для исторических отчётов.