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 Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полям: first_name - имя, middle_name - отчество, last_name - фамилия, main_phone - основной телефон, phones - доп телефоны, region_name - наименование региона
main_phone String Необязательный Основной телефон покупателя
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Описание
column Enum Значение для сортировки: <Id | 1> - Id покупателя, <GroupName | 2> - Наименование группы, <FirstName | 3> - Имя, <MiddleName | 4> - Отчество, <LastName | 5> - Фамилия, <Sex | 6> - Пол, <DateOfBirth | 7> - Дата рождения, <RegionName | 8> - Регион, <Address | 9> - Адрес, <MainPhone | 10> - Основной телефон, <Phones | 11> - Доп. телефоны, <ReferId | 12> - ID реферала, <LastUpdate | 13> - Дата изменения
direction Enum Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "ids": [
        1
    ],
    "group_ids": [
        1
    ],
    "region_ids": [
        1
    ],
    "refer_ids": [
        1
    ],
    "gender": "Male",
    "sort_orders": [
        {
            "column": "Name",
            "direction": "ASC"
        }
    ],
    "search": "example",
    "main_phone": "998998765432",
    "limit": 1,
    "offset": 0
}

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

Название Тип данных Описание
result Array of RetailCustomer Массив розничных покупателей
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "region": {
                "id": 1,
                "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": "Ann",
            "full_name": "Megan Ann 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": 1
}