TOTVS Varejo PDV Omni

Árvore de páginas

O TOTVS VAREJO PDV OMNI SMART HUB oferece uma API para a consulta de informações do inquilino, tais qual como Nome, CNPJ, Metadados e Versão do Client utilizada por inquilino.

Para a realização da consulta, é necessário utilizar as informações abaixo:

GET Inquilinos (Retaguarda)

  • Endpoint:

    • V2: /api/retaguarda/v2/inquilinos/{idInquilino}

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


{
  "success": true,
  "message": "string",
  "data": {
    "idIdentificacaoExterna": "string",
    "nome": "string",
    "situacao": 0,
    "envioDadoTipo": 0,
    "envioDado": "string",
    "connectionString": "string",
    "clientId": "string",
    "clientSecret": "string",
    "usuario": "string",
    "senha": "string",
    "tokenUrl": "string",
    "metadata": "string",
    "metadataDeserializado": {
      "ativarPDVSyncClientDownIntegrado": true,
      "ativarPDVSyncClientUpIntegrado": true,
      "endpointCreditoConsulta": "string",
      "endpointCreditoConsumo": "string",
      "endpointEstoqueConsulta": "string",
      "endpointIdentificadorPDV": "string",
      "endpointNotaEntradaEnvio": "string",
      "endpointNotaSaidaEnvio": "string",
      "endpointPreVendaAtualiza": "string",
      "endpointPreVendaConsultaListaPedido": "string",
      "endpointPreVendaConsultaPedido": "string",
      "endpointPreVendaEnvio": "string",
      "endpointReservaEstoqueEnvio": "string",
      "endpointToken": "string",
      "endpointNotificaRetaguardaNovaLoja": "string",
      "endpointFormasCondicoesCliente": "string",
      "horariosExecucaoVendaConsolidada": "string",
      "ipDinamico": true,
      "login": "string",
      "maximoTentativas": 0,
      "password": "string",
      "portaRetaguarda": 0,
      "protocoloHttpRetaguarda": "string",
      "retaguarda": "string",
      "tempoMonitoraStatus": 0,
      "tempoMonitoraStatusVenda": 0,
      "tipoAutenticacao": 0,
      "urlBuscaIPDinamico": "string",
      "urlRetaguarda": "string",
      "versaoApi": 0
    },
    "urlRetaguardaFormatada": "string",
    "cnpj": "string",
    "codigoT": "string",
    "particionado": true,
    "particao": "string",
    "versaoPdvSyncClient": "string",
    "idInquilino": "string",
    "dataAtualizacao": "2024-11-06T18:03:06.094Z",
    "dataCadastro": "2024-11-06T18:03:06.094Z",
    "id": "string"
  }
}

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.idIdentificacaoExternaStringCódigo de Identificação Externa
data.nomeStringNome do Cliente
data.situacaoInteiro

Situação do Inquilino

0 - Inativo
1 - Ativo

2 - Pendente

data.envioDadoTipoInteiro

Tipo de Envio de Dados:

0 - FilaGerenciada

1 - Banco

2 - EndPoint

data.envioDadoStringEndpoint do Envio do Dado
data.connectionStringStringConnection String do Banco de Dados
data.clientIdStringClient Id do RAC (Não é utilizado)
data.clientSecretStringClient Secret do RAC (Não é utilizado) 
data.usuarioStringUsuário do RAC (Não é utilizado)
data.senhaStringSenha do RAC (Não é utilizado)
data.tokenUrlStringURL do Token do RAC (Não é utilizado)
data.metadataJson StringMetadata
data.metadataDeserializadoObjetoMetadata no Formato Objeto
data.metadataDeserializado.ativarPDVSyncClientDownIntegradoBooleanoUtilizado para informar se será utilizado o Client DOWN integrado no PDV Omni
data.metadataDeserializado.ativarPDVSyncClientUpIntegradoBooleanoUtilizado para informar se será utilizado o Client UP integrado no PDV Omni
data.metadataDeserializado.endpointCreditoConsultaStringUtilizado para informar o endpoint da API do Processo Online Crédito Consulta
data.metadataDeserializado.endpointCreditoConsumoStringUtilizado para informar o endpoint da API do Processo Online Crédito Consumo
data.metadataDeserializado.endpointEstoqueConsultaStringUtilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
data.metadataDeserializado.endpointIdentificadorPDVStringUtilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDV
data.metadataDeserializado.endpointNotaEntradaEnvioStringUtilizado para informar o endpoint da API do Processo Online Nota de Entrada
data.metadataDeserializado.endpointNotaSaidaEnvioStringUtilizado para informar o endpoint da API do Processo Online Nota de Saída Envio 
data.metadataDeserializado.endpointPreVendaAtualizaStringUtilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
data.metadataDeserializado.endpointPreVendaConsultaListaPedidoStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
data.metadataDeserializado.endpointPreVendaConsultaPedidoStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
data.metadataDeserializado.endpointPreVendaEnvioStringUtilizado para informar o endpoint da API do Processo Online Pre Venda Envio
data.metadataDeserializado.endpointReservaEstoqueEnvioStringUtilizado para informar o endpoint da API do Processo Online Reserva de Estoque
data.metadataDeserializado.endpointTokenStringEndpoint responsável por gerar o Token de autenticação da API do Retaguarda
data.metadataDeserializado.endpointNotificaRetaguardaNovaLojaStringUtilizado para informar o endpoint da API do Processo Online Notifica Retaguarda Nova Loja
data.metadataDeserializado.horariosExecucaoVendaConsolidadaStringUtilizado para informar os horários que serão enviados as Vendas Consolidadas para os servidores do POSH
data.metadataDeserializado.ipDinamicoBooleanoUtilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
data.metadataDeserializado.loginStringUsuário utilizado na autenticação da API do Retaguarda
data.metadataDeserializado.maximoTentativasInteiroQuantidade máxima de tentativas
data.metadataDeserializado.passwordStringSenha utilizada na autenticação da API do Retaguarda
data.metadataDeserializado.portaRetaguardaInteiroUtilizado para informar a Porta utilizada para acessar a API da Retaguarda
data.metadataDeserializado.protocoloHttpRetaguardaStringUtilizado para informar o protocolo de comunicação utilizado na API do Retaguarda
data.metadataDeserializado.retaguardaStringUtilizado para informar qual Retaguarda está sendo utilizado pelo inquilino.
data.metadataDeserializado.tempoMonitoraStatusInteiroUtilizado para informar o tempo de monitoramento de status.
data.metadataDeserializado.tempoMonitoraStatusVendaInteiroUtilizado para informar o tempo de monitoramento de status de venda.
data.metadataDeserializado.tipoAutenticacaoInteiroDetermina o tipo de autenticação utilizado na API do Retaguarda.
data.metadataDeserializado.urlBuscaIPDinamicoStringUtilizado para informar a API responsável por recuperar dinamicamente o IP das APIs do Retaguarda
data.metadataDeserializado.urlRetaguardaStringUtilizado pra informar a URL das APIs do Retaguarda
data.metadataDeserializado.versaoApiInteiroUtilizado para indicar a versão das APIs do POSH utilizada
data.urlRetaguardaFormatadaStringURL Formatada do Retaguarda
data.cnpjStringCNPJ da Empresa/Cliente
data.codigoTStringCódigo TOTVS de Licenciamento
data.particionadoBooleanoUtiliza registros particionados (True: Sim/False: Não) (Utilizado apenas para V3)
data.particaoString
data.versaoPdvSyncClientStringUtilizado para informar qual versão do PDV Omni e do POSH Client o cliente está utilizando
data.idInquilinoStringCódigo de Identificação do Inquilino (Gerado automáticamente)
data.dataAtualizacaoData/HoraData de Atualização do Registro
data.dataCadastroData/HoraData de Cadastro do Registro
data.idInteiroCódigo Inteiro de Identificação do Inquilino

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