Histórico da Página
...
Todas as atualizações feitas no PDV Omni são automaticamente integradas ao ERP, garantindo que o cadastro de clientes esteja sempre atualizado e disponível em toda a operação da empresa.
| Deck of Cardsinfo | |||
|---|---|---|---|
| |||
Quando o Fidelidade está desabilitado, o PDV permite que seja cadastrado mais de um endereço para o mesmo cliente. O endereço informado em tela para ser o "endereço padrão" do cliente será gravado na tabela cliente, porém os demais endereços informados será gravado na cliente_endereco Consulte todos os detalhes do cliente_endereco |
Índice
...
1. Método para integração
Este método é responsável pela criação de novos Clientes
- Endpoint:
- /api/retaguarda/v2/clientes
- /api/retaguarda/v3/clientes
- /api/retaguarda/v3/dadosdinamicos/down/0/{Versão Dado}
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Clientes para que possam ser enviados vários na mesma requisição
| Aviso |
|---|
Para que a baixa do Cliente criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 0 = Cliente |
2. Exemplo de requisição
Versão 3.1(V2)
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"atividade": "string",
"avatarUrl": "string",
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"cpfCnpj": "string",
"cracha": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"email": "string",
"endereco": "string",
"estado": "string",
"estadoCivil": 0,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"numero": "string",
"pessoaFisica": 0,
"rgInscricao": "string",
"sexo": 0,
"situacao": 0,
"telefone": "string",
"IdRetaguardaProfissional": "string",
"IdRetaguardaRamoAtividade": "string",
"IdRetaguardaRedeCliente": "string",
"IdRetaguardaClientePrincipal": "string",
"IdRetaguardaPraca": "string",
"IdRetaguardaRegiao": "string",
"UtilizaPrecoAtacado": false
}
] |
Versão 3.2
| Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"atividade": "string",
"avatarUrl": "string",
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"cpfCnpj": "string",
"cracha": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"email": "string",
"endereco": "string",
"estado": "string",
"estadoCivil": 0,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"numero": "string",
"pessoaFisica": 0,
"rgInscricao": "string",
"sexo": 0,
"situacao": 0,
"telefone": "string",
"IdRetaguardaProfissional": "string",
"IdRetaguardaRamoAtividade": "string",
"IdRetaguardaRedeCliente": "string",
"IdRetaguardaClientePrincipal": "string",
"IdRetaguardaPraca": "string",
"IdRetaguardaRegiao": "string",
"UtilizaPrecoAtacado": false
}
] |
...
3. Descrição de campos e regras
| Card | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Card | | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Informação | Coluna | Obrigatório | Tipo | Tamanho | Descrição | ||||||||||||||||||||
| Nome do cliente | nome | Sim | Texto | 250 | Nome completo do cliente | Identificação no retaguarda | id_retaguarda | Não | Texto | 100 | |||||||||||||||
| Endereço do cliente | endereco | Não | Texto | 150 | Endereço do cliente. Corresponde ao campo de logradouro. Na tabela cliente ficará a informação do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. | Descrição | descricao | Não | Texto | 100 | |||||||||||||||
| Número da residência do endereço | numero | Não | Texto | 15 | Número da residência do endereço do cliente. Corresponde ao campo número na tela de cadastro. Na tabela cliente ficará a informação do número do endereço padrão do cliente. | ||||||||||||||||||||
| Complemento do endereço | complemento | Não | Texto | 50 | Completo do endereço do cliente. Corresponde ao campo complemento. Na tabela cliente ficará a informação do complemento do endereço padrão do cliente. | ||||||||||||||||||||
| Bairro do endereço | bairro | Não | Texto | 100 | Bairro do endereço do cliente. Corresponde ao campo bairro na tela de cadastro. Na tabela cliente ficará a informação do bairro do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. | ||||||||||||||||||||
| Cidade do endereço | cidade | Não | Texto | 100 | Cidade do endereço do cliente. Corresponde ao campo cidade na tela de cadastro. Na tabela cliente ficará a informação do cidade do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. | ||||||||||||||||||||
| UF do endereço | estado | Não | Texto | 30 | Estado do endereço do cliente, somente a sigla. Corresponde ao campo estado na tela de cadastro. Na tabela cliente ficará a informação do estado do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. | CEP do endereço | cep | Não | Texto | 10 | CEP do endereço do cliente. Corresponde ao campo CEP na tela de cadastro
. Na tabela cliente ficará a informação do |
endereço padrão do cliente. |
Telefone do cliente. Corresponde ao campo telefone na tela de cadastro.
O campo possui a máscara de DDD + telefone (XX) XXXX-XXXX. O campo não aceita números com 9 dígitos (como celular) nem telefones iniciados com o digito 9.
Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. | |||||
| Descrição | descricao | Não | Texto | 100 | |
| Número da residência do endereço | numero |
| Não | Texto |
| 15 | Número da residência do endereço |
do cliente. Corresponde ao campo |
número na tela de cadastro. |
O campo possui a máscara de DDD + celular (XX) XXXXX-XXXX. O campo não aceita números com 8 dígitos (como telefone residencial).
Na tabela cliente ficará a informação do número do endereço padrão do cliente. | |
| Complemento do endereço | complemento |
| Não | Texto |
| 50 | Completo do endereço do cliente. Corresponde ao campo complemento. Na tabela cliente ficará a informação do complemento do endereço padrão do cliente. | ||||
| Bairro do endereço | bairro | Não | Texto | 100 | Bairro do endereço do cliente. Corresponde ao campo bairro na tela de cadastro. Na tabela cliente ficará a informação do bairro do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. |
| Cidade do endereço | cidade | Não | Texto | 100 | Cidade do endereço do cliente. Corresponde ao campo cidade na tela de cadastro. Na tabela cliente ficará a informação do cidade do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. |
| UF do endereço | estado | Não | Texto | 30 | Estado do endereço do cliente, somente a sigla. Corresponde ao campo estado na tela de cadastro. Na tabela cliente ficará a informação do estado do endereço padrão do cliente. Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP. |
| CEP do endereço | cep | Não | Texto | 10 | CEP do endereço do cliente. Corresponde ao campo CEP na tela de cadastro. Na tabela cliente ficará a informação do CEP do endereço padrão do cliente. |
| Telefone residencial | telefone | Não | Texto | 20 | Telefone do cliente. Corresponde ao campo telefone na tela de cadastro. O campo possui a máscara de DDD + telefone (XX) XXXX-XXXX. O campo não aceita números com 9 dígitos (como celular) nem telefones iniciados com o digito 9. |
| Telefone celular | celular | Não | Texto | 20 | Telefone celular do cliente. Corresponde ao campo celular na tela de cadastro. O campo possui a máscara de DDD + celular (XX) XXXXX-XXXX. O campo não aceita números com 8 dígitos (como telefone residencial). |
| Não | Texto | 80 | E-mail de contato do cliente. Corresponde ao campo e-mail na tela de cadastro. O campo possui validação se o valor digitado é válido (possua o servidor de e-mail @xpto.com.br) | ||
| Data de nascimento | data_nascimento | Não | Data | Exemplo "1991-03-20 00:00:00.00000". Corresponde a data de nascimento do cliente. | |
| Situação | situacao | Sim | Inteiro | Define se o cliente em questão está ativo ou inativo.
| |
| Data de cadastro | data_cadastro | Sim | Data | Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente. | |
| Data de atualização | data_atualizacao | Sim | Data | Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente. | |
| Identificação de pessoa física ou jurídica | pessoa_fisica | Sim | Inteiro | Campo preenchido automaticamente dependendo do dado CPF/CNPJ. Caso o campo seja preenchido com um CPF, o campo pessoa_fisica será igual a 1. Caso o campo seja preenchido com um CNPJ, o campo pessoa_fisica será igual a 0. Esse campo é utilizado posteriormente para tratar a máscara do dado de CPF/CNPJ nas telas de identificação de consumidor. | |
| CPF ou CNPJ do cliente cadastrado | cpf_cnpj | Não | Texto | 25 | |
| RG do cliente cadastrado | rg_inscricao | Não | Texto | 25 | |
| Sexo do cliente | sexo | Não | Inteiro | Sexo
| |
| Estado civil do cliente | estado_civil | Não | Inteiro | Estado civil
| |
| Avatar do cliente | avatar_url | Não | Texto | 300 | Defasado |
| Enviar para o retaguarda/ERP | enviarpnet | Não | Inteiro | Campo de controle se o cliente já foi integrado com o retaguarda/ERP.
Quando cadastrado um novo cliente e o Fidelidade estiver habilitado, esse campo será sempre gravado como 0. Pois com o Fidelidade ativo, não há integração do cliente. Quando o fidelidade estiver desabilitado, esse campo será gravado como 1 para que quando executado a rotina de integração de cliente ele seja retornado. | |
| Atividade/Convenio | atividade | Não | Texto | 500 | Campo utilizado para verificar se o cliente possui promoções ativas para o mesmo no Motor TOTVS. Esse campo é preenchido na tela do Live, no cadastro do cliente, na aba de classificação. Quando há no Motor TOTVS uma promoção vinculada ao convênio do cliente a promoção será aplicada. |
| Crachá | cracha | Não | Texto | 20 | Defasado |
| Vinculo com a carta de consentimento | id_termo_consentimento | Não | Texto | 100 | ID retaguarda da tabela termo_consentimento, para vincular qual a carta aceitada pelo cliente |
| Data de aceite do termo de consentimento | data_aceite_termo_consentimento | Não | Data | Data em que o cliente aceitou/concordou com o termo de consentimento | |
| Tipo de endereço | tipo_endereco | Não | Numérico | Tipo endereço
| |
| Id profissional | id_profissional | Não | Texto | 100 | Id Profissional vinculado ao cliente |
| Id ramo atividade | id_ramo_atividade | Não | Numerico | Id Ramo Atividade vinculado a tabela ramo_atividade | |
| Id retaguarda rede cliente | id_retaguarda_rede_cliente | Não | Texto | 100 | Id Retaguarda da rede do cliente |
| Id cliente principal | id_cliente_principal | Não | Numerico | Id do cliente principal, caso seja o principal será nulo. | |
| Id retaguarda praca | id_retaguarda_praca | Não | Texto | 100 | Id Retaguarda praça do cliente |
| Id regiao | id_regiao | Não | Numerico | Id regiao vinculado a tabela regiao | |
| Utlizada preco atacado | utiliza_preco_atacado | Não | Boleano | Falso ou Verdadeiro |
| Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Cliente_Endereco
| Informações | ||
|---|---|---|
| ||
Quando o Fidelidade está desabilitado, o PDV permite que seja cadastrado mais de um endereço para o mesmo cliente. O endereço informado em tela para ser o "endereço padrão" do cliente será gravado na tabela cliente, porém os demais endereços informados será gravado na cliente_endereco |
...
Informação
...
Coluna
...
Obrigatório
...
Tipo
...
Tamanho
...
Descrição
...
Endereço do cliente. Corresponde ao campo de logradouro.
Na tabela cliente ficará a informação do endereço padrão do cliente.
Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP.
...
Número da residência do endereço do cliente. Corresponde ao campo número na tela de cadastro.
Na tabela cliente ficará a informação do número do endereço padrão do cliente.
...
Completo do endereço do cliente. Corresponde ao campo complemento.
Na tabela cliente ficará a informação do complemento do endereço padrão do cliente.
...
Bairro do endereço do cliente. Corresponde ao campo bairro na tela de cadastro.
Na tabela cliente ficará a informação do bairro do endereço padrão do cliente.
Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP.
...
Cidade do endereço do cliente. Corresponde ao campo cidade na tela de cadastro.
Na tabela cliente ficará a informação do cidade do endereço padrão do cliente.
Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP.
...
Estado do endereço do cliente, somente a sigla. Corresponde ao campo estado na tela de cadastro.
Na tabela cliente ficará a informação do estado do endereço padrão do cliente.
Em tela, normalmente, esse campo fica indisponível para alteração após a consulta automática do CEP.
...
CEP do endereço do cliente. Corresponde ao campo CEP na tela de cadastro.
Na tabela cliente ficará a informação do CEP do endereço padrão do cliente.
...
Define se o endereço em questão está ativo ou inativo.
- 0 - Inativo
- 1 - Ativo
...
|
...
Valor 0.
...
Tipo endereço
- 0 - Entrega
- 1 - Comercial
- 2 - Cobrança
| Nota | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas