Buscar cliente - Cardápio Web API

{ "id": 123, "name": "<string>", "email": "jsmith@example.com", "phone_number": "<string>", "ddi": "<string>", "birth_date": "2023-12-25", "created_at": "2023-11-07T05:31:56Z", "loyalty_points": 123, "loyalty_points_expires_at": "2023-12-25", "cashback_balance": 123, "cashback_expires_at": "2023-12-25", "notifications_enabled": true }

Autorizações

X-API-KEY

string

header

obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Parâmetros de caminho

customer_id

string

obrigatório

ID do cliente que será buscado

Resposta

Informações do cliente retornadas com sucesso!

Estrutura do cliente

integer

Identificador único do cliente

name

string

Nome do cliente

string<email> | null

E-mail

phone_number

string | null

Número de telefone

ddi

string | null

Código do país do número de telefone

birth_date

string<date> | null

Data de nascimento

gender

enum<string>

Gênero

Opções disponíveis:

female,

male,

non-binary,

other

created_at

string<date-time>

Data de criação

loyalty_points

integer

Total de pontos de fidelidade

loyalty_points_expires_at

string<date> | null

Data de expiração do saldo de pontos de fidelidade

cashback_balance

number

Saldo de cashback

cashback_expires_at

string<date> | null

Data de expiração do saldo de cashback

notifications_enabled

boolean

padrão:true

Indica se o envio de mensagens via WhatsApp para o cliente está liberado