Get

[POST] …/v1/RetailCustomer/Get

Возвращает массив розничных покупателей.

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

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


SortOrders

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

Название Тип данных Описание параметра
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],
    "group_ids":[1,2,3],
    "region_ids":[1,2,3],
    "refer_ids":[1,2,3],
    "gender": "male",
    "sort_orders":
    [
        {
            "column":"Name",
            "direction":"desc"
        }
    ],
    "search": "FirstName",
    "main_phone": "998998765432",
    "limit":20,
    "offset":3
}

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

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

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

{
  "ok": true,
  "result": [
    {
      "id": 4,
      "region": {
        "id": 2,
        "parent_id": 0,
        "name": "Samarkand",
        "last_update": 1718702656
      },
      "group": {
        "id": 1,
        "parent_id": 0,
        "name": "Покупатели",
        "last_update": 1718202013,
        "child_count": 0
      },
      "last_purchase": 0,
      "deleted_mark": false,
      "last_update": 1718711661,
      "first_name": "Megan",
      "last_name": "Williams",
      "middle_name": null,
      "full_name": "Megan  Williams",
      "sex": "female",
      "date_of_birth": "1964-12-22",
      "address": "Feliciashire",
      "main_phone": "998952087619",
      "phones": "+998952087619",
      "email": null,
      "refer_id": -1,
      "description": "Customer 4"
    }
  ],
  "next_offset": 1,
  "total": 300
}