Este método é responsável pela criação de novos Clientesbusca dos cliente enviados pelo TOTVS Varejo PDV Omni
Endpoint: /api/retaguarda/v2/
clienteenderecosClienteMensagens/{IdInquilino}
- Método: PostGET
- Autenticação: Bearer token
- Permissão: Retaguarda
...
| Dica |
|---|
Pode-se passar uma lista de |
...
idProprietario nos parametros da requisição para se realizar o filtro. Atributo: listIdProprietario={IdProprietario} |
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| | Expandir |
|---|
| {
"success": true,
"message |
|
|
| 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 descricaoTipo "string"endereco "string"numerocomplementobairrocidadeestadoidInquilino": "string",
" |
|
cepidRetaguarda": "string",
" |
|
situacao 0"2024-04-05T16:20:20.376Z",
"dataCadastro" |
|
tipoEndereco": 0: "2024-04-05T16:20:20.376Z",
" |
|
enviarPnet 0idInquilinoidRetaguarda idProprietario "string" loteOrigem "string" ] |
expand |
| title | Definição dos campos de requisição |
|---|
|
Descrição |
|---|
| success | Booleano | 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 | Lista de Objetos | Objetos retornados | | data.tipo | Inteiro | Tipo de dado retornado | | data.status | Inteiro | Status | | data.conteudo | String | Conteúdo do cliente em base64 | | data.cpfCnpj | String | CPF ou CNPJ do cliente | | data.numeroLoja | String | Numero da loja | | data.id | String | Identificador do dado no POSH | | data. |
|
|
| 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 | | data.idRetaguarda | String | Identificador do |
|
endereço Opcional | | data.dataAtualizacao | Data/Hora | Data de atualização do registro | | data.dataCadastro | Data/Hora | Data de cadastro do registro | | data.idProprietario | String | Identificador do proprietário |
|
Opcional | Identificado | Identificador do lote em que |
|
serão enviados os dadosOpcional | | Expandir |
|---|
|
| Código | Tipo |
|---|
| 0 | Entrega |
| 1 | Comercial |
| 2 | Cobranca |
| o dado foi enviado | | data.lote | String | Identificador do loja lote em que o dado foi enviado |
|
|
| 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 | | errors | Objeto | | Listas com os erros encontrados no processo | TotalTime| totalTime | int| Inteiro | tempo da requisição | NumberOfRecords| numberOfRecords | int| Inteiro | 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 |
|
|
