| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Dores e necessidade | Efetuar a consulta online de cadastro de cliente na retaguarda |
Negócio | No PDV e Pedido deve ser possível, após informar o CPF/CNPJ do cliente, efetuar consulta na retaguarda para valdiar se o cliente já existe cadastrado |
Entrega de valor | A consulta será efetuada de forma online otimizando o processo de integração de clientes entre retaguarda e PDV Omni |
...
Definição de contratos de API:
Consulta online cliente:ProcessoOnlineConsultaCliente
Request:
Response:
{
"success": true,
"message": "",
"data": {
...
Campo | Tipo | Descrição | Obrigatório | Observações | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nome | String | Nome do cliente | Sim | Tamanho máximo: 250 caracteres | ||||||||||||||||
| endereco | String | Endereço principal do cliente | Não | Tamanho máximo: 150 caracteres | ||||||||||||||||
| numero | String | Número do endereço principal do cliente | Não | Tamanho máximo: 15 caracteres | ||||||||||||||||
| complemento | String | Complemente do endereço principal do cliente | Não | Tamanho máximo: 50 caracteres | ||||||||||||||||
| bairro | String | Bairro principal do cliente | Não | Tamanho máximo: 100 caracteres | ||||||||||||||||
| cidade | String | Cidade principal do cliente | Não | Tamanho máximo: 100 caracteres | ||||||||||||||||
| estado | String | Estado principal do cliente | Não | Tamanho máximo: 30 caracteres | ||||||||||||||||
| cep | String | CEP do endereço principal do cliente | Não | Tamanho máximo: 10 caracteres | ||||||||||||||||
| telefone | String | Telefone do cliente | Não | Tamanho máximo: 20 caracteres | ||||||||||||||||
| celular | String | Celular do cliente | Não | Tamanho máximo: 20 caracteres | ||||||||||||||||
| String | Email do cliente | Não | Tamanho máximo: 80 caracteres | |||||||||||||||||
| dataNascimento | Datetime | Data de nascimento do cliente | Não | |||||||||||||||||
| situacao | Int | Situação do cliente | Sim | 0 - Inativo, 1 - Ativo | ||||||||||||||||
| pessoaFisica | Int | Indica se o cliente é uma pessoa física ou jurídica | Sim | 0 - Pessoa Física, 1 - Pessoa Jurídica | ||||||||||||||||
| cpfCnpj | String | CPF ou CNPJ do cliente | Não | Tamanho máximo: 25 caracteres | ||||||||||||||||
| rgInscricao | String | RG do cliente | Não | Tamanho máximo: 25 caracteres | ||||||||||||||||
| sexo | Int | Indica o genero do cliente | Não |
| ||||||||||||||||
| estadoCivil | Int | Indica o estado civil do cliente | Não |
| ||||||||||||||||
| avatarUrl | String | DEFASADO | Não | DEFASADO | ||||||||||||||||
| atividade | String | Atividade | Não | Tamanho máximo: 500 caracteres | ||||||||||||||||
| cracha | String | DEFASADO | Não | DEFASADO | ||||||||||||||||
| idInquilino | String | Identificador do inquilino | Sim | |||||||||||||||||
| idRetaguarda | String | Identificador do cliente na retaguarda | Sim | Tamanho máximo: 100 caracteres | ||||||||||||||||
| idProprietario | String | Identificador do proprietário | Sim | |||||||||||||||||
| loteOrigem | String | Identificador do lote em que serão enviados os dados | Sim | |||||||||||||||||
| tipoEndereco | Int | Tipo Endereço | Não |
| ||||||||||||||||
| descricao | String | Descrição | Não | Tamanho máximo: 100 caracteres | ||||||||||||||||
| IdRetaguardaProfissional | String | Id Retaguarda do Profissional vinculado a tabela usuario | Não | Tamanho máximo: 100 caracteres regra de gravação: campos null ou não preenchidos e os encontrados na tabela usuario. regra de erro: não encontrado na tabela usuário o registro inteiro estará com erro. | ||||||||||||||||
| IdRetaguardaRamoAtividade | String | Id Retaguarda Ramo Atividade vinculado a tabela ramo_atividade | Não | Tamanho máximo: 100 caracteres regra de gravação: campos null ou não preenchidos e os encontrados na tabela cliente. regra de erro: não encontrado na tabela cliente ou enviado no mesmo payload o registro inteiro estará com erro. | ||||||||||||||||
| IdRetaguardaRedeCliente | String | Id Retaguarda da rede do cliente | Não | Tamanho máximo: 100 caracteres | ||||||||||||||||
| IdRetaguardaClientePrincipal | String | Id Retaguarda do cliente principal, caso seja o principal será nulo. | Não | Tamanho máximo: 100 caracteres regra de gravação: campos null ou não preenchidos e os encontrados na tabela cliente. regra de erro: não encontrado na tabela cliente ou enviado no mesmo payload o registro inteiro estará com erro. | ||||||||||||||||
| IdRetaguardaPraca | String | Id Retaguarda praça do cliente | Não | Tamanho máximo: 100 caracteres | ||||||||||||||||
| IdRetaguardaRegiao | String | Id Retaguarda regiao vinculado a tabela regiao | Não | Tamanho máximo: 100 caracteres regra de gravação: campos null ou não preenchidos e os encontrados na tabela regiao. regra de erro: não encontrado na tabela regiao o registro inteiro estará com erro. | ||||||||||||||||
| UtlizadaPrecoAtacado | bool | Falso ou Verdadeiro | Não | False - Falso, True - Verdadeiro Valor default = False |
Premissas:
Restrições:
Parametros de sistema:
...
