v1
latestOpenAPI 3.1.02026-07-2622098.6 KBListar Clientes com detalhes e Canais de venda
get/api/v2/clients
Path parameters
searchstring required
cpf_cnpjstring required
client_idinteger required
citystring required
statestring required
emailstring required
channelstring required
per_pageinteger required
pageinteger required
Response
200
Example response
{
"per_page": 10,
"total": 100,
"data": [
{
"id": 1,
"name": "Cliente Exemplo",
"fantasy_name": "Fantasia Exemplo",
"email": "cliente@exemplo.com",
"financial_email": "financeiro@exemplo.com",
"phone": "11999999999",
"identification_type": "CPF",
"cpf_cnpj": "12345678900",
"address": "Rua Exemplo, 123",
"number": "123",
"neighborhood": "Bairro Exemplo",
"city": "Cidade Exemplo",
"state": "EX",
"zip_code": "12345678",
"reference": "Próximo ao mercado",
"complement": "Apto 101",
"contact_name": "Contato Exemplo",
"phones": [
"11999999999"
],
"latitude": "-23.550520",
"longitude": "-46.633308",
"created_at": "2023-08-01T00:00:00.000000Z",
"updated_at": "2023-08-01T00:00:00.000000Z",
"accounts": [
{
"account_id": 1,
"external_seller_id": "EX123",
"channel": "Marketplace Exemplo",
"name": "Canal Exemplo",
"account_name": "Conta Exemplo",
"seller_id": 1,
"document": "12345678900",
"address": "Rua Exemplo, 123",
"number": "123",
"neighborhood": "Bairro Exemplo",
"city": "Cidade Exemplo",
"state": "EX",
"zip_code": "12345678",
"reference": "Próximo ao mercado",
"complement": "Apto 101",
"latitude": "-23.550520",
"longitude": "-46.633308",
"phones": [
"11999999999"
],
"cutoff_time_week": "18:00",
"cutoff_time_saturday": "12:00",
"cutoff_time_sunday": "12:00",
"email": "contato@exemplo.com",
"last_sync_at": "2023-08-01T00:00:00.000000Z",
"created_at": "2023-08-01T00:00:00.000000Z",
"updated_at": "2023-08-01T00:00:00.000000Z"
}
]
}
]
}