API ViaShopModa documentação

cliente/cadastrar

Cadastrar cliente

Cria um cliente pessoa física, jurídica ou do exterior; se o CPF/CNPJ ou e-mail já existir, devolve o cliente existente (HTTP 409).

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

O que faz #

Cadastra um cliente na loja. Antes, procura duplicidade por CPF/CNPJ ou e-mail: se encontrar, não cadastra e devolve o cod_cliente existente.

Requisição #

MétodoPOST
URLhttps://api.viashopmoda.com.br/via/cliente/cadastrar/{TOKEN}
CorpoObjeto JSON { ... }, cabeçalho Content-Type: application/json
TokenSubstitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho.

Campos #

CampoTipoObrigatórioLimitesDescrição
tipo_pessoastringsimmáx. 1'F' = pessoa física: , 'J' = pessoa jurídica e 'E' = cliente do exterior.
emailstringsimmín. 5, máx. 150Usado como contato e para acessar a loja virtual.
senhastringsimmín. 4Senha para acessar a loja virtual.
tipo_clientestringsimmáx. 100Sempre se 'tipo_pessoa'=F será 'Revendedor' e 'tipo_pessoa'=J será 'Lojista'. Somente será alterado se enviado como 'Consignado' e o 'compra_maxima_atacado' passa a ser necessário o envio.
cpfnumericsimmín. 11, máx. 11Somente números. Obrigatório quando pessoa física.
nome_completostringsimmáx. 150Nome completo do cliente. Obrigatório quando pessoa física.
rgstringnãomáx. 25Caso inexistente enviar 'Isento'. Obrigatório quando pessoa física.
data_nascimentodatesimmáx. 10Formato 'aaaa-mm-dd'. Obrigatório quando pessoa física.
sexostringsim'Masculino', 'Feminino' ou 'Nenhum'. Obrigatório quando pessoa física.
cnpjstringsimmín. 14, máx. 14Somente números. Obrigatório quando pessoa jurísica.
nome_empresastringsimmáx. 150Nome fantasia da empresa. Obrigatório quando pessoa jurídica.
responsavel_empresastringsimmáx. 150Nome do responsável pela empresa. Obrigatório quando pessoa jurídica.
iestringsimmáx. 25Caso inexistente enviar 'Isento'. Obrigatório quando pessoa jurídica.
moedastringnãomáx. 3Para os clientes do exterior, é possível alterar sua moeda enviando o código no padrão ISO 4217. USD para dolar, EUR para euro e etc.
condicao_diferenciadadoublenãomáx. 11Representa a porcentagem de acréscimo ou desconto nos preços dos produtos.
compra_minima_atacadodoublenãomáx. 11Valor minimo para compra de atacado.
compra_maxima_atacadodoublenãomáx. 11Usado para quando tipo_cliente=Consignado, limitando o valor máximo a ser comprado. Se não enviado será zero.
cepnumericsimmín. 8, máx. 8Somente números no formato '37001000'.
enderecostringsimmáx. 150Caso cliente do exterior, será usado como endereço completo.
numerostringsimmáx. 10Não utilizado para clientes do exterior.
complementostringnãomáx. 50Não utilizado para clientes do exterior.
bairrostringsimmáx. 50Não utilizado para clientes do exterior.
cidadestringsimmáx. 50
estadostringsimmáx. 2Sigla do estado com dois caracteres. Não utilizado para clientes do exterior.
paisstringnãomáx. 50Para países diferente de 'Brasil' usar o campo cod_pais.
cod_paisstringnãomáx. 2Código do país no padrão ISO-2, se não enviado será utilizado 'BR'.
codigo_ddistringnãomín. 1, aceita nullSe não enviado sempre será 55.
telefone_celularstringsimmáx. 50Se não enviado no formato: '+{CODIGO_DDI}{NUMERO_TELEFONE}' será acrescentado o DDI (relativo ao cod_pais) ao número enviado.
operadora_celularstringnãomáx. 20Nome da operadora de telefonia. Se não enviado será cadastrado 'Outras'
utm_sourcestringnãomáx. 70Se enviado é necessário enviar utm_medium e utm_campaign
utm_mediumstringnãomáx. 70Se enviado é necessário enviar utm_source e utm_campaign
utm_campaignstringnãomáx. 70Se enviado é necessário enviar utm_source e utm_medium
crmarraynãoFrases relacionadas ao CRM do cliente
assinar_newsletterstringnãomáx. 1'S' ou 'N', se não enviado será cadastrado 'N'.
data_cadastrodatetimenãomáx. 19Data de cadastro do cliente. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss'.
liberado_para_comprarstringnãomáx. 1Padrão 'N'. Podendo ser 'S' ou 'N'. Onde 'S' está liberado e 'N' NÃO está liberado. Observações: (1) O 'N' não signifca bloqueio algum, mas a não possibilidade de login. (2) Se não enviado será cadastrado como 'N'. (3) Se enviado como 'S' poderá ser alterado caso a cidade ou o estado enviado for considerado uma região exclusiva.
vendedorobjectnãoObjeto para consulta do vendedor. Poderá ser usado: vendedor.id, vendedor.email ou vendedor.whatsapp para localizar o vendedor a ser atrelado ao cliente. Para consultar o vendedor vendedores/consultar. Se enviar 'sortear' será sorteado entre os vendedores habilitados. Se não existir, cadastro não será vinculado a nenhum vendedor.

Regras (valem acima da tabela) #

Obrigatórios conforme tipo_pessoa:

tipo_pessoaExigeDispensatipo_cliente padrão
F (física)cpf, nome_completo, data_nascimento, sexo (rg pode ser "Isento")dados da empresaRevendedor
J (jurídica)cnpj, nome_empresa, responsavel_empresa (ie pode ser "Isento")dados pessoaisLojista
E (exterior)—CPF, CNPJ, RG, CEP, número, complemento, bairro, estadoLojista

Sempre obrigatórios: tipo_pessoa, email, senha, endereco, cidade, telefone_celular. Para F e J, também cep, numero, bairro e estado. tipo_cliente pode ser omitido (a loja usa o padrão da tabela acima).

  • tipo_cliente: "Consignado" exige compra_maxima_atacado.
  • liberado_para_comprar: "S" libera o login. Qualquer outro valor (ou ausente) deixa aguardando liberação da loja. Em cidade/estado com cliente exclusivo, o S vira "aguardando" com aviso em msg_alerta.
  • vendedor: objeto com um de id, email ou whatsapp de um vendedor (vendedores/consultar), ou o texto "sortear" (rodízio entre os vendedores habilitados). Não encontrado → cliente sem vendedor, com aviso.
  • UTM só é gravado se vierem os três: utm_source, utm_medium, utm_campaign.
  • Telefone de cliente do exterior: com o código do país, ex.: +11234567890.
  • Nome gravado em MAIÚSCULAS.

Exemplo #

{
  "tipo_pessoa": "F",
  "nome_completo": "Maria José da Silva",
  "cpf": "12345678909",
  "data_nascimento": "1986-02-15",
  "sexo": "Feminino",
  "rg": "Isento",
  "email": "maria@exemplo.com.br",
  "senha": "troque123",
  "cep": "37002000",
  "endereco": "Avenida Imigrantes",
  "numero": "10",
  "bairro": "Centro",
  "cidade": "Varginha",
  "estado": "MG",
  "telefone_celular": "35988887777",
  "liberado_para_comprar": "S",
  "vendedor": { "email": "vendedora@loja.com.br" }
}

Respostas #

Cadastrado (HTTP 200):

{ "retorno": true, "cadastro": true, "msg": "...", "cod_cliente": "MTIz", "cod_vendedor": "Mg" }

Já existia (HTTP 409 — não é falha):

{ "retorno": true, "status": 409, "cadastro": false, "cod_cliente": "MTIz", "cod_vendedor": "Mg" }

cod_cliente e cod_vendedor são textos codificados: guarde e use como recebidos.

Erros de validação vêm em msg_erro com o nome do campo (ex.: tamanho, formato).

Pode reenviar? #

Sim: o reenvio devolve 409 com o mesmo cod_cliente. Os dados enviados no reenvio não atualizam o cadastro — use cliente/atualizar.

Onde entra no processo #

Guia Clientes.