TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela busca dos Clientes (ClienteMensagens) quando cadastrados e enviados pelo TOTVS Varejo PDV Omni

  • Endpoint:

    • V2: /api/retaguarda/v2/ClienteMensagens/{IdInquilino}

    • V3: /api/retaguarda/v3/ClienteMensagens/{IdInquilino}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Pode-se passar uma lista de idProprietario nos parametros da requisição para se realizar o filtro.

Atributo: listIdProprietario={IdProprietario}

{
  "success": true,
  "message": "string",
  "data": [
    {
      "tipo": 0,
      "status": 0,
      "conteudo": "string",
      "cpfCnpj": "string",
      "numeroLoja": "string",
      "id": "string",
      "idInquilino": "string",
      "idRetaguarda": "string",
      "dataAtualizacao": "2024-04-05T16:20:20.376Z",
      "dataCadastro": "2024-04-05T16:20:20.376Z",
      "idProprietario": "string",
      "loteOrigem": "string",
      "lote": "string"
    }
  ],
  "errors": {
  },
  "totalTime": 0,
  "numberOfRecords": 0
}

Campo

Tipo

Descrição

successBooleanoIndica 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
dataLista de ObjetosObjetos retornados
data.tipoInteiroTipo de dado retornado
data.statusInteiroStatus 
data.conteudoStringConteúdo do cliente em base64 *
data.cpfCnpjStringCPF ou CNPJ do cliente
data.numeroLojaStringNumero da loja
data.idStringIdentificador do dado no POSH
data.idInquilinoStringIdentificador do inquilino
data.idRetaguardaStringIdentificador do dado na retaguarda
data.dataAtualizacaoData/HoraData de atualização do registro
data.dataCadastroData/HoraData de cadastro do registro
data.idProprietarioStringIdentificador do proprietário
data.loteOrigemStringIdentificador do lote em que o dado foi enviado
data.loteStringIdentificador do loja lote em que o dado foi enviado
errorsObjetoListas com os erros encontrados no processo
totalTimeInteirotempo da requisição
numberOfRecordsInteironúmero de dados inseridos
  • Body de Envio (Base64 decodificado)

{
    "atividade": "string",
    "avatarUrl": "string",
    "bairro": "string",
    "celular": "string",
    "cep": "string",
    "cidade": "string",
    "complemento": "string",
    "cpfCnpj": "string",
    "cracha": "string",
    "dataNascimento": "2024-08-15T16:29:51.672Z",
    "email": "string",
    "endereco": "string",
    "Enderecos": [
        {
            "bairro": "string",
            "celular": "string",
            "cep": "string",
            "cidade": "string",
            "complemento": "string",
            "endereco": "string",
            "estado": "string",
            "numero": "string",
            "tipo": "string",
            "tipoId": 0,
            "situacao": 0,
            "idRetaguarda": "string",
            "id": 0,
            "dataCadastro": "2024-08-15T16:29:51.672Z",
            "dataAtualizacao": "2024-08-15T16:29:51.672Z"            
        }
    ],

   "ObservacaoAdicionalValor": [
        {
            "IdOperacao": "24695",
            "IdRetaguardaObservacaoAdicionalCampo": 16,
            "Valor": "11/11/2025",
            "Situacao": 1,
            "IdRetaguarda": "2aacc6e2-44c9-4b73-9ae5-ee3679d6dcdd",
            "Id": 49,
            "DataCadastro": "2025-11-11T11:28:27.291376",
            "DataAtualizacao": "2025-11-11T11:28:27.390273",
        }

],

    "clienteAlterado": true,
    "enviarpnet": 0,
    "estado": "string",
    "estadoCivil": 0,
    "nome": "string",
    "numero": "string",
    "pessoaFisica": 0,
    "rgInscricao": "string",
    "sexo": 0,
    "telefone": "string",
    "Loja": {
        "cnpj": "string",
        "numeroLoja": "string",
        "idRetaguarda": "string",
        "codigoIdentificacaoLoja": "string"
    },
    "situacao": 0,
    "idRetaguarda": "string",
    "id": 0,
    "dataCadastro": "2024-08-15T16:29:51.672Z",
    "dataAtualizacao": "2024-08-15T16:29:51.672Z"
}

  • Campos

Campo

Tipo

Descrição

atividadeStringAtividade/Profissão
avatarUrlStringURL Avatar do Cliente
bairroStringBairro
celularStringCelular
cepStringCEP
cidadeStringCidade
complementoStringComplemento
cpfCnpjStringCPF/CNPJ
crachaStringCrachá
dataNascimentoData/HoraData de Nascimento
emailStringE-mail
enderecoStringEndereço
EnderecosLista de ObjetosLista de Endereços
Enderecos.bairroStringBairro
Enderecos.celularStringCelular
Enderecos.cepStringCEP
Enderecos.cidadeStringCidade
Enderecos.complementoStringComplemento
Enderecos.enderecoStringLogradouro
Enderecos.estadoStringEstado
Enderecos.numeroStringNúmero
Enderecos.tipoString

Tipo do Endereço:

0 - Entrega

1 - Comercial

2 - Cobrança

Enderecos.tipoIdInteiroCódigo Id do Tipo Endereço
Enderecos.situacaoInteiro

Situação Cadastro

1 - Ativo

0 - Inativo

Enderecos.idRetaguardaStringCódigo Retaguarda do Endereço
Enderecos.idInteiroCódigo Id do Endereço
Enderecos.dataCadastroData/HoraData de Cadastro do Registro do Endereço
Enderecos.dataAtualizacaoData/HoraData de Atualização do Registro do Endereço
ObservacaoAdicionalValor.IdOperacaotextRelaciona-se ao ID do cliente
ObservacaoAdicionalValor.IdRetaguardaObservacaoAdicionalCampoint4Chave estrangeira para o campo configurado
ObservacaoAdicionalValor.ValortextValor dinâmico inserido no PDV
ObservacaoAdicionalValor.Situacaoint4Status do registro
ObservacaoAdicionalValor.IdRetaguardavarchar(100)ID de referência do dado na retaguarda
ObservacaoAdicionalValor.IdserialIdentificador único
ObservacaoAdicionalValor.DataCadastrotimestampData de criação
ObservacaoAdicionalValor.DataAtualizacaotimestampData da última atualização
clienteAlteradoBooleano

Cliente Alterado:

True - Sim

False - Não

enviarpnetInteiroEnviarpnet (Enviar registro para retaguarda)
estadostringSigla UF
estadoCivilInteiro

Estado Civil:

  • 0 - Não informado
  • 1 - Casado
  • 2 - Solteiro
  • 3 - Viúvo
  • 4 - Separado
  • 5 - Divorciado
  • 6 - Outros 

OBS: Informação extraída do Totvs Varejo PDV Omni

nomeStringNome do Cliente
numeroStringNúmero do Endereço
pessoaFisicaInteiro

Pessoa Física:
1 - CPF

2 - CNPJ

rgInscricaoStringRG
sexoInteiro
  • 0 - Não informado
  • 1 - Masculino
  • 2 - Feminino

OBS: Informação extraída do Totvs Varejo PDV Omni

telefoneStringNome do Cliente
LojaObjetoObjeto da Loja
Loja.cnpjStringCNPJ da Loja
Loja.numeroLojaStringNúmero de Identificação da Loja
Loja.idRetaguardaStringCódigo Retaguarda da Loja
Loja.codigoIdentificacaoLojaStringCódigo de Identificação da Loja
situacaoInteiro

Situação Cadastral:

1 - Ativo

0 - Inativo

idRetaguardaStringCódigo Retaguarda do Cliente
idInteiroCódigo Id do Cliente (Uso interno do Totvs Varejo PDV Omni)
dataCadastroData/HoraData de Cadastro do Registro do Cliente
dataAtualizacaoData/HoraData de Atualização do Registro do Cliente

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
  • Sem rótulos