Histórico da Página

Este método é responsável pela criação de novos Clientesbusca dos cliente enviados pelo TOTVS Varejo PDV Omni

Endpoint:
- V2: /api/retaguarda/v2
/clienteenderecos
- /ClienteMensagens/{IdInquilino}
- V3: /api/retaguarda/v3/ClienteMensagens/{IdInquilino}
Método: PostGET
Autenticação: Bearer token
Permissão: Retaguarda

...

Dica
Pode-se passar uma lista de

...

idProprietario nos parametros da requisição para se realizar o filtro.

Atributo: listIdProprietario={IdProprietario}

Expandir

title	Definição dos campos de retorno

Expandir

title	200 - Ok

Expandir

title	Body do retorno

{
"success": true,
"message": "string",
"data": [
{
"tipo": 0,
"status": 0,
"conteudo": "string",
"cpfCnpj": "string",
"numeroLoja": "string",
"id": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"dataAtualizacao": "2024-04-05T16:20:20.376Z",
"dataCadastro": "2024-04-05T16:20:20.376Z",
"idProprietario": "string",
"loteOrigem": "string",
"lote": "string"
}
],
"errors": {
},
"totalTime": 0,
"numberOfRecords": 0
}

Campo	Tipo	Descrição
success	Booleano	Indica se a criação do compartilhamento foi feita com sucesso
message	String	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
data	Lista de Objetos	Objetos retornados
data.tipo	Inteiro	Tipo de dado retornado
data.status	Inteiro	Status
data.conteudo	String	Conteúdo do cliente em base64 *
data.cpfCnpj	String	CPF ou CNPJ do cliente
data.numeroLoja	String	Numero da loja
data.id	String	Identificador do dado no POSH
data.idInquilino	String	Identificador do inquilino
data.idRetaguarda	String	Identificador do dado na retaguarda
data.dataAtualizacao	Data/Hora	Data de atualização do registro
data.dataCadastro	Data/Hora	Data de cadastro do registro
data.idProprietario	String	Identificador do proprietário
data.loteOrigem	String	Identificador do lote em que o dado foi enviado
data.lote	String	Identificador do loja lote em que o dado foi enviado
errors	Objeto	Listas com os erros encontrados no processo
totalTime	Inteiro	tempo da requisição
numberOfRecords	Inteiro	número de dados inseridos

Expandir

title	* Conteúdo do Cliente

Body de Envio (Base64 decodificado)

{
"atividade": "string",
"avatarUrl": "string",
"bairro

Aviso
Para que a baixa do Cliente endereço criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 56 = ClienteEndereco

Expandir

title	Exemplo de body da requisição

[
{
"idCliente": 0,
"idClienteRetaguarda

": "string",
"

descricaoTipo

celular": "string",
"

endereco

cep": "string",
"

numero

cidade": "string",
"complemento": "string",
"cpfCnpj": "string",
"cracha": "string",
"dataNascimento": "2024-08-15T16:29:51.672Z",
"email": "string",
"endereco": "string",
"Enderecos": [
{
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"endereco": "string",
"estado": "string",

"cep

"numero": "string",
"tipo": "string",
"tipoId": 0,
"situacao": 0,
"idRetaguarda": "string",
"id": 0,
"dataCadastro": "2024-08-15T16:29:51.672Z",
"dataAtualizacao": "2024-08-15T16:29:51.672Z"
}
],
"clienteAlterado": true,
"enviarpnet": 0,
"estado": "string",
"estadoCivil": 0,
"nome": "string",

"tipoEndereco

"numero": "string",
"pessoaFisica": 0,
"

enviarPnet": 0

rgInscricao": "string",
"sexo": 0,
"telefone": "string",
"Loja": {
"cnpj": "string",
"

idInquilino

numeroLoja": "string",
"idRetaguarda": "string",
"

idProprietario

codigoIdentificacaoLoja": "string"
},
"

loteOrigem

situacao": 0,
"idRetaguarda": "string",
"id": 0,
"dataCadastro": "2024-08-15T16:29:51.672Z",
"dataAtualizacao": "2024-08-15T16:29:51.672Z"
}

]

Expandir

title	Definição dos campos de requisição

idClienteRetaguarda

String

Identificador do cliente na retaguarda

Obrigatório

descricaoTipo

String

Descrição do tipo do endereço

Opcional

endereco

String

Endereço

Opcional

numero

String

Número do endereço

Opcional

complemento

String

Complemento do endereço

Opcional

bairro

String

Bairro

Opcional

cidade

String

Cidade

Opcional

estado

String

Estado

Opcional

cep

String

CEP do endereço

Opcional

situacao

Int

Situação do endereço (0 - Inativo, 1 - Ativo)

Obrigatório

tipoEndereco

Int

Tipo endereço (Definição abaixo)

Opcional

idInquilino

String

Identificador do inquilino

Opcional

idRetaguarda

String

Identificador do endereço na retaguarda

Opcional

idProprietario

String

Identificador do proprietário

Opcional

loteOrigem

String

Identificado do lote em que serão enviados os dados

Opcional

Campos

Campo	Tipo	Descrição
atividade	String	Atividade/Profissão
avatarUrl	String	URL Avatar do Cliente
bairro	String	Bairro
celular	String	Celular
cep	String	CEP
cidade	String	Cidade
complemento	String	Complemento
cpfCnpj	String	CPF/CNPJ
cracha	String	Crachá
dataNascimento	Data/Hora	Data de Nascimento
email	String	E-mail
endereco	String	Endereço
Enderecos	Lista de Objetos	Lista de Endereços
Enderecos.bairro	String	Bairro
Enderecos.celular	String	Celular
Enderecos.cep	String	CEP
Enderecos.cidade	String	Cidade
Enderecos.complemento	String	Complemento
Enderecos.endereco	String	Logradouro
Enderecos.estado	String	Estado
Enderecos.numero	String	Número
Enderecos.tipo	String	Tipo do Endereço: 0 - Entrega 1 - Comercial 2 - Cobrança
Enderecos.tipoId	Inteiro	Código Id do Tipo Endereço
Enderecos.situacao	Inteiro	Situação Cadastro 1 - Ativo 0 - Inativo
Enderecos.idRetaguarda	String	Código Retaguarda do Endereço
Enderecos.id	Inteiro	Código Id do Endereço
Enderecos.dataCadastro	Data/Hora	Data de Cadastro do Registro do Endereço
Enderecos.dataAtualizacao	Data/Hora	Data de Atualização do Registro do Endereço
clienteAlterado	Booleano	Cliente Alterado: True - Sim False - Não
enviarpnet	Inteiro	Enviarpnet (Enviar registro para retaguarda)
estado	string	Sigla UF
estadoCivil	Inteiro	Estado Civil: 0 - Não informado 1 - Casado 2 - Solteiro 3 - Viúvo 4 - Separado 5 - Divorciado 6 - Outros OBS: Informação extraída do Totvs Varejo PDV Omni
nome	String	Nome do Cliente
numero	String	Número do Endereço
pessoaFisica	Inteiro	Pessoa Física: 1 - CPF 2 - CNPJ
rgInscricao	String	RG
sexo	Inteiro	Estado Civil: 0 - Não informado 1 - Casado 2 - Solteiro 3 - Viúvo 4 - Separado 5 - Divorciado 6 - Outros OBS: Informação extraída do Totvs Varejo PDV Omni
telefone	String	Nome do Cliente
Loja	Objeto	Objeto da Loja
Loja.cnpj	String	CNPJ da Loja
Loja.numeroLoja	String	Número de Identificação da Loja
Loja.idRetaguarda	String	Código Retaguarda da Loja
Loja.codigoIdentificacaoLoja	String	Código de Identificação da Loja
situacao	Inteiro	Situação Cadastral: 1 - Ativo 0 - Inativo
idRetaguarda	String	Código Retaguarda do Cliente
id	Inteiro	Código Id do Cliente (Uso interno do Totvs Varejo PDV Omni)
dataCadastro	Data/Hora	Data de Cadastro do Registro do Cliente
dataAtualizacao	Data/Hora	Data de Atualização do Registro do Cliente

Expandir

title	TipoEndereco

Código

Tipo

0

Entrega

1

Comercial

2

Cobranca

Expandir

title	Definição dos campos de retorno

número de dados inseridos

Expandir

title	200 - Ok

Campo

Tipo

Descrição

Success

bool

Indica se a criação do compartilhamento foi feita com sucesso

Message

string

Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo

Data

objeto

Objeto compartilhamento criado

Errors

Lista

Listas com os erros encontrados no processo

TotalTime

int

tempo da requisição

NumberOfRecords

int

Expandir

title	400 - Bad Request

Campo	Tipo	Descrição
code	string	Código de erro
message	string	Mensagem do erro
detailedMessage	string	Detalhamento do erro
helpUrl	string	url de ajuda
TotalTime	string	Tempo total de busca
details	lista de objeto	Lista de objeto de erros
details.guid	string	Identificador do erro
details.code	string	Código do erro
details.message	string	Mensagem do erro
details.detailedMessage	string	Detalhamento do erro

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 9

Chave