TDN MIGRADO Cliente

Este método é responsável pela criação de novos Clientes

Endpoint: /api/retaguarda/v2/clientes
Versão: 2
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

...

Aviso
Para que a baixa do Cliente criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 0 = Cliente

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

Expandir

Exemplo de body da requisição

[
{
"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",
"

nome

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",

"IdProfissionalRetaguarda": string"
}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

atividade

String

Atividade

Não

Tamanho máximo: 500 caracteres

avatarUrl

String

Avatar do cliente

Não

Tamanho máximo: 300caracteres

bairro

String

Bairro principal do cliente

Não

Tamanho máximo: 100 caracteres

celular

String

Celular do cliente

Não

Tamanho máximo: 20 caracteres

cep

String

CEP do endereço principal do cliente

Não

Tamanho máximo: 10 caracteres

cidade

String

Cidade principal do cliente

Não

Tamanho máximo: 100 caracteres

complemento

String

Complemente do endereço principal do cliente

Não

Tamanho máximo: 50 caracteres

cpfCnpj

String

CPF ou CNPJ do cliente

Sim

Tamanho máximo: 14 caracteres

cracha

String

Crachá

Não

Tamanho máximo: 20 caracteres

dataNascimento

Datetime

Data de nascimento do cliente

Não

email

String

Email do cliente

Não

Tamanho máximo: 80 caracteres

endereco

String

Endereço principal do cliente

Não

Tamanho máximo: 150 caracteres

estado

String

Estado principal do cliente

Não

Tamanho máximo: 30 caracteres

estadoCivil

Int

Indica o estado civil do cliente (Descritivo abaixo)

Não

Código	Descrição
0	Não informado
1	Casado
2	Solteiro
3	Viúvo
4	Separado
5	Devorciado
6	Outros

idInquilino

String

Identificador do inquilino

Sim

idProprietario

String

Identificador do proprietário

Sim

idRetaguarda

String

Identificador do cliente na retaguarda

Sim

Tamanho máximo: 100 caracteres

loteOrigem

String

Identificador do lote em que serão enviados os dados

Sim

nome

String

Nome do cliente

Sim

Tamanho máximo: 200 caracteres

numero

String

Número do endereço principal do cliente

Não

Tamanho máximo: 15 caracteres

pessoaFisica

Int

Indica se o cliente é uma pessoa física ou jurídica

Sim

rgInscricao

String

RG do cliente

Não

Tamanho máximo: 25 caracteres

sexo

Int

Indica o genero do cliente (Descritivo abaixo)

Não

Código	Definição
0	Não Definido
1	Masculino
2	Feminino

situacao

Int

Situação do cliente

Sim

0 - Inativo, 1 - Ativo

telefone

String

Telefone do cliente

Não

Tamanho máximo: 20 caracteres

IdProfissionalRetaguarda

String

Id do Profissional vinculado ao cliente

Não

Tamanho máximo: 100 caracteres

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

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	número de dados inseridos

Card

label	400 - Bad Request

Aviso
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Deck of Cards

id	clienteBadRequest

Card

label	Caso 1

Informações
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

Column

width	50%

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

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

Card

label	Caso 2

Informações
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação

Section

Column

width	50%

{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Campo	Tipo	Descrição
Success	bool	Indica se a criação do cliente foi feita com sucesso
Message	string	Messagem com os erros
Data	objeto	Objeto cliente
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Card

label	V3.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.

Requisição

Section

Column

width	50%

Exemplo de body da requisição

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

cidade

celular": "string",
"

estado

cep": "string",
"

cep

cidade": "string",
"

telefone

complemento": "string",
"

celular

cpfCnpj": "string",
"

email

cracha": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"

situacao

descricao":

0

"string",
"

pessoaFisica

email":

0

"string",
"

cpfCnpj

endereco": "string",
"

rgInscricao

estado": "string",
"

sexo

estadoCivil": 0,
"

estadoCivil

idInquilino":

0

"string",
"

avatarUrl

idProprietario": "string",
"

atividade

idRetaguarda": "string",
"

cracha

loteOrigem": "string",
"

idInquilino

nome": "string",
"

idRetaguarda

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

"idProprietario

"rgInscricao": "string",
"sexo": 0,
"situacao": 0,
"telefone": "string",

"loteOrigem

"tipoEndereco": 0,

"idProfissionalRetaguarda": "string"
}
]

Column

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório	Observações
nome	String	Nome do cliente

Obrigatório

Sim	Tamanho máximo:

200

250 caracteres
endereco	String	Endereço principal do cliente

Opcional

Não	Tamanho máximo: 150 caracteres
numero	String	Número do endereço principal do cliente

Opcional

Não	Tamanho máximo: 15 caracteres
complemento	String	Complemente do endereço

pricnipal

principal do cliente

Opcional

Não	Tamanho máximo: 50 caracteres
bairro	String	Bairro principal do cliente

Opcional

Não	Tamanho máximo: 100 caracteres
cidade	String	Cidade principal do cliente

Opcional

Não	Tamanho máximo: 100 caracteres
estado	String	Estado principal do cliente

Opcional

Não	Tamanho máximo: 30 caracteres
cep	String	CEP do endereço principal do cliente

Opcional

Não	Tamanho máximo: 10 caracteres
telefone	String	Telefone do cliente

Opcional

Não	Tamanho máximo: 20 caracteres
celular	String	Celular do cliente

Opcional

Não	Tamanho máximo: 20 caracteres
email	String	Email do cliente

Opcional

Não	Tamanho máximo: 80 caracteres
dataNascimento	Datetime	Data de nascimento do cliente

Opcional

Não
situacao	Int	Situação do

cliente (

cliente

Sim

0 - Inativo, 1 - Ativo

)

Obrigatório

pessoaFisica

Int

Indica se o cliente é uma pessoa física ou jurídica

Obrigatório

Sim	0 - Pessoa Física, 1 - Pessoa Jurídica
cpfCnpj	String	CPF ou CNPJ do cliente

Obrigatório

Não	Tamanho máximo:

14

25 caracteres
rgInscricao	String	RG do cliente

Opcional

Não	Tamanho máximo:

250

25 caracteres
sexo	Int	Indica o genero do

cliente (Descritivo abaixo)

cliente

Não

Descrição	Código
Não informado	0
Masculino	1
Feminino	2

Opcional

estadoCivil

Int

Indica o estado civil do cliente

(Descritivo abaixo)

Não

Descrição	Código
Não informado	0
Casado	1
Solteiro	2
Viúvo	3
Separado	4
Devorciado	5
Outros	6

Opcional

avatarUrl

String

Avatar do cliente

DEFASADO

Não

DEFASADO

Opcional


atividade	String	Atividade

Opcional

Não	Tamanho máximo: 500 caracteres
cracha	String

Crachá

DEFASADO

Opcional

Tamanho máximo: 20 caracteres

Não	DEFASADO
idInquilino	String	Identificador do inquilino

Obrigatório

Sim
idRetaguarda	String	Identificador do cliente na retaguarda

Obrigatório

Sim	Tamanho máximo: 100 caracteres
idProprietario	String	Identificador do proprietário

Obrigatório

Sim
loteOrigem	String	Identificador do lote em que serão enviados os dados

Obrigatório para a integração

Sim

tipoEndereco

Int

Tipo Endereço

Não

Descrição	Código
Entrega	0
Comercial	1
Cobrança	2

descricao

String

Descrição

Não

Tamanho maxímo: 100 caracteres

idProfissionalRetaguarda

String

Id do Profissional vinculado ao cliente

Não

Tamanho maxímo: 100 caracteres

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

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	número de dados inseridos

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

Definições dos campos do retorno

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

Expandir

title	Definição dos campos de retorno

Expandir

title	200 - Ok

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento cliente foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento cliente eles serão enviados nesse campo
Data	objeto	Objeto compartilhamento cliente criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Expandir

title	Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Expandir

title	400 - Bad Request

Aviso
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Deck of Cards

id	clienteBadRequest

Card

label	Caso 1

Informações
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

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

Card

label	Caso 2

Informações
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação

Campo	Tipo	Descrição
Success	bool	Indica se a criação do cliente foi feita com sucesso
Message	string	Messagem com os erros
Data	objeto	Objeto cliente
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Expandir

title	Body de retorno

{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno