Получить информацию о клиенте и его картах
GET /buyers/getBuyer#
GET /buyers/getBuyerОписание#
Метод getBuyer предназначен для получения информации о покупателе и его картах. Если клиент не найден по номеру телефона и номеру карты, то возвращается ошибка
Параметры#
| Тип | Имя | Описание | Схема |
|---|---|---|---|
| Query | apiKey обязательно | Апи ключ | string |
| Query | number необязательно | Номер дисконтной карты клиента | string |
| Query | phone необязательно | Номер телефона клиента | string |
| Query | retailer обязательно | Внутренний код торговой сети | string |
Ответы#
| HTTP код | Описание | Схема |
|---|---|---|
| 200 | successful operation | BuyerJSON |
| 801 | Неизвестный код торговой сети | Без содержимого |
| 827 | Покупатель не найден | Без содержимого |
Возвращает#
application/json
BuyerJSON#
| Имя | Описание | Схема |
|---|---|---|
| phone обязательно | Номер телефона клиента | string |
| additionalEmails необязательно | Дополнительные e-mail адреса | < string > array |
| birthday необязательно | Дата рождения | string (date-time) |
| cards необязательно | Список карт клиента | < CardJSON > array |
| email необязательно | Адрес электронной почты | string |
| emailVerified необязательно | Признак подтверждения email | string (date-time) |
| gender необязательно | Пол клиента | enum (Male, Female) |
| isBirthdaySuspended необязательно | Признак, что дата рождения не подтверждена | boolean |
| name необязательно | ФИО клиента | string |
| status необязательно | Статус клиента | enum (Active, Close, BlockedByCheat) |
| verified необязательно | Признак подтверждения номера телефона | string (date-time) |
CardJSON#
| Имя | Описание | Схема |
|---|---|---|
| cardDate обязательно | Дата создания карты | string (date-time) |
| cardType обязательно | Тип карты | CardTypeJSON |
| firstDateCheck необязательно | Дата первого чека по карте | string (date-time) |
| number обязательно | Номер карты | string |
| status обязательно | Статус карты Active(Активная), Disabled(Заблокированная), NonEmitted(Не выпущена), Temporary(Временная) | enum (Active, Disabled, NonEmitted, Temporary) |
| type обязательно | Тип карты Material(Физическая), Virtual(Виртуальная) | enum (Material, Virtual) |
CardTypeJSON#
| Имя | Описание | Схема |
|---|---|---|
| barcodeType обязательно | Формат штрих-кода карт | enum (EAN13, CODE128) |
| internalCode обязательно | Внутренний код типа карты | string |
| name обязательно | Наименование типа карты | string |