...
- Endpoint: /api/retaguarda/v2/clientesclienteenderecos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Clientes Cliente endereço]s 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 56 = Cliente ClienteEndereco |
| Expandir |
|---|
| title | Exemplo de body da requisição |
|---|
|
[
{
"nomeidCliente": "string"0,
"enderecoidClienteRetaguarda": "string",
"numerodescricaoTipo": "string",
"complementoendereco": "string",
"bairronumero": "string",
"cidadecomplemento": "string",
"estadobairro": "string",
"cepcidade": "string",
"telefoneestado": "string",
"celularcep": "string",
"email": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"situacao": 0,
"pessoaFisicatipoEndereco": 0,
"cpfCnpj": "string",
"rgInscricao": "string",
"sexo": 0,
"estadoCivil": 0,
"avatarUrl": "string"enviarPnet": 0,
"atividade": "string",
"cracha": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
] |
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo| idClienteRetaguarda | Tipo | Descrição | Observações | | String | Identificador do cliente na retaguarda | Obrigatório | | descricaoTipo | nome | String | Nome | Descrição do tipo do | cliente| endereço | Obrigatório Tamanho máximo: 200 caracteres | | Opcional | | endereco | String | Endereço principal do cliente | OpcionalTamanho máximo: 150 caracteres | | numero | String | Número do endereço principal do cliente | Opcional Tamanho máximo: 15 caracteres | | complemento | String | Complemente Complemento 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 | OpcionalTamanho máximo: 100 caracteres | | estado | String | Estado principal do cliente | OpcionalTamanho 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 endereço (0 - Inativo, 1 - Ativo) | Obrigatório | | pessoaFisicatipoEndereco | 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 | | Tipo endereço (Definição abaixo) | Opcional | cracha | String | Crachá | Opcional Tamanho máximo: 20 caracteres | | idInquilino | String | Identificador do inquilino inquilino | ObrigatórioOpcional | | idRetaguarda | String | Identificador do cliente endereço na retaguarda | ObrigatórioOpcional | | idProprietario | String | Identificador do proprietário | ObrigatórioOpcional | | loteOrigem | String | Identificador Identificado do lote em que serão enviados os dados | Obrigatório para a integração | Opcional | |
| Expandir |
|---|
|
| Código | Tipo |
|---|
| 0 | Entrega | | 1 | Comercial | | 2 | Cobranca |
|
| Aviso |
|---|
| title | Aviso ao desenvolvedor da documentação |
|---|
|
| Inserir os dados de sexo e estado civil. |
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| 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 |
|
| Expandir |
|---|
| 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 |
|
|
