get

[POST] …/v1/RetailCustomer/get

Возвращает информацию о покупателе

Входные параметры

Название	Тип данных	Обязательность	Описание параметра
ids	array of int64	Необязательный	Массив id покупателей
group_ids	array of int64	Необязательный	Массив id групп покупателей
gender	enum	Необязательный	Пол покупателя: male (мужской), female (женский)
region_ids	array of int64	Необязательный	Массив id регионов
refer_ids	array of int64	Необязательный	Массив id реферальных покупателей (от которых пришли выбираемые покупатели)
sort_orders	Sort_orders	Необязательный	Сортировка выходных данных - Объект класса Sort_orders
search	string	Необязательный	Строка поиска по полям first_name, middle_name, last_name, main_phone, phones, region_name
limit	Int32	Необязательный	Лимит возвращаемых данных при запросе
offset	Int32	Необязательный	Смещение от начала выборки

Sort_orders

Модель сортировки выходных параметров

Название	Тип данных	Описание параметра
column	enum	Значение для сортировки: Id ( Id покупателя), GroupName (Наименование группы), FirstName (Имя), MiddleName (Отчество), LastName (Фамилия), Sex (Пол), DateOfBirth (Дата рождения), RegionName (Регион), Address (Адрес), MainPhone (Основной телефон), Phones (Доп. телефоны), ReferId (id реферала), LastUpdate (Дата изменения)
direction	enum	Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

Пример запроса

{
    "ids":[1,2,3],
    "parent_ids":[1,2,3],
    "refer_ids":[1,2,3],
    "sort_orders":
    [
        {
        "column":'Name',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

Выходные параметры

Название	Тип данных	Обязательность	Описание параметра
Result	array of RetailCustomer	Обязательный	Массив объектов RetailCustomer

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "group": {
        "id": 1,
        "parent_id": 0,
        "name": "root",
        "last_update": 1539688864
      },
      "deleted_mark": false,
      "last_update": 1539770461,
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Ivanovich",
      "sex": "male",
      "document_name": "passport",
      "document_code": "12345678",
      "date_of_birth": "1995-07-10",
      "address": "qwerty",
      "main_phone": "+123456789012",
      "phones": "1",
      "refer_id": 0
    }
  ],
    "next_offset": 0,
  "total": 2
}