TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela criação de novos Clientes

  • Endpoint: /api/retaguarda/v2/clienteenderecos
  • Versão: 2
  • 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

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

[
  {
    "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"
  }
]

CampoTipoDescriçãoObservaçõesObrigatório
idClienteRetaguardaStringIdentificador do cliente na retaguarda
Sim
descricaoTipoStringDescrição do tipo do endereço
Não
enderecoStringEndereçoTamanho máximo: 150 caracteresNão
numeroStringNúmero do endereçoTamanho máximo: 15 caracteresNão
complementoStringComplemento do endereçoTamanho máximo: 50 caracteresNão
bairroStringBairroTamanho máximo: 100 caracteresNão
cidadeStringCidadeTamanho máximo: 100 caracteresNão
estadoStringEstadoTamanho máximo: 30 caracteresNão
cepStringCEP do endereçoTamanho máximo: 10 caracteresNão
situacaoIntSituação do endereço 0 - Inativo, 1 - AtivoSim
tipoEnderecoIntTipo endereço.
CódigoTipo
0Entrega
1Comercial
2Cobranca
Não
idInquilinoStringIdentificador do inquilino
Sim
idRetaguardaStringIdentificador do endereço na retaguarda
Sim
idProprietarioStringIdentificador do proprietário
Sim
loteOrigemStringIdentificado do lote em que serão enviados os dados
Sim
enviapnetIntIdentifica se esse endereço vai ser enviado do PDV para a retaguarda
Não
idClienteIntIdentificador do cliente no PDV
Não



Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

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
}





  • Sem rótulos