Árvore de páginas

Versões comparadas

Chave

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

...

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

O endpoint recebe uma lista de vendas para que seja possivel enviar várias na mesma requisição


[
Expandir
titleExemplo de body da requisição

    {
        "idMensagemid": "string"0,
        "observacaonumeroRegistrosConfirmados": "string"0,
        "status": 0,
    }
]"observacao": "string"
}

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

idMensagemIdStringIntCódigo do Id do Dado ConsolidadoIdentificador da venda no POSHObrigatório
observacaoNumeroRegistrosConfirmadosStringObservação enviada pela retaguarda

Opcional

IntNúmero de registros confirmados pelo retaguarda no recebimentoObrigatório
StatusstatusIntStatus da venda (Definições abaixoConfirmação do Dado ConsolidadoObrigatório
ObservaçãoStringObservação (Pode ser usado como Log)Opcional
Expandir
titleStatus
CódigoStatusDescrição
0ProcessarPendentePendente consumo pela retaguardade Confirmação do Retaguarda
1ProcessadaConfirmado com SucessoConfirmado com Sucesso pelo RetaguardaConsumido pela retaguarda
2Confirmado com ErroConsumido com erro pela retaguarda
3ReprocessarPara reprocessar
4IntegradoComSucessoIntegrado com sucesso pela retaguardaConfirmado com Erro pelo Retaguarda
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação atualização do compartilhamento dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a criação atualização do compartilhamento dado consolidado eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criadodado consolidado atualizado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo Tempo da requisição
NumberOfRecordsintnúmero Número de dados inseridos
Expandir
titleBody de retorno

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

Expandir
title400 - Bad Request

Campo

Tipo

Descrição

SuccessboolIndica se a criação atualização do compartilhamento dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a criação atualização do compartilhamento dado consolidado eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criadodado consolidado atualizado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo Tempo da requisição
NumberOfRecordsintnúmero Número de dados inseridos
Expandir
titleBody de retorno

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