POST /customer/list

Возвращает список клиентов по заданному фильтру. Максимальное количество возвращаемых клиентов за один запрос - 1000 (задается в параметрах фильтра)

Запрос

Фильтр для поиска клиентов

Тело запроса (объект CustomerFilter )

Поле	Описание	Тип
purchaseSumMode	Учитывать продажи только из БонусПлюс	int
creationDate	Интервалы дат создания клиента	Массив DateTimeInterval
lastUpdateDate	Интервалы дат последнего изменения клиента	Массив DateTimeInterval
telegramBotRegistrationDate	Интервалы дат создания клиента	Массив DateTimeInterval
personRelativesBirthday		Массив DateTimeInterval
eCardStatus	Список Ecard статусов	Массив int
age	Возраст	IntegerInterval
telegramStatus	Список Telegram статусов	Массив int
vkStatus	Список VK статусов	Массив int
phone	Телефоны	Массив string
parentPhone	Телефоны рекомендателей	Массив string
email	email'ы	Массив string
firstName	Имена	Массив string
lastName	Фамилии	Массив string
middleName	Отчества	Массив string
firstNameIsNull		bool
lastNameIsNull		bool
middleNameIsNull		bool
description	Примечания	Массив string
address	Адреса	Массив string
sex	Пол	Массив CustomerSexTypes
card	Список карт (статусов)	Массив int
registrationSources	Источники регистрации	Массив int
personsList	Список карт (статусов)	Массив int
cashier	Список кассиров, которые создавали клиентов	Массив int
cardNumber	Номера карт	Массив string
store	Список магазинов, в котором были созданы клиенты	Массив int
createInStore	Список магазинов, в котором были созданы клиенты	Массив int
birthday	Интервалы дат дней рождения	Массив DateTimeInterval
birthdayDay	Дни рождения	Массив int
birthdayMonth	Месяцы рождения	Массив int
personId	Идентификаторы клиентов	Массив GUID
bonusAmount	Количество бонусов на счету	Массив IntegerInterval
purchasesCount	Количество совершенный покупок	Массив IntegerInterval
avgPurchasesTotal	Средний чек	Массив DecimalInterval
purchaseSum	Количество совершенный покупок	Массив IntegerInterval
lastPurchase	Даты совершения последних покупок	Массив DateTimeInterval
firstPurchase	Даты совершения первых покупок	Массив DateTimeInterval
disablePromoSms	DisablePromoSms	bool
blocked	Blocked	bool
archived	Archived	bool
byRefferal	Пришел по рекомендации	bool
segmentIds	SegmentIds	Массив string
notInSegmentIds		Массив string
personIds		Массив string
startRow	Порядковый номер клиента в результате поиска. Используется для пейджинга	int
rowCount	Количество возвращаемых клиентов (максимум 1000). Используется для пейджинга	int
sort	Тип сортировки списка	Массив CustomerSortTypes
sortDesc	Если true - сортировка в обратном порядке	bool
rfm		Dictionary of GUID [key] and RFFilter [value]
GetAllCustomers		bool

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

application/json, text/json

Sample:

