API ViaShopModa documentação

cliente/consultar

Consultar clientes

Busca um cliente por CPF, CNPJ, e-mail ou código, ou lista os cadastrados num período.

Ver como Markdown Baixar coleção Postman Atualizado em 18/11/2026

O que faz #

Devolve um cliente (filtro por documento, e-mail ou código) ou uma lista paginada (período de cadastro). É obrigatório informar algum filtro.

Requisição #

MétodoGET
URLhttps://api.viashopmoda.com.br/via/cliente/consultar/{TOKEN}
CorpoNenhum. Filtros vão na query string (?campo=valor&...).
TokenSubstitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho.

Parâmetros #

Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar.

ParâmetroDescrição
cpfCPF, só números (11 dígitos).
cnpjCNPJ, só números (14 dígitos).
emailE-mail do cliente.
cod_clienteCódigo do cliente devolvido pela API (texto codificado, ex.: "MTIz").
data_inicialInício do período de cadastro (aaaa-mm-dd). Usar com data_final.
data_finalFim do período de cadastro (aaaa-mm-dd).
paginaPágina (20 registros por página). Ex.: pagina=2

Exemplo #

curl "https://api.viashopmoda.com.br/via/cliente/consultar/SEU_TOKEN?email=maria@exemplo.com.br"
{
  "retorno": true,
  "cliente": {
    "cod_cliente": "MTIz",
    "tipo_pessoa": "F",
    "nome_completo": "MARIA JOSÉ DA SILVA",
    "cpf": "12345678909",
    "email": "maria@exemplo.com.br",
    "cidade": "Varginha",
    "estado": "MG",
    "tipo_cliente": "Revendedor",
    "data_cadastro": "2026-11-16 09:27:11",
    "liberado_para_comprar": "S",
    "utm": "google -> cpc -> inverno",
    "lgpd_aceite": "S",
    "vendedor": { "nome": "Ana", "email": "vendedora@loja.com.br" },
    "etiquetas": [ ... ]
  }
}

(Exemplo resumido; a resposta traz também telefones, endereço completo, condições comerciais e dados de LGPD.)

Com período: {"retorno": true, "cabecalho": {"paginacao": {...}}, "clientes": [ ... ]}. Não encontrado: retorno: false.

Pode reenviar? #

Sim (somente leitura).