Árvore de páginas

Versões comparadas

Chave

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

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/LojaLoteStatusRetornolojas/{id lote externoCNPJ}?/{parâmetrosCodigoIdentificacaoLoja}
  • 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:

ParametroDescriçãoTipoObservação
inquilinoId inquilino do loja lotestringObrigatórioloteorigemLote origem que será buscado o status
CNPJCNPJ da loja que será buscadastringObrigatório
idRetaguardaLojaId retaguarda da loja que será buscado o status
CodigoIdentificacaoLojaCódigo de identificação de loja stringOpcional
tipoLote
Tipo do lote que será buscado o statusintOpcional

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


Indica que ocorreu alguma problema com o loja lote e deve-se verificar
Expandir
titleDefinição dos campos de retorno
Expandir
title200 OK

Campo

Tipo

Descrição

successBooleanoIndica se a requisição deu sucesso
messageStringMensagem de retorno 
dataObjetoObjeto retornado
data.idRetaguardaStringIdentificador da retaguarda
data.razaoSocialStringRazão social
data.nomeFantasiaStringNome fantasia
data.cnpjStringCNPJ
data.codigoIdentificacaoLojaStringCódigo de identificação da loja
data.situacaoInteiroSituação da loja
data.modeloFiscalInteiroModelo fiscal
data.regimeTributarioInteiroRegime tributário
data.numeroLojaStringNúmero da loja
data.tenantIdStringIdentificador do tenant
data.statusLicenciamentoInteiroStatus do licenciamento
data.idInquilinoStringIdentificador do inquilino
data.dataAtualizacaoData/HoraUltima data de atualização da loja
data.dataCadastroData/HoraData de cadastro da loja
data.idStringIdentificador da loja no POSH
errorsListaLista de erros
totalTimeInteiroTempo de busca
numberOfRecordsInteiroNumero de linhas
Expandir
titleRetorno da requisição

{
    "success":

bool

true,
    "message": "string",
    "data": {
        "

lote

idRetaguarda": "string",
        "

loteOrigem

razaoSocial": "string",
        "

lojaLotes

nomeFantasia":

[

"string",
       

    {

"cnpj": "string",
       

       

"

status

codigoIdentificacaoLoja":

int

"string",

       

        "

errosIdentificados

situacao":

[
                    {
             

1,
       

 

"

tipoLote

modeloFiscal":

int

0,

               

        "

idRetaguarda

regimeTributario":

"string"

0,

         

       

     

"

erro

numeroLoja": "string",

               

        "

tipoLojaLote": int
                    }
                ]

tenantId": null,
       

       

"

idRetaguardaLoja

statusLicenciamento":

"string"

0,

       

        "idInquilino": "string",

   

       

   

"dataAtualizacao": "datetime",

       

        "dataCadastro": "datetime",

   

       

   

"id":

int

"1",
        "_expandables": []
    },
   

    ]

"errors": null,

   

    "

pagina

totalTime":

int

0,

   

    "

hasnext

numberOfRecords":

bool
    }
}
Expandir
titleDefinição dos campos de retorno

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
Messagestring

Mensagem de erro retornada 

DataobjetoObjeto de retorno

Data.Lote

stringNúmero de identificação do lojaLote

Data.Loteorigem

stringNúmero de identificação do lote
Data.Lojaloteslista de objetosLista com os loja lotes
Data.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 lote
Data.Lojalotes.Errosidentificados.IdretaguardastringId retaguarda do item
Data.Lojalotes.Errosidentificados.Erro

string

Erro ocorrido com o item
Data.Lojalotes.ErrosidentificadosTipolojaloteintIndio o tipo do loja lote do item
Data.IdretaguardalojastringId retaguada da loja proprietária do lote
Data.IdinquilinostringIdentificação do inquilino
Data.Dataatualizacaodatetimedata de atualização do loja lote
Data.Datacadastrodatetimedata de cadastro do loja lote
Data.IdintId do loja lote
PaginaintIndica em qual página está os dados
HasnextboolIndica se há mais páginas de dados
Expandir
titleStatus do loja lote
CódigoNomeDescrição
0EmPreparacao

Indica que o POSH está criando o loja lote

1EmProcessamentoIndica que o POSH está validando o loja lote
2DisponivelIndica que o loja lote está disponível para a baixa pelo PDV Omni
3IndisponivelIndica que o loja lote está indisponível para baixa pelo PDV Omni
4EmProcessoDeBaixaIndica que o loja lote está sendo baixado pelo PDV Omni
5BaixadoComSucessoIndica que todos os dados enviados para o loja lote foram integrados com sucesso ao PDV Omni
6BaixadoComErroIndica que ao menos um item deu erro na integração com o PDV Omni
7EnviadoComSucessoIndica que o loja lote foi envidado com sucesso para a retaguarda
8EnviadoComErroIndica que o loja lote não foi enviado com sucesso para a retaguarda
9ComProblemaVerificar

0
}