{
  "purchaseSumMode": 1,
  "creationDate": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "lastUpdateDate": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "telegramBotRegistrationDate": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "personRelativesBirthday": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "eCardStatus": [
    1,
    2
  ],
  "age": {
    "from": 1,
    "to": 1
  },
  "telegramStatus": [
    1,
    2
  ],
  "vkStatus": [
    1,
    2
  ],
  "phone": [
    "sample string 1",
    "sample string 2"
  ],
  "parentPhone": [
    "sample string 1",
    "sample string 2"
  ],
  "email": [
    "sample string 1",
    "sample string 2"
  ],
  "firstName": [
    "sample string 1",
    "sample string 2"
  ],
  "lastName": [
    "sample string 1",
    "sample string 2"
  ],
  "middleName": [
    "sample string 1",
    "sample string 2"
  ],
  "firstNameIsNull": true,
  "lastNameIsNull": true,
  "middleNameIsNull": true,
  "description": [
    "sample string 1",
    "sample string 2"
  ],
  "address": [
    "sample string 1",
    "sample string 2"
  ],
  "sex": [
    "Female",
    "Female"
  ],
  "card": [
    1,
    2
  ],
  "registrationSources": [
    1,
    2
  ],
  "personsList": [
    1,
    2
  ],
  "cashier": [
    1,
    2
  ],
  "cardNumber": [
    "sample string 1",
    "sample string 2"
  ],
  "store": [
    1,
    2
  ],
  "createInStore": [
    1,
    2
  ],
  "birthday": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "birthdayDay": [
    1,
    1
  ],
  "birthdayMonth": [
    1,
    1
  ],
  "personId": [
    "72d41e3b-568f-44b1-b41f-8ef7ffb36996",
    "456e5651-a179-4071-8785-6733017468cf"
  ],
  "bonusAmount": [
    {
      "from": 1,
      "to": 1
    },
    {
      "from": 1,
      "to": 1
    }
  ],
  "purchasesCount": [
    {
      "from": 1,
      "to": 1
    },
    {
      "from": 1,
      "to": 1
    }
  ],
  "avgPurchasesTotal": [
    {
      "from": 1.0,
      "to": 1.0
    },
    {
      "from": 1.0,
      "to": 1.0
    }
  ],
  "purchaseSum": [
    {
      "from": 1,
      "to": 1
    },
    {
      "from": 1,
      "to": 1
    }
  ],
  "lastPurchase": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "firstPurchase": [
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    },
    {
      "from": "2025-12-06T07:09:26.0915092+03:00",
      "to": "2025-12-06T07:09:26.0915092+03:00"
    }
  ],
  "disablePromoSms": true,
  "blocked": true,
  "archived": true,
  "byRefferal": true,
  "segmentIds": [
    "sample string 1",
    "sample string 2"
  ],
  "notInSegmentIds": [
    "sample string 1",
    "sample string 2"
  ],
  "personIds": [
    "sample string 1",
    "sample string 2"
  ],
  "startRow": 1,
  "rowCount": 2,
  "sort": [
    "CreationDate",
    "CreationDate"
  ],
  "sortDesc": true,
  "rfm": {
    "347cd8f4-5526-4cfb-9b54-99b18e1ac7b0": {
      "rfms": [
        {
          "r": 1,
          "f": 2
        },
        {
          "r": 1,
          "f": 2
        }
      ],
      "rfmDate": "2025-12-06T07:09:26.0915092+03:00",
      "groups": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "e6ed12dc-e773-4e28-aef1-b6806629f506": {
      "rfms": [
        {
          "r": 1,
          "f": 2
        },
        {
          "r": 1,
          "f": 2
        }
      ],
      "rfmDate": "2025-12-06T07:09:26.0915092+03:00",
      "groups": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "GetAllCustomers": true
}

Ответ

Тело ответа ( объект Массив Customer )

Поле	Описание	Тип
phone	Номер телефона клиента. Формат не имеет значение. Обязан содержать минимум 11 цифр	string
id	Идентификатор клиента в формате GUID	GUID
discountCardTypeId	id типа карты	int
discountCardNumber	Номер карты	string
discountCardName	Наименование карты (статуса)	string
parentphone	Номер телефона рекомендателя. Формат не имеет значение. Обязан содержать минимум 11 цифр	string
availableBonuses	Количество бонусов, доступных к использованию	decimal
notActiveBonuses	Количество неактивных бонусов	decimal
lastPurchaseDate	Дата последней покупки	datetime
firstPurchaseDate	Дата первой покупки	datetime
totalBonusCredit	Всего начислено бонусов	decimal
totalBonusDebit	Всего использовано бонусов	decimal
person	Персональная информация	PersonInfo
purchasesTotalSum	Общая сумма совершенных покупок	decimal
purchasesSumToNextCard	Сумма покупок, необходимая для получения новой карты (статуса)	decimal
nextCardName	Следущая карта (статус)	string
regressEnabled	Статус клиента может понижаться (зависит от настроек программы лояльности)	bool
bonusDebitDenided	Запрещено списание бонусов	bool
nearestBonusesExpirationAmount	Количество бонусов, которые сгорают в ближайшее время	decimal
avgPurchasesTotal	Количество бонусов, которые сгорают в ближайшее время	decimal
nearestBonusesExpirationDate	Дата ближайшего сгорания бонусов	string
purchasesCount	Количество совершенных покупок	int
confirmed	Значение true означает, что номер телефона был подтвержден и клиент дал согласие на получение рекламных сообщений	bool
inviteCode	Пригласительный код (может использовать для связки клиентов по системе рекомендаций)	string
registrationSourceId	идентификатор источника регистрации	string
baseDiscountPercent	Базовая скидка в процентах	decimal
baseBonusDebitPercent	Базовое списание бонусов в процентах	decimal
baseBonusCreditPercent	Базовое начисление бонусов в процентах	decimal
telegramBotStatus	Активен в телеграм	int
telegramBotRegistrationDate		datetime
eCardStatusID	Активен в телеграм	int
vkStatusID	Активен в ВК	int
disableAllMessages		bool
isBlocked		bool
archived		bool
multiplicityDebitBonus	Количество бонусов, списываемых на покупку должно быть кратно этому параметру	decimal

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

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.