Отримання карти клієнта

URI: /api/v1/promotion/customer/search/{number}

Попередня версія методу отримання карти клієнта

URI: /api/v1/promotion/customer/{drugstore_id}/{number} докладніше

⚠️ Попередня версія методу отримання карти клієнта підтримується але ії використання не рекомендується

Метод використовується для отримання даних профілю покупця по номеру телефона або дисконтної картки покупця.

Запит виконується методом GET.

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри URI

URI запиту має містити змінну:

Ім'я	Тип	Обов'язковий	Опис
number	string	Так	Номер телефона або дисконтної картки покупця

Приклади запиту

Пошук по номеру телефона покупця

/api/v1/promotion/customer/search/380991234567

Пошук по номеру дисконтної картки покупця

/api/v1/promotion/customer/search/3809300000011

Параметри відповіді

Ім'я	Тип	Опис
data	object	Дані клієнта
data.phone	string	Номер телефона клієнта
data.last_name	string	Прізвище клієнта
data.first_name	string	Ім'я клієнта
data.middle_name	string	Ім'я по батькові клієнта
data.city_name	string	Назва населеного пункту проживання клієнта
data.email	string	Адреса електронної пошти клієнта
data.birthday	string	Дата народження клієнта
data.gender	string	Стать клієнта: male — чоловік female — жінка asexual — без статі 🛈 Допускається лише повна текстова назва
data.discount_card_number	string	Номер дисконтної картки клієнта
data.want_free_samples	boolean	Прапор згоди отримання безкоштовних зразків
data.contact_via_phone	boolean	Прапор згоди зв'язку через телефон
data.contact_via_sms	boolean	Прапор згоди зв'язку через СМС
data.contact_via_email	boolean	Прапор згоди зв'язку через електронну пошту
data.contact_via_messenger	boolean	Прапор згоди зв'язку через месенджери
data.agree_terms_conditions	boolean	Прапор згоди з правилами та умовами
data.phone_verified	boolean	Прапор підтвердження номера телефона клієнта
data.bonuses	float/double	Кількість бонусів на рахунку клієнта
data.bonus_accounts	objects	Блок містить деталізацію по подарунковим бонусам клієнта
data.bonus_accounts.type	string	Тип бонусного рахунку
data.bonus_accounts.amount	float	Кількість подарункових бонусів, доступна для оплати з даного бонусного рахунку
data.bonus_accounts.date_from	string	Дата та час активації бонусів 🛈 Початковий час, з якого бонуси можуть бути використані
data.bonus_accounts.date_to	string	Дата та час згоряння бонусів 🛈 Кінцевий термін, після настання якого бонуси стають недійсними (неактивними) і не можуть бути списані
data.bonus_accounts.write_off_percent_from_total	float	Максимальний відсоток від загальної суми чека, який можна оплатити бонусами з цього рахунку 🛈 Значення 100 означає, що цими бонусами можна покрити всю суму покупки, якщо не встановлено інших обмежень
data.bonus_accounts.comment	string	Коментар. Передається назва подарункових бонусів
data.bonus_accounts.goods_ids	array	Список ID товарів, на які поширюються обмеження списання бонусів 🛈 Якщо масив порожній ([]), це означає, що обмежень на списання бонусів немає (бонуси можна використати для будь-якого товару)
data.locked	boolean	Статус блокування клієнтської карти: 0 — карта активна (не заблокована) 1 — карта заблокована
data.type	object	Тип карти
data.type.id	string	ID типу карти
data.type.name	string	Назва типу карти
data.address	string	Адреса клієнта
data.address_post_code	string	Поштовий індекс клієнта
data.address_flat	string	Номер квартири/будинку клієнта
data.children	array	Список з роками народження дітей клієнта
data.loyalty	boolean	Прапор активної програми лояльності
data.loyalty_date	string	Строк дії програми лояльності

Приклад відповіді

Відповідь: /api/v1/promotion/customer/search/380990000011

{
  "data": {
    "phone": "380990000011",
    "last_name": "Литвин",
    "first_name": "Татьяна",
    "middle_name": "Ивановна",
    "city_name": null,
    "email": "shevchenko@test.com",
    "birthday": "23.10.1988",
    "gender": "f",
    "discount_card_number": "3809378760366",
    "want_free_samples": 0,
    "contact_via_phone": 0,
    "contact_via_sms": 0,
    "contact_via_email": 0,
    "contact_via_messenger": 0,
    "agree_terms_conditions": 1,
    "phone_verified": 0,
    "bonuses": 0,
    "bonus_accounts": [
            {
                "type": "gift",
                "amount": 1.49,
                "date_from": "2025-09-18 00:00:00",
                "date_to": "2026-09-17 00:00:00",
                "write_off_percent_from_total": 100,
                "comment": "ТЕСТ Деталізація подарункових бонусів 3",
                "goods_ids": []
            },
            {
                "type": "gift",
                "amount": 6.98,
                "date_from": "2025-09-18 00:00:00",
                "date_to": "2026-09-17 00:00:00",
                "write_off_percent_from_total": 100,
                "comment": "ТЕСТ Деталізація подарункових бонусів 3",
                "goods_ids": []
            }
        ],
    "locked": 1,
    "type": {
      "id": "ded7f987-719c-41ac-ad53-fe26ab83490d",
      "name": "Універсальна"
    },
    "address": null,
    "address_post_code": null,
    "address_flat": null,
    "children": [],
    "loyalty": false,
    "loyalty_date": null
  }
}