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
email

email'ы

 Массив string
firstName

Имена

 Массив string
lastName

Фамилии

 Массив string
middleName

Отчества

 Массив string
description

Примечания

 Массив string
address

Адреса

 Массив string
sex

Пол

 Массив CustomerSexTypes
card

Список карт (статусов)

 Массив int
registrationSources

Источники регистрации

 Массив int
personsList

Список карт (статусов)

 Массив int
cashier

Список кассиров, которые создавали клиентов

 Массив int
cardNumber

Номера карт

 Массив string
store

Список магазинов, в котором были созданы клиенты

 Массив int
birthday

Интервалы дат дней рождения

 Массив DateTimeInterval
birthdayDay

Дни рождения

 Массив int
birthdayMonth

Месяцы рождения

 Массив int
personId

Идентификаторы клиентов

 Массив GUID
bonusAmount

Количество бонусов на счету

 Массив IntegerInterval
purchasesCount

Количество совершенный покупок

 Массив IntegerInterval
avgPurchasesTotal

Средний чек

 Массив DecimalInterval
purchaseSum

Количество совершенный покупок

 Массив IntegerInterval
lastPurchase

Даты совершения последних покупок

 Массив DateTimeInterval
disablePromoSms

DisablePromoSms

 bool
startRow

Порядковый номер клиента в результате поиска. Используется для пейджинга

 int
rowCount

Количество возвращаемых клиентов (максимум 1000). Используется для пейджинга

 int
sort

Тип сортировки списка

 Массив CustomerSortTypes
sortDesc

Если true - сортировка в обратном порядке

 bool

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

application/json, text/json

Sample: 
{
  "purchaseSumMode": 1,
  "creationDate": [
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "lastUpdateDate": [
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "telegramBotRegistrationDate": [
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "personRelativesBirthday": [
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "eCardStatus": [
    1,
    2
  ],
  "age": {
    "from": 1,
    "to": 1
  },
  "telegramStatus": [
    1,
    2
  ],
  "vkStatus": [
    1,
    2
  ],
  "phone": [
    "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"
  ],
  "description": [
    "sample string 1",
    "sample string 2"
  ],
  "address": [
    "sample string 1",
    "sample string 2"
  ],
  "sex": [
    "Male",
    "Male"
  ],
  "card": [
    1,
    2
  ],
  "registrationSources": [
    1,
    2
  ],
  "personsList": [
    1,
    2
  ],
  "cashier": [
    1,
    2
  ],
  "cardNumber": [
    "sample string 1",
    "sample string 2"
  ],
  "store": [
    1,
    2
  ],
  "birthday": [
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "birthdayDay": [
    1,
    1
  ],
  "birthdayMonth": [
    1,
    1
  ],
  "personId": [
    "c9174099-5228-40f0-bb03-ded4c81b6434",
    "4a145e57-35c9-483c-9931-813948a4e782"
  ],
  "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": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    },
    {
      "from": "2024-04-26T21:11:39.4945263+03:00",
      "to": "2024-04-26T21:11:39.4945263+03:00"
    }
  ],
  "disablePromoSms": true,
  "startRow": 1,
  "rowCount": 2,
  "sort": [
    "CreationDate",
    "CreationDate"
  ],
  "sortDesc": true
}

Ответ

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

ПолеОписаниеТипОбязательное
phone

Номер телефона клиента. Формат не имеет значение. Обязан содержать минимум 11 цифр

 string
id

Идентификатор клиента в формате GUID

 GUID
discountCardTypeId

id типа карты

 int
discountCardNumber

Номер карты

 string
discountCardName

Наименование карты (статуса)

 string
parentphone

Номер телефона рекомендателя. Формат не имеет значение. Обязан содержать минимум 11 цифр

 string
availableBonuses

Количество бонусов, доступных к использованию

 decimal
notActiveBonuses

Количество неактивных бонусов

 decimal
lastPurchaseDate

Дата последней покупки

 datetime
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
multiplicityDebitBonus

Количество бонусов, списываемых на покупку должно быть кратно этому параметру

 decimal

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

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.