POST /customer
Создание нового Клиента
Запрос
Информация о Клиенте. Номер телефона - обязательное поле. Все остальные поля не обязательны
Тело запроса (объект CreateCustomer )
| Поле | Описание | Тип | Обязательное |
|---|---|---|---|
| phone |
Номер телефона клиента. Формат не имеет значение. Обязан содержать минимум 11 цифр |
string |
Да |
| ean |
Номер карты клиента. Формат EAN-8 или EAN13 (только цифры) |
string | |
| regBonus |
Количество стартовых бонусов |
decimal | |
| card |
Наименование карты (статуса) Клиента |
string | |
| parentphone |
Номер телефона рекомендателя. Формат не имеет значение. Обязан содержать минимум 11 цифр |
string | |
| fn |
Имя |
string | |
| ln |
Фамилия |
string | |
| mn |
Отчетсво |
string | |
| sex |
Пол |
SexEnum | |
|
Адрес электронной почны |
string | ||
| desc |
Примечание |
string | |
| birthDay |
Дата рождения в формате ДД.ММ.ГГГГ |
string | |
| profileInstagram |
Ссылка на Инстаграм |
string | |
| profileVkontakte |
Ссылка на страницу в ВКонтакте |
string | |
| profileOdnoklassniki |
Ссылка на страницу в Одноклассниках |
string | |
| address |
Адрес |
string | |
| utmSource |
Источник рекламы |
string | |
| relatives |
Родственники (близкие) |
Массив PersonRelative | |
| disablePromo |
Отключить промо-сообщения |
bool | |
| storeId |
идентификатор магазина |
string | |
| store |
название магазина |
string | |
| cashierId |
идентификатор кассира |
string | |
| registrationSourceId |
идентификатор источника регистрации |
string | |
| noRegNotification |
Отключает отправку регистрационного сообщения клиенту |
bool | |
| creditBonuses |
Начислять подарочные бонусы |
bool | |
| smsCreditBonuses |
Отправлять сообщение о подарочных бонусах за регистрацию |
bool |
Пример запроса
application/json, text/json
{
"phone": "sample string 1",
"ean": "sample string 2",
"regBonus": 3.0,
"card": "sample string 4",
"parentphone": "sample string 5",
"fn": "sample string 6",
"ln": "sample string 7",
"mn": "sample string 8",
"sex": "Female",
"email": "sample string 9",
"desc": "sample string 10",
"birthDay": "sample string 11",
"profileInstagram": "sample string 12",
"profileVkontakte": "sample string 13",
"profileOdnoklassniki": "sample string 14",
"address": "sample string 15",
"utmSource": "sample string 16",
"relatives": [
{
"birthDay": "sample string 1",
"sex": "Female",
"name": "sample string 2"
},
{
"birthDay": "sample string 1",
"sex": "Female",
"name": "sample string 2"
}
],
"disablePromo": true,
"storeId": "sample string 18",
"store": "sample string 19",
"cashierId": "sample string 20",
"confirmed": true,
"registrationSourceId": "sample string 22",
"noRegNotification": true,
"creditBonuses": true,
"smsCreditBonuses": 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, text/json
{
"multiplicityDebitBonus": 1.0,
"phone": "sample string 1",
"id": "52bf8872-bbcc-42aa-94b3-c75d9b678eb8",
"discountCardTypeId": 3,
"discountCardNumber": "sample string 4",
"discountCardName": "sample string 5",
"parentphone": "sample string 6",
"availableBonuses": 7.0,
"notActiveBonuses": 8.0,
"lastPurchaseDate": "2025-12-06T07:02:17.916964+03:00",
"firstPurchaseDate": "2025-12-06T07:02:17.916964+03:00",
"totalBonusCredit": 9.0,
"totalBonusDebit": 10.0,
"person": {
"fn": "sample string 1",
"ln": "sample string 2",
"mn": "sample string 3",
"sex": "Female",
"email": "sample string 4",
"desc": "sample string 5",
"birthDay": "sample string 6",
"profileInstagram": "sample string 7",
"profileVkontakte": "sample string 8",
"profileOdnoklassniki": "sample string 9",
"address": "sample string 10",
"utmSource": "sample string 11",
"creationDate": "2025-12-06T07:02:17.916964+03:00",
"lastUpdateDate": "2025-12-06T07:02:17.916964+03:00",
"createdInStore": "sample string 13",
"disablePromoSMS": true,
"relatives": [
{
"birthDay": "sample string 1",
"sex": "Female",
"name": "sample string 2"
},
{
"birthDay": "sample string 1",
"sex": "Female",
"name": "sample string 2"
}
],
"significantDates": [
{
"id": "fec9585e-2c60-47fb-9c01-d9c0ed82b2c1",
"significantDateId": "2ae5990a-3157-40b6-8121-cad9575cbe49",
"significantDateType": 3,
"name": "sample string 4",
"date": "2025-12-06T07:02:17.916964+03:00",
"sex": 1
},
{
"id": "fec9585e-2c60-47fb-9c01-d9c0ed82b2c1",
"significantDateId": "2ae5990a-3157-40b6-8121-cad9575cbe49",
"significantDateType": 3,
"name": "sample string 4",
"date": "2025-12-06T07:02:17.916964+03:00",
"sex": 1
}
],
"createdInStoreId": 1,
"lastOperationStoreID": 1,
"createdByCashierId": 1
},
"purchasesTotalSum": 11.0,
"purchasesSumToNextCard": 12.0,
"nextCardName": "sample string 13",
"regressEnabled": true,
"bonusDebitDenided": true,
"nearestBonusesExpirationAmount": 16.0,
"avgPurchasesTotal": 17.0,
"nearestBonusesExpirationDate": "sample string 18",
"purchasesCount": 19,
"confirmed": true,
"inviteCode": "sample string 21",
"registrationSourceId": "sample string 22",
"baseDiscountPercent": 23.0,
"baseBonusDebitPercent": 24.0,
"baseBonusCreditPercent": 25.0,
"telegramBotStatus": 26,
"telegramBotRegistrationDate": "2025-12-06T07:02:17.916964+03:00",
"eCardStatusID": 1,
"vkStatusID": 1,
"disableAllMessages": true,
"isBlocked": true,
"archived": true
}