3.4.1. Список торговых точек
Метод предназначен для получения списка торговых точек, которые входят в подразделение и его дочерние подразделения. Метод может использоваться для получения всех торговых точек.
Метод синхронный. Если подразделение не найдено, метод возвращает код ошибки 3104: «Подразделение не найдено».
HTTP-запрос:
HTTP-Method: GET
|
Адрес запроса (URI)
| |
|
https://<server>.taxcom.ru/API/v2/OutletList
| |
|
Параметры запроса
| |
|
id
|
ИД подразделения
Необязательный параметр (не передается, если требуется получить список всех торговых точек)
|
|
np
|
Фильтр по признаку наличия проблемы:
· OK – Нет проблем
· Warning – Предупреждение
· Problem – Есть проблема
Необязательный параметр
|
|
pn
|
Номер страницы результатов
Необязательный параметр (если не передан, то возвращается первая страница результатов)
|
|
ps
|
Кол-во результатов на странице (1-100)
Необязательный параметр (если не передан, то возвращается 100 записей)
|
|
Заголовок запроса
| |
|
Session-Token
|
Маркер временного доступа
|
HTTP-ответ:
JSON ответ со списком торговых точек. Формат ответа описывается схемой «OutletList_Response.jsonscheme» (Приложение №4).
Данные в ответе:
|
Поле
|
Тип
|
|
Дата формирования ответа
|
datetime
|
|
Всего записей
|
integer
|
|
Записей с учетом фильтра
|
integer
|
|
Записей в ответе
|
integer
|
|
ИД подразделения
|
string
|
|
Название подразделения
|
string
|
|
Код подразделения
|
string
|
|
ИД торговой точки
|
string
|
|
Название торговой точки
|
string
|
|
Код торговой точки
|
string
|
|
Адрес торговой точки
|
string
|
|
Признак наличия проблемы
|
enum:
· OK – Нет проблем
· Warning – Предупреждение
· Problem – Есть проблема
|