Referência da API
- Introdução
- Autenticação
- Catálogo
- Checkout
- Configurações
- Conteúdo
- Clientes
- Cliente
- Clusters
- Regras de frete dos clusters
- Endereços
- Leads
- Logística
- Marketing
- Pedidos
- Sistema
- Promoções
- Filas
- Usuários
- Webhooks
- Loja Virtual
Cliente
Listar clientes
Lista todos os clientes
GET
/
{alias}
/
customers
curl --request GET \
--url https://api.dooki.com.br/v2/{alias}/customers \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>'
{
"data": [
{
"id": 123,
"merchant_id": 123,
"marketplace_id": 123,
"active": true,
"type": "<string>",
"cluster_id": 123,
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"generic_name": "<string>",
"cpf": "<string>",
"spreadsheet": {
"data": {
"brands": "<string>",
"city": "<string>",
"purchased_brands": "<string>",
"last_order_date": {
"date": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"timezone_type": 123
},
"last_order_value": "<string>",
"purchased_categories": "<string>",
"number": "<string>",
"uf": "<string>",
"phone": "(16) 98187-5668",
"street": "<string>",
"phone_number": "981875668",
"categories": "<string>",
"neighborhood": "<string>",
"complement": "<string>",
"phone_code": "16"
}
},
"phone": {
"area_code": "<string>",
"full_number": "<string>",
"number": "<string>",
"formated_number": "<string>",
"whatsapp_link": "<string>"
},
"razao_social": "<string>",
"cnpj": "<string>",
"state_registration": "<string>",
"email": "jsmith@example.com",
"birthday": "2023-12-25",
"newsletter": true,
"whatsapp": true,
"social_driver": "<string>",
"social_id": 123,
"ip": "<string>",
"token": "<string>",
"utm_source": "<string>",
"utm_campaign": "<string>",
"notes": "<string>",
"login_url": "<string>",
"anonymized": true
}
],
"meta": {
"pagination": {
"total": "10",
"count": "30",
"per_page": "10",
"current_page": "1",
"total_pages": "3",
"links": {
"previous": "",
"next": ""
}
}
}
}
Path Parameters
Alias da loja
Query Parameters
Incluir dados adicionais relacionados ao cliente (addresses, stats, clusters)
Response
200
application/json
Lista de clientes retornada com sucesso
Representa uma paginação com meta
Was this page helpful?
curl --request GET \
--url https://api.dooki.com.br/v2/{alias}/customers \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>'
{
"data": [
{
"id": 123,
"merchant_id": 123,
"marketplace_id": 123,
"active": true,
"type": "<string>",
"cluster_id": 123,
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"generic_name": "<string>",
"cpf": "<string>",
"spreadsheet": {
"data": {
"brands": "<string>",
"city": "<string>",
"purchased_brands": "<string>",
"last_order_date": {
"date": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"timezone_type": 123
},
"last_order_value": "<string>",
"purchased_categories": "<string>",
"number": "<string>",
"uf": "<string>",
"phone": "(16) 98187-5668",
"street": "<string>",
"phone_number": "981875668",
"categories": "<string>",
"neighborhood": "<string>",
"complement": "<string>",
"phone_code": "16"
}
},
"phone": {
"area_code": "<string>",
"full_number": "<string>",
"number": "<string>",
"formated_number": "<string>",
"whatsapp_link": "<string>"
},
"razao_social": "<string>",
"cnpj": "<string>",
"state_registration": "<string>",
"email": "jsmith@example.com",
"birthday": "2023-12-25",
"newsletter": true,
"whatsapp": true,
"social_driver": "<string>",
"social_id": 123,
"ip": "<string>",
"token": "<string>",
"utm_source": "<string>",
"utm_campaign": "<string>",
"notes": "<string>",
"login_url": "<string>",
"anonymized": true
}
],
"meta": {
"pagination": {
"total": "10",
"count": "30",
"per_page": "10",
"current_page": "1",
"total_pages": "3",
"links": {
"previous": "",
"next": ""
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.