Торговые точки

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` — добавить архивные точки к действующим

archived=true расширяет выборку, а не заменяет её: в ответ попадут и действующие точки, и архивные. Отличить их можно по полю is_archived.

bash

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	Идентификатор точки во внешней системе, если он был передан нам
`is_archived`	boolean	Точка в архиве
`position`	object	`{ "name": "1-14" }` — обозначение помещения

json

{
  "success": true,
  "data": [
    {
      "id": "6512a2000000000000000101",
      "name": "Zarina",
      "external_id": "SL-101",
      "is_archived": false,
      "position": {
        "name": "1-14"
      }
    },
    {
      "id": "6512a2000000000000000102",
      "name": "Ostin",
      "external_id": "SL-102",
      "is_archived": true,
      "position": {
        "name": "2-03"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 200,
      "total": 137
    }
  }
}

Практика#

Сопоставлять лучше по external_id. Если идентификаторы точек из внешней системы были переданы нам, хранить стоит их, а не наши id: так связка переживёт перезаливку справочника.

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

Архивные не стоит отбрасывать слепо. Точка, закрывшаяся в середине месяца, попадёт в архив, но её выручка за прошедшие дни никуда не денется. Исторические выгрузки стоит запрашивать с archived=true.