Skip to main content
GET
Listar clientes que usaram o cupom

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do cupom

Response

Lista de clientes que usaram o cupom

Representa os clientes que usaram um cupom

id
integer

Identificador único do cliente.

merchant_id
integer

ID da loja à qual o cliente pertence.

marketplace_id
integer

ID do marketplace de origem do cliente, quando o cadastro vem de um marketplace.

active
boolean

Indica se o cliente está ativo.

type
string

Tipo de pessoa do cliente: f para pessoa física, j para pessoa jurídica.

cluster_id
integer

ID do cluster (grupo de clientes) ao qual o cliente está vinculado, quando houver.

name
string

Nome do cliente.

first_name
string

Primeiro nome do cliente, derivado de name.

last_name
string

Sobrenome do cliente, derivado de name.

generic_name
string

Nome de exibição do cliente: o name para pessoa física e a razao_social para pessoa jurídica.

cpf
string

CPF do cliente, para pessoa física.

spreadsheet
object

Dados do cliente desnormalizados para exportação em planilha, retornados sob demanda via include.

phone
object

Dados de telefone do cliente.

razao_social
string

Razão social do cliente, para pessoa jurídica.

cnpj
string

CNPJ do cliente, para pessoa jurídica.

state_registration
string

Inscrição estadual do cliente, para pessoa jurídica.

email
string<email>

E-mail do cliente.

birthday
string<date>

Data de nascimento do cliente.

newsletter
boolean

Indica se o cliente aceitou receber a newsletter da loja.

whatsapp
boolean

Indica se o cliente aceitou receber mensagens no WhatsApp.

social_driver
string

Provedor de login social usado no cadastro do cliente (ex.: Google, Facebook), quando aplicável.

social_id
integer

Identificador do cliente no provedor de login social, quando o cadastro veio de login social.

ip
string
read-only

Endereço IP do cliente no momento do cadastro.

token
string

Token único do cliente, usado para autenticá-lo em ações como login automático.

utm_source
string

Origem da campanha de marketing (parâmetro UTM utm_source) que originou o cadastro do cliente.

utm_campaign
string

Nome da campanha de marketing (parâmetro UTM utm_campaign) que originou o cadastro do cliente.

notes
string

Observações internas sobre o cliente.

login_url
string<uri>

URL de login automático do cliente na loja, gerada a partir do seu token.

anonymized
boolean

Indica se os dados do cliente foram anonimizados por solicitação de exclusão (LGPD).

deletion_request
object

Solicitação de exclusão de dados do cliente (LGPD), quando houver.

addresses
object

Endereços cadastrados pelo cliente.

created_at
object
updated_at
object