TOTVS Varejo PDV Omni

Árvore de páginas

API responsável por alterar o status do dado consolidado

Para acessar os dados a requisição é a seguinte

  • Endpoint: /api/retaguarda/v2/dadoConsolidados
  • Método: PUT
  • Autenticação: Bearer token
  • Permissão: Retaguarda

O endpoint recebe uma lista de dados consolidados para que seja possivel confirmar vários registros na mesma requisição.

[

     {
          "idMensagem": "0",
          "numeroRegistrosConfirmados": 0,
          "status": 0,
          "observacao": "string"
     }

]

Campo

Tipo

Descrição

Observações

IdMensagemIntCódigo do Id do Dado ConsolidadoObrigatório
NumeroRegistrosConfirmadosIntNúmero de registros confirmados pelo retaguarda no recebimentoObrigatório
StatusIntStatus da Confirmação do Dado ConsolidadoObrigatório
ObservaçãoStringObservação (Pode ser usado como Log)Opcional
CódigoStatusDescrição
0PendentePendente de Confirmação do Retaguarda
1Confirmado com SucessoConfirmado com Sucesso pelo Retaguarda
2Confirmado com ErroConfirmado com Erro pelo Retaguarda

Campo

Tipo

Descrição

SuccessboolIndica se a atualização do dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a atualização do dado consolidado eles serão enviados nesse campo
DataobjetoObjeto dado consolidado atualizado
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
}

Campo

Tipo

Descrição

SuccessboolIndica se a atualização do dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a atualização do dado consolidado eles serão enviados nesse campo
DataobjetoObjeto dado consolidado atualizado
ErrorsListaListas com os erros encontrados no processo
TotalTimeintTempo da requisição
NumberOfRecordsintNúmero de dados inseridos

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

  • Sem rótulos