Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este método é responsável pela busca dos cliente enviados pelo TOTVS Varejo PDV Omni

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

  • Método: Post
  • 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
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleBody do retorno

{
  "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
Expandir
title400 - Bad Request

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