Точки

Точка (салон, заведение, магазин) - модель места, в котором оказываются услуги, продаются товары и/или хранятся товары.

Любая точка выступает в роли склада и может быть использована для выполнения складских операций (поступления, списания, перемещения), но только точки с параметром can_sales: True могут быть использованы для оформления визитов гостей.

Модель точки

Поле

Тип

Описание

id

ObjectId

Уникальный идентификатор точки

changed

datetime

Дата последнего редактирования точки

name

str

Название точки

location

Optional[Tuple[float, float]]

Координаты точки

can_sales

bool

Флаг возможности выполенния продаж

city

Optional[str]

Город

address

Optional[str]

Адрес (строкой)

passport

Optional[Passport]

Паспорт точки

Паспорт точки

Поле

Тип

Описание

status

Enum

Статус точки

opendate

datetime

Дата открытия точки

type

str

Тип точки

Ключи документов так же включают в себя Разделяемые поля.

Список точек

Для работы со списком точек используется API GET /api/unit. Оно поддерживает следующие параметры фильтрации

Ключ

Тип

Значение

query

str

Строковый поиск по названию

ids

List[ObjectId]

Список идентификаторов точек

franchisees

List[ObjectId]

Список франчайзи-владельцев точки. Работает только для франчайзеров

franchisees_ne

List[ObjectId]

Аналогично предыдущему, исключающе

can_sales

bool

Флаг возможности выполнения продаж

API использует стандартную схему пагинации. Дополнительно в заголовке CountNotConfirmed передается количество точек, ожидающих подтверждения франчайзером (если в системе используется подтверждение паспорта точки).

Количество записей в одном запросе определяется GET-параметром limit и по-умолчанию равно 20. Для пагинации по списку необходимо использовать параметр offset, определяющий количество пропускаемых записей.

Пример запроса списка точек

curl --header "Authorization: Bearer persistent d6f0cb68-a176-464a-82dc-a2958b99c1fb" http://demo.idealist.one/api/unit -vvv

< HTTP/1.1 200 OK
< Content-Type: application/json
< Count: 1
< CountNotConfirmed: 0

[
  {
    "id": "56985551ec27b52aed1580df",
    "changed": "2016-01-15T02:11:29+00:00",
    "active": true,
    "editable": true,
    "readable": true,
    "accessible": true,
    "name": "Династия",
    "location": null,
    "can_sales": true,
    "confirmed": true,
    "operation": null,
    "city": "Москва",
    "address": "ул. Заводская",
    "acquiring": false,
    "tables": [],
    "menus": [],
    "default_cash": {
      "id": "55c21a7a8ea6c632e51376f2"
    },
    "default_cashless": {
      "id": "55c3033b8ea6c632d1137898"
    },
    "passport": {
      "pos_photo": [],
      "extra_images": [],
      "status": "open",
      "opendate": "2015-12-11T00:00:00+00:00",
      "type": "Торговый центр",
      "square": 12,
      "around_the_clock": false,
      "worktime": {
        "tuesday": {
          "begin": "10:00",
          "active": true
        },
        "friday": {
          "begin": "10:00",
          "active": true
        },
        "monday": {
          "begin": "10:00",
          "active": true
        },
        "saturday": {
          "begin": "10:00",
          "active": true
        },
        "wednesday": {
          "begin": "10:00",
          "active": true
        },
        "thursday": {
          "begin": "10:00",
          "active": true
        },
        "sunday": {
          "begin": "10:00",
          "active": true
        }
      },
      "rent": 1
    },
    "use_remote_printer": false
  }
]