Sign in
Customers

Find customer by code, phone, or UID

Find a customer by promo code (code), phone number (phone), or UDS identifier (uid). This is the primary endpoint for identifying customers during checkout.

Promo code — generated by the customer in the UDS mobile app (QR code). Short-lived and single-use. Allows point redemption during the transaction.

Phone number — for automated systems. Points cannot be redeemed when identifying by phone (unless purchaseByPhone is enabled in settings).

UID — permanent UDS customer identifier for returning customers.

The response includes the customer's loyalty calculation (purchase field) which shows available discounts and max redeemable points for the current transaction.

get/customers/find

Query parameters

codestring

Promo code

phonestring

Phone number in E164 format, URL-encoded. For example, +79123456789 should be passed as %2b79123456789.

uidstring

Customer's uid

exchangeCodeboolean

If specified, the response will include a new long-lived payment code in the code field. The old promo code will be deactivated.

totalnumber

Total receipt amount (in currency units).

skipLoyaltyTotalnumber

A part of the bill amount for which cashback is not credited and to which the discount does not apply (in currency units).

unredeemableTotalnumber

A part of total that cannot be redeemed with points

Response

Customer found by the given search criteria.

codestring nullable

New long life purchase promo code if exchangeCode queried

type'PURCHASE' | 'BONUS_ITEMS_PURCHASE' | 'GOODS_ORDER_COMPLETE' | 'CERTIFICATE'

Type of action associated with a customer's purchase token:

  • PURCHASE — standard purchase operation
  • BONUS_ITEMS_PURCHASE — purchase using bonus items
  • GOODS_ORDER_COMPLETE — completing a goods order
  • CERTIFICATE — certificate redemption

Example response

{
  "user": {
    "tags": [
      {
        "id": 1
      }
    ]
  }
}

Changes