GET /customer?id={id}&ean={ean}&phone={phone}
Возвращает клиента по идентификатору, номеру карты или номеру телефона. Параметры задаются в адресной строке (URI parameters). Должен быть задан хотя бы один параметр
Запрос
Параметры адресной строки (URI parameters)
Поле | Описание | Тип | Обязательное |
---|---|---|---|
id |
Идентификатор клиента. Формат GUID |
string | |
ean |
Номер карты клиента. Формат EAN-8 или EAN13 (только цифры) |
string | |
phone |
Номер телефона клиента. Формат не имеет значение. Обязан содержать минимум 11 цифр |
string |
Ответ
Тело ответа ( объект 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, text/json
{ "multiplicityDebitBonus": 1.0, "phone": "sample string 1", "id": "d1bf5d0f-558a-4d0a-a6e1-b73903f4fb30", "discountCardTypeId": 3, "discountCardNumber": "sample string 4", "discountCardName": "sample string 5", "parentphone": "sample string 6", "availableBonuses": 7.0, "notActiveBonuses": 8.0, "lastPurchaseDate": "2025-03-31T16:56:46.7254025+03:00", "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-03-31T16:56:46.7254025+03:00", "lastUpdateDate": "2025-03-31T16:56:46.7254025+03:00", "createdInStore": "sample string 13", "disablePromoSMS": true, "relatives": [ { "birthDay": "sample string 1", "sex": "Female" }, { "birthDay": "sample string 1", "sex": "Female" } ], "createdInStoreId": 1, "lastOperationStoreID": 1, "createdByCashierId": 1 }, "purchasesTotalSum": 9.0, "purchasesSumToNextCard": 10.0, "nextCardName": "sample string 11", "regressEnabled": true, "bonusDebitDenided": true, "nearestBonusesExpirationAmount": 14.0, "avgPurchasesTotal": 15.0, "nearestBonusesExpirationDate": "sample string 16", "purchasesCount": 17, "confirmed": true, "inviteCode": "sample string 19", "registrationSourceId": "sample string 20", "baseDiscountPercent": 21.0, "baseBonusDebitPercent": 22.0, "baseBonusCreditPercent": 23.0, "telegramBotStatus": 24, "telegramBotRegistrationDate": "2025-03-31T16:56:46.7254025+03:00", "eCardStatusID": 1, "vkStatusID": 1, "disableAllMessages": true, "isBlocked": true }