Este método é responsável pela criação de novos Clientes
- Endpoint: /api/retaguarda/v2/clienteenderecos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de 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 56 = ClienteEndereco |
Expandir |
---|
title | Exemplo de body da requisição |
---|
|
[ { "idCliente": 0, "idClienteRetaguarda": "string", "descricaoTipo": "string", "endereco": "string", "numero": "string", "complemento": "string", "bairro": "string", "cidade": "string", "estado": "string", "cep": "string", "situacao": 0, "tipoEndereco": 0, "enviarPnet": 0, "idInquilino": "string", "idRetaguarda": "string", "idProprietario": "string", "loteOrigem": "string" } ] |
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 |
|
Expandir |
---|
|
Código | Tipo |
---|
0 | Entrega | 1 | Comercial | 2 | Cobranca |
|
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 |
|
|