...
- Endpoint: /api/retaguarda/v2/clientesclienteenderecos
- Versão: 2
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Clientes Cliente endereços para que possam ser enviados vários na mesma requisição
Aviso |
---|
Para que a baixa do Cliente endereço criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 0 = Cliente56 = ClienteEndereco |
Deck of Cards |
---|
|
|
Expandir |
---|
title | Exemplo de body da requisição[ { " |
|
| nomeendereconumerocidade": "string", "complemento": "string", " |
|
| bairroendereco": "string", "enviarPnet": 0, " |
|
| cidadeestado": "string", "idCliente": 0, " |
|
| estadoidClienteRetaguarda": "string", " |
|
| cepidInquilino": "string", " |
|
| telefoneidProprietario": "string", " |
|
| celularidRetaguarda": "string", " |
|
| emaildataNascimento2024-04-02T18:58:17.727Zstring", "situacao": 0, " |
|
| pessoaFisica": 0 Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
idClienteRetaguarda | String | Identificador do cliente na retaguarda | Sim | Tamanho máximo: 100 caracteres | endereco | String | Endereço | Não | Tamanho máximo: 150 caracteres | numero | String | Número do endereço | Não | Tamanho máximo: 15 caracteres | complemento | String | Complemento do endereço | Não | Tamanho máximo: 50 caracteres | bairro | String | Bairro | Não | Tamanho máximo: 100 caracteres | cidade | String | Cidade | Não | Tamanho máximo: 100 caracteres | estado | String | Estado | Não | Tamanho máximo: 30 caracteres | cep | String | CEP do endereço | Não | Tamanho máximo: 10 caracteres | situacao | Int | Situação do endereço | Sim | 0 - Inativo, 1 - Ativo | tipoEndereco | Int | Tipo endereço | Não | Código | Tipo |
---|
0 | Entrega | 1 | Comercial | 2 | Cobranca |
| idInquilino | String | Identificador do inquilino | Não |
| idRetaguarda | String | Identificador do endereço na retaguarda | Não | Tamanho máximo: 100 caracteres | idProprietario | String | Identificador do proprietário | Não |
| loteOrigem | String | Identificado do lote em que serão enviados os dados | Não |
|
|
|
Retorno Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, " |
|
|
| cpfCnpjstringRequisição inserida com sucesso!", " |
|
|
| rgInscricaostringsexoestadoCivil": 0, "avatarUrl Column |
---|
| Definições dos campos do retornoCampo | 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 |
---|
| Aviso |
---|
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint |
Deck of Cards |
---|
| Card |
---|
| Informações |
---|
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório |
Section |
---|
Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", " |
|
|
|
|
|
| atividadedetailedMessage": "string", " |
|
|
|
|
|
| crachahelpUrl": "string", "details": [ { " |
|
|
|
|
|
| idInquilinoidRetaguardaidProprietarioloteOrigemdetailedMessage": "string" } ] } |
|
|
|
|
|
|
|
expand Expandir |
---|
title | Definição dos campos de retorno |
---|
|
| title | Definição | de requisiçã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 pricnipal 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 |
estadoCivil | Int | Indica o estado civil do cliente (Descritivo abaixo) | Opcional |
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 |
|
---|
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 |
---|
| 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 |
---|
| Exemplo de body de retorno{ "success": false, "message": "", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retornoCampo | 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 |
---|
|
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 |
---|
| Exemplo de body da requisição[ { "bairro": "string", "cep": "string", "cidade": "string", "complemento": "string", "descricaoTipo": "string", "endereco": "string", "enviarPnet": 0, "estado": "string", "idCliente": 0, "idClienteRetaguarda": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "loteOrigem": "string", "numero": "string", "situacao": 0, "tipoEndereco": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
idClienteRetaguarda | String | Identificador do cliente na retaguarda | Sim |
| descricaoTipo | String | Descrição do tipo do endereço | Não |
| endereco | String | Endereço | Não | Tamanho máximo: 150 caracteres | numero | String | Número do endereço | Não | Tamanho máximo: 15 caracteres | complemento | String | Complemento do endereço | Não | Tamanho máximo: 50 caracteres | bairro | String | Bairro | Não | Tamanho máximo: 100 caracteres | cidade | String | Cidade | Não | Tamanho máximo: 100 caracteres | estado | String | Estado | Não | Tamanho máximo: 30 caracteres | cep | String | CEP do endereço | Não | Tamanho máximo: 10 caracteres | situacao | Int | Situação do endereço | Sim | 0 - Inativo, 1 - Ativo | tipoEndereco | Int | Tipo endereço. | Não | Código | Tipo |
---|
0 | Entrega | 1 | Comercial | 2 | Cobranca |
| idInquilino | String | Identificador do inquilino | Sim |
| idRetaguarda | String | Identificador do endereço na retaguarda | Sim |
|
|
|
idRetaguarda | String | Identificador do cliente na retaguarda | Obrigatório |
| idProprietario | String | Identificador do proprietário |
|
|
|
ObrigatórioIdentificador Expandir |
---|
| Identificado do lote em que serão enviados os dados |
|
|
|
| Obrigatório para a integração |
Aviso |
---|
title | Aviso ao desenvolvedor da documentação |
---|
|
Inserir os dados de sexo e estado civil. |
| Sim |
| enviapnet | Int | Identifica se esse endereço vai ser enviado do PDV para a retaguarda | Não |
| idCliente | Int | Identificador do cliente no PDV | Não |
|
|
|
Retornos Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| 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 |
|
|
|
| expand | title | Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | 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 |
|
|
|
|
|