Árvore de páginas

Versões comparadas

Chave

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

...

IMPORTANTE: O POSH tem rotinas de expurgo de dados que rodam automaticamente todos os dias, os dados ficam nos serviços do POSH por 14 dias corridos, depois disso não há como recuperar as informações dos lotes.

Expandirinfo
titleMonitoramento Monitoria Lote Externo
Expandir
titleDetalhamento

O monitoramento do lote externo é feito pelas apis do PDVSync.Core.Controle.

Nesse endpoint teremos algumas informações muito importante com relação ao lote aberto pela retaguarda.

  • Endpoint: /api/retaguarda/v2/inquilinolotesexternos/{id lote externo}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Nesse endpoint um dos dados mais importantes é o status, ele indica se o lote prosseguiu para o próximo passo ou se ele foi barrado por algum motivo.

Expandir
titleRetorno da requisição
{
    "success":true,
    "message":"",
    "data":{
        "loteOrigem":"string",
        "mensagem":"string",
        "status":int,
        "tipoLote":[
            "string"
        ],
        "idInquilino":"string",
        "dataAtualizacao":"datetime",
        "dataCadastro":"datetime",
        "id":"string",
        "_expandables":[]
    }
} Expandir
titleDefinição dos campos de retorno

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi realizada com sucessoMessagestringCaso ocorra erros durante a criação do lote eles serão enviados nesse campoDataobjetoObjeto lote externo

Data.LoteOrigem

stringNúmero de identificação do lote

Data.Mensagem

stringMensagem enviada no cadastro do lote

Data.Status

intStatus do lote (Definições na seção abaixo)Data.TipoLoteList StringLista de tipos de dados que serão enviados no lote

Data.IdInquilino

stringidInquilino vinculado ao lote

Data.DataAtualização

datetimeData da ultima atualização do registo

Data.DataCadastro

datetimeData de criação do lote

Data.Id

stringIdentificador do lote no banco Expandir
titleStatus do lote
CódigoNomeDescrição0InicioEnvioIndica que o lote foi aberto pela retaguarda e está sendo enviado os dados para o lote.1FimEnvioIndica que a retaguarda fechou o lote para iniciar o processamento do lote.2ValidadoOKIndica que o POSH validou os dados e criou os loja lotes para baixa3ValidadoErroIndica que ocorreu algum erro no processo e não foram criado os loja lotes. O erro mais comum nesse caso é o POSH não encontra os dados q foram enviados.4ProcessandoIndica que o POSH está processando o lote

Para saber informações sobre o lote externo, será necessário fazer um requisição GET para o inquilinolotesexternos, para saber mais sobre essa requisição clique aqui

O monitoramento do loja lote é feito pelas apis do PDVSync.Core.Controle.

Nesse endpoint temos informações com relação aos loja lotes, informações como:

  • Quais itens deram problema na baixa? Por quê?
  • Quais lojas baixaram os dados? Quais não iniciaram a baixa?

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

  • Endpoint: /api/retaguarda/v2/LojaLoteStatusRetorno/{id lote externo}?{parâmetros}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

Os parâmetros opcionais funcionam como um filtro de dados, caso estejam preenchidos ele trará somente os dados relacionados ao filtro.

Informações
titleMonitoria Loja Lote

Para saber informações sobre o loja lote, será necessário fazer um requisição GET para o LojaLoteStatusRetorno, para saber mais sobre essa requisição clique aqui

Expandir
titleMonitoramento Loja Lote
Expandir
titleDetalhamento
ParametroDescriçãoTipoObservação
inquilinoId inquilino do loja lotestringObrigatório
loteorigemLote origem que será buscado o statusstringObrigatório
idRetaguardaLojaId retaguarda da loja que será buscado o statusstringOpcional
tipoLoteTipo do lote que será buscado o statusintOpcional
Expandir
titleRetorno da requisição

{
    "success": bool,
    "message": "string",
    "data": {
        "lote": "string",
        "loteOrigem": "string",
        "lojaLotes": [
            {
                "status": int,
                "errosIdentificados": [
                    {
                        "tipoLote": int,
                        "idRetaguarda": "string",
                        "erro": "string",
                        "tipoLojaLote": int
                    }
                ],
                "idRetaguardaLoja": "string",
                "idInquilino": "string",
                "dataAtualizacao": "datetime",
                "dataCadastro": "datetime",
                "id": int
            }
        ],
        "pagina": int,
        "hasnext": bool
    }
}

Expandir
titleDefinição dos campos de retorno

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucessoMessagestring

Mensagem de erro retornada 

DataobjetoObjeto de retorno

Data.Lote

stringNúmero de identificação do lojaLote

Data.Loteorigem

stringNúmero de identificação do loteData.Lojaloteslista de objetosLista com os loja lotesData.Lojalotes.StatusintIndica o status em que o loja lote se encontra. (Definição dos status na seção abaixo)Data.Lojalotes.Errosidentificadoslista de objetosLista com o erros identificados na integração do loja lote

Data.Lojalotes.Errosidentificados.Tipolote

intIndica o tipo do loteData.Lojalotes.Errosidentificados.IdretaguardastringId retaguarda do itemData.Lojalotes.Errosidentificados.Erro

string

Erro ocorrido com o itemData.Lojalotes.ErrosidentificadosTipolojaloteintIndio o tipo do loja lote do itemData.IdretaguardalojastringId retaguada da loja proprietária do loteData.IdinquilinostringIdentificação do inquilinoData.Dataatualizacaodatetimedata de atualização do loja loteData.Datacadastrodatetimedata de cadastro do loja loteData.IdintId do loja lotePaginaintIndica em qual página está os dadosHasnextboolIndica se há mais páginas de dados Expandir
titleStatus do loja lote
CódigoNomeDescrição0EmPreparacao

Indica que o POSH está criando o loja lote

1EmProcessamentoIndica que o POSH está validando o loja lote2DisponivelIndica que o loja lote está disponível para a baixa pelo PDV Omni3IndisponivelIndica que o loja lote está indisponível para baixa pelo PDV Omni4EmProcessoDeBaixaIndica que o loja lote está sendo baixado pelo PDV Omni5BaixadoComSucessoIndica que todos os dados enviados para o loja lote foram integrados com sucesso ao PDV Omni6BaixadoComErroIndica que ao menos um item deu erro na integração com o PDV Omni7EnviadoComSucessoIndica que o loja lote foi envidado com sucesso para a retaguarda8EnviadoComErroIndica que o loja lote não foi enviado com sucesso para a retaguarda9ComProblemaVerificarIndica que ocorreu alguma problema com o loja lote e deve-se verificar