v1

latestOpenAPI 3.0.12026-08-046010593.8 KB
Clientes

Listar clientes

Listar todos os clientes do estabelecimento.

get/v1/clientes

Query parameters

pageinteger

Numeração da página

pageSizeinteger

Quantidade de registros por página

nomestring

Nome do cliente

cpfstring

CPF do cliente (Ex: 99999999999)

emailstring

E-mail do cliente

telefonestring

Telefone do cliente (Ex: 21999999999 ou com DDI 5521999999999. (Telefones internacionais aceitos também))

dataCadastroIniciostring date-time

Data de cadastro inicial (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

dataCadastroFimstring date-time

Data de cadastro final (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

dataAlteracaoCadastralIniciostring date-time

Data de alteração cadastral inicial (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

dataAlteracaoCadastralFimstring date-time

Data de alteração cadastral final (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

incluirDetalhesboolean

Inclui detalhes do cliente nos resultados apresentados

Headers

estabelecimentoIdstring required

Response

Success

pageinteger
pageSizeinteger
totalPagesinteger
totalRecordsinteger