Точки

Точки магазина: магазины, склады, кухни и пункты самовывоза. На них ссылаются остатки, заказы и самовывоз.

Загружаем поисковый индекс…

Точки

Объекты

Location

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • nameсловарь stringобязательно

    Название по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.

  • addressstringобязательно

    Адрес точки одной строкой.

  • coordinatesobject или nullобязательно

    Точка на карте; null, если не задана. Точка без координат не показывается на карте витрины.

    Поля · 2
    • latnumberобязательно

      Широта в градусах.

    • lngnumberобязательно

      Долгота в градусах.

  • phonestring или nullобязательно

    Телефон точки; null, если не задан.

  • is_activebooleanобязательно

    false, если магазин выключил точку.

  • is_defaultbooleanобязательно

    Основная точка магазина: заказы с доставкой списывают остаток с неё, если другая точка не выбрана. У магазина она одна.

  • is_pickup_pointbooleanобязательно

    Покупатели могут забирать заказы в этой точке.

  • is_stock_sourcebooleanобязательно

    Точка хранит товар: у неё есть остатки, она принимает поставки, проводит ревизии и перемещения.

  • fulfills_online_ordersbooleanобязательно

    Остаток точки продаётся покупателям онлайн. Значим только при is_stock_source = true: кухня хранит товар, но не продаёт его.

  • price_list_idinteger или nullобязательно

    Прайс-лист точки: цены продаж в ней поверх базовых. null — точка продаёт по базовым ценам. Один лист может служить нескольким точкам.

  • working_hoursсловарь массив objectобязательно

    Часы работы: день недели (mon, tue, wed, thu, fri, sat, sun) → список интервалов в часовом поясе магазина. День без интервалов — выходной.

    Поля · 2
    • fromstringобязательно

      Начало интервала, ЧЧ:ММ.

    • tostringобязательно

      Конец интервала, ЧЧ:ММ. Конец раньше начала значит, что интервал переходит через полночь.

  • temporarily_closed_atstring (date-time) или nullобязательно

    Когда точка временно закрылась; null, если она работает.

  • reopens_onstring (date) или nullобязательно

    Дата, когда временно закрытая точка откроется снова, в часовом поясе магазина; null, если точка работает или дата неизвестна.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Точки магазина, доступные приложению

get/locations

Scope: locations:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

Ответы

200Успешно

application/json

  • dataмассив Locationобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/locations" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "name": {
        "key": "string"
      },
      "address": "string",
      "coordinates": {
        "lat": 0,
        "lng": 0
      },
      "phone": "string",
      "is_active": true,
      "is_default": true,
      "is_pickup_point": true,
      "is_stock_source": true,
      "fulfills_online_orders": true,
      "price_list_id": 0,
      "working_hours": {
        "key": [
          {
            "from": "string",
            "to": "string"
          }
        ]
      },
      "temporarily_closed_at": "2026-01-15T12:00:00Z",
      "reopens_on": "2026-01-15",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}