---
title: "Поиск клиента"
method: GET
path: "/customers/find"
tags: ["Customers"]
---

# Поиск клиента

`GET /customers/find`

Поиск клиента по коду на оплату, номеру телефона или UID. Важно! Необходимо передавать только один из параметров: или код клиента, или номер телефона, или UID.

## Query parameters

- `code` string
- `phone` string
- `uid` string
- `exchangeCode` boolean
- `total` number
- `skipLoyaltyTotal` number
- `unredeemableTotal` number

## Response `200`

Клиент, найденный по указанным критериям поиска.

- object
  - `user` CustomerDetail — Клиент, зарегистрированный в программе лояльности компании. Содержит информацию профиля UDS, текущий баланс баллов, уровень и статистику транзакций.
    - `uid` string, nullable — Идентификатор клиента в UDS (UID).
    - `avatar` string, nullable — URL изображения клиента.
    - `displayName` string — Имя клиента.
    - `gender` 'MALE' | 'FEMALE' | 'NOT_SPECIFIED', nullable — Пол.
    - `phone` string, nullable — Номер телефона клиента.
    - `birthDate` string, date, nullable — Дата рождения клиента.
    - `participant` Participant — Данные клиента в программе лояльности компании — баланс баллов, ставки скидок, статистика транзакций и уровень членства.
      - `id` integer, nullable — ID клиента в компании.
      - `inviterId` integer, nullable — ID клиента в компании, пригласившего данного клиента.
      - `points` number — Баланс бонусных баллов клиента.
      - `discountRate` number — Размер скидки (в процентах).
      - `cashbackRate` number — Размер кешбэка (в процентах) для данного клиента UDS.
      - `cashSpent` number — Общая сумма, оплаченная клиентом деньгами по всем завершённым покупкам (без учёта оплаты баллами). Используется для автоматического повышения уровня.
      - `savedFunds` number — Сумма общей выгоды с учетом прямой скидки и оплатой бонусами и сертификатами.
      - `invitedCount` integer — Общее количество людей, которых клиент пригласил в программу лояльности по реферальной ссылке.
      - `effectiveInvitedCount` integer — Количество приглашённых людей, совершивших хотя бы одну покупку (эффективные рекомендации). Используется для условий повышения уровня.
      - `operationsCount` integer — Общее количество покупок данного клиента.
      - `fullRefundsCount` integer — Количество полных возвратов.
      - `note` string, nullable — Заметка.
      - `membershipTier` MembershipTier — Конфигурация уровня (статуса) в программе лояльности. Определяет ставку скидки/кешбэка и условия автоматического повышения по сумме покупок или количеству рекомендаций.
        - `uid` string — Идентификатор статуса.
        - `name` string, required — Название статуса.
        - `rate` number, required — Коэффициент статуса.
        - `maxScoresDiscount` number, nullable — Процент счета, который можно оплатить бонусными баллами.
        - `conditions` object — Условия для автоматического назначения статуса.
          - `totalCashSpent` object, nullable — Повысить статус, когда сумма покупок достигнет данного значения.
            - `target` number — Сумма покупок.
          - `effectiveInvitedCount` object, nullable — Повысить уровень, когда клиент достигнет значения `effectiveInvitedCount`.
            - `target` integer — Количество эффективных рекомендаций.
      - `dateCreated` string, date-time, nullable — Дата, когда клиент присоединился к компании
      - `lastTransactionTime` string, date-time, nullable — Дата и время, когда клиент совершил последнюю транзакцию.
      - `pointsExpireIn` string, date-time, nullable — Срок действия бонусов клиента.
    - `channelName` string, nullable — Источник трафика.
    - `email` string, nullable — Email клиента.
    - `tags` TagModel[] — Список тегов клиента.
      - `id` integer — Идентификатор тега.
      - `name` string — Наименование тега.
  - `code` string, nullable — Новый долгоживущий код на оплату, если был запрошен параметр `exchangeCode`.
  - `type` 'PURCHASE' | 'BONUS_ITEMS_PURCHASE' | 'GOODS_ORDER_COMPLETE' | 'CERTIFICATE' — Тип действия, связанного с кодом на оплату: * `PURCHASE` — стандартная операция покупки * `BONUS_ITEMS_PURCHASE` — покупка с бонусными товарами * `GOODS_ORDER_COMPLETE` — завершение заказа товаров * `CERTIFICATE` — погашение сертификата
  - `purchase` PurchaseCalc — Результат расчёта программы лояльности для покупки. Показывает суммы скидок, стоимость баллов, итоговую сумму к оплате и ожидаемый кешбэк.
    - `maxPoints` number — Максимальное количество бонусных баллов, доступных для списания с учётом баланса и лимитов уровня.
    - `total` number — Общая сумма счета (в денежных единицах).
    - `skipLoyaltyTotal` number — Часть суммы счета, на которую не начисляется кешбэк и на которую не распространяется скидка (в денежных единицах).
    - `unredeemableTotal` number — Часть суммы счета, которую нельзя погасить баллами.
    - `discountAmount` number — Размер скидки (в денежных единицах).
    - `discountPercent` number — Предоставленная скидка (в процентах).
    - `points` number — Бонусных баллов к оплате.
    - `pointsPercent` number — Размер скидки за счет бонусных баллов (в процентах).
    - `netDiscount` number — Общий размер скидки (в денежных единицах).
    - `netDiscountPercent` number — Общий размер скидки (в процентах от общей суммы счета).
    - `certificatePoints` number — Количество списанных баллов сертификата (отдельно от обычных бонусных баллов).
    - `cash` number — Итоговая сумма к оплате после всех скидок и списания баллов. Используйте это значение в POST /operations.
    - `cashTotal` number — Итоговая сумма к оплате с учетом доставки.
    - `cashBack` number — Бонусные баллы, которые клиент получит за эту покупку. Начисляются после завершения операции.
    - `extras` object — Дополнительный платежи, на которые не распространяется программа лояльности.
      - `delivery` number — Стоимость доставки.
    - `maxScoresDiscount` number — Процент счета, который можно оплатить бонусными баллами.

## Other responses

- `404` — Объект не найден.

---

[API](https://skmtc.dev/uds/apis/uds-api-2.md) · [All operations](https://skmtc.dev/uds/apis/uds-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uds/uds-api-2/revisions/f4f284d76ad0/schema)