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 реферальных покупателей (от которых пришли выбираемые покупатели)
sex Enum Необязательный Пол покупателя: none = 1 (не указан), male = 2 (мужской), female = 3 (женский)
sort_orders Array of SortOrders Необязательный Сортировка выходных параметров
filters Array of Filter Необязательный Фильтры по основным и дополнительным полям
search String Необязательный Строка поиска по полям: first_name - имя, middle_name - отчество, last_name - фамилия, main_phone - основной телефон, phones - доп телефоны, region_name - наименование региона
main_phone String Необязательный Основной телефон покупателя
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки

Поля, доступные для сортировки (sort_orders):

id, group.name, first_name, middle_name, last_name, sex, date_of_birth, 
region.name, address, main_phone, phones, refer_id, last_update

Поля, доступные для фильтрации (filters):

phone, email, debt, last_purchase, date_of_birth, field_telegram_id

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

{
    "ids": [
        1
    ],
    "group_ids": [
        1
    ],
    "region_ids": [
        1
    ],
    "refer_ids": [
        1
    ],
    "gender": "Male",
    "sort_orders": [
        {
            "column": "first_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
}