Exibir origem

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

Este endpoint recebe uma lista de Clientes para que possam ser enviados vários na mesma requisição

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

[
{
"nome": "string",
"endereco": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"cidade": "string",
"estado": "string",
"cep": "string",
"telefone": "string",
"celular": "string",
"email": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"situacao": 0,
"pessoaFisica": 0,
"cpfCnpj": "string",
"rgInscricao": "string",
"sexo": 0,
"estadoCivil": 0,
"avatarUrl": "string",
"atividade": "string",
"cracha": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Campo	Tipo	Descrição	Observações
nome	String	Nome do cliente	Obrigatório Tamanho máximo: 200 caracteres
endereco	String	Endereço principal do cliente	Opcional Tamanho máximo: 150 caracteres
numero	String	Número do endereço principal do cliente	Opcional Tamanho máximo: 15 caracteres
complemento	String	Complemente do endereço principal do cliente	Opcional Tamanho máximo: 50 caracteres
bairro	String	Bairro principal do cliente	Opcional Tamanho máximo: 100 caracteres
cidade	String	Cidade principal do cliente	Opcional Tamanho máximo: 100 caracteres
estado	String	Estado principal do cliente	Opcional Tamanho máximo: 30 caracteres
cep	String	CEP do endereço principal do cliente	Opcional Tamanho máximo: 10 caracteres
telefone	String	Telefone do cliente	Opcional Tamanho máximo: 20 caracteres
celular	String	Celular do cliente	Opcional Tamanho máximo: 20 caracteres
email	String	Email do cliente	Opcional Tamanho máximo: 80 caracteres
dataNascimento	Datetime	Data de nascimento do cliente	Opcional
situacao	Int	Situação do cliente (0 - Inativo, 1 - Ativo)	Obrigatório
pessoaFisica	Int	Indica se o cliente é uma pessoa física ou jurídica	Obrigatório
cpfCnpj	String	CPF ou CNPJ do cliente	Obrigatório Tamanho máximo: 14 caracteres
rgInscricao	String	RG do cliente	Opcional Tamanho máximo: 250 caracteres
sexo	Int	Indica o genero do cliente (Descritivo abaixo)	Opcional Códigos de envio abaixo
estadoCivil	Int	Indica o estado civil do cliente (Descritivo abaixo)	Opcional Códigos de envio abaixo
avatarUrl	String	Avatar do cliente	Opcional
atividade	String	Atividade	Opcional Tamanho máximo: 500 caracteres
cracha	String	Crachá	Opcional Tamanho máximo: 20 caracteres
idInquilino	String	Identificador do inquilino	Obrigatório
idRetaguarda	String	Identificador do cliente na retaguarda	Obrigatório
idProprietario	String	Identificador do proprietário	Obrigatório
loteOrigem	String	Identificador do lote em que serão enviados os dados	Obrigatório para a integração

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

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

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

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

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

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

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

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