TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela atualização de status do cliente mensagem

  • Endpoint:

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

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

Pode-se passar uma lista de de status

[
  {
    "idMensagem": 1117,
    "status": 1
  }
]

Campo

Tipo

Descrição

Observações

idMensagemStringIdentificador do cliente no banco de dados do POSH

Obrigatório

statusIntStatus do cliente (Descritivo abaixo)

Opcional

CódigoStatus
0Pendente consumo da retaguarda
1Consumido pela retaguarda
2Consumido com erro pela retaguarda
4Integrado com sucesso pela retaguarda
5Venda reenviada. Integrado com sucesso pela retaguarda

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 Alterado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

{
    "success": true,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

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