TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 3

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Danilo Rodrigues dos Santos

Gravado em

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/lojaloteretornosLojaLoteStatusRetorno/{IdInquilinoid lote externo}/?{LoteOrigemparâmetros}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Os parâmetros para a requisição estão abaixo

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

Parametro

Campo

Tipo
Descrição
Observações
Tipo
IdInquilino
Observação
string
inquilino
Identificador do InquilinoObrigatórioIdRetaguardaLojastringIdentificador da loja na retaguarda

Obrigatório

Retornos

Id 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

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

{
    "success":

true

bool,
    "message": "string",
    "data":

[
       

{

   

        "lote": "string",
       

   

"loteOrigem": "string",
       

   

"

status

lojaLotes":

0,

[
            {
                "

idOrigem

status":

"string"

int,
                "errosIdentificados": [
                    {
                        "tipoLote":

0

int,
                        "idRetaguarda": "string",
                        "erro": "string",
                   

"tipoLojaLote": 0,
       

   

       

"

pagina

tipoLojaLote":

0,

int
                   

"hasnext": true

}
               

}

],
           

],

   

       

"idRetaguardaLoja": "string",
                "idInquilino": "string",
                "dataAtualizacao": "

2024-06-20T15:40:31.700Z

datetime",
                "dataCadastro": "

2024-06-20T15:40:31.700Z

datetime",
                "id":

"string"

int
            }
        ],
        "

errors

pagina":

{}

int,
        "

totalTime

hasnext":

0,

bool
   

"numberOfRecords": 0

}
}

card
Expandir
titleRetorno da requisição
Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

CampoTipoIndica se a requisição foi feita com sucesso
SuccessBooleanoMensagem de retorno de erros
MessageStringLista com os créditos retornados
DataLista de ObjetosLista de objetos de retorno
Data.LoteStringNúmero do lote
Data.LoteOrigemStringNúmero do lote origem
Data.StatusInteiroStatus do lote
Data.IdOrigemStringIdentificador da origem
Data.ErrosIdentificadosLista de ObjetosLista de erros 
Data.ErrosIdentificados.TipoLoteInteiroTipo do lote
Data.ErrosIdentificados.IdRetaguardaStringIdentificador do lote na retaguarda
Data.ErrosIdentificados.ErroStringIdentificador do erro
Data.ErrosIdentificados.TipoLojaLoteInteiroIdentificador do tipo loja lote
Data.ErrosIdentificados.PaginaInteiroNúmero da página
Data.ErrosIdentificados.HasnextBooleanoIndica se há mais páginas
Data.IdRetaguardaLojaStringIdentificador da loja na retaguarda
Data.IdInquilinoStringIdentificador do inquilino
Data.DataAtualizacaoDatetimeData de atualização
Data.DataCadastroDatetimeData de cadastro
Data.IdStringIdentificador do loja lote
ErrorsObjetoLista de erros
TotalTimeInteiroTempo total da requisição
NumberOfRecordsInteiroNúmero de registros
400 - Bad Request
Expandir
titleDefinição dos campos de retorno
label

Campo

Tipo

Descrição

Observação

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

Mensagem de erro retornada 

Data
Objeto
objetoObjeto de retorno
Errors

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
Lista
de objetosLista
de errosSomente é retornado na V3MessagestringMensagem de retorno de errosNumberOfRecordsIntNúmero de registrosTotalTimeIntTempo total da requisição{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}
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.ErrosidentificadosTipolojaloteintIndica 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
9ComProblemaVerificarIndica que ocorreu alguma problema com o loja lote e deve-se verificar