Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela consulta de estoque

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?

...


  • Endpoint: /api/retaguarda/v2/LojaLoteStatusRetornoProcessoOnlineEstoqueSaldo/{idInquilino}/{idProdutoRetaguarda}/{idLojaOrigemRetaguarda}/{id lote externoidLojasConsultaEstoqueRetaguarda}?/{parâmetrosidProdutoEmbalagemRetaguarda}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda Client

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

ParametroDescriçãoTipoObservaçãoObrigatório
inquilino
Id inquilino do loja lote
Identificador do inquilinostring
S
idProdutoRetaguardaIdentificador do produto na retaguardastring
S
idLojaOrigemRetaguardaIdentificador da loja de consultante do saldostring
Obrigatório

S
loteorigemLote origem que será buscado o statusstringObrigatórioidRetaguardaLojaId retaguarda da loja que será buscado o statusstringOpcionaltipoLoteTipo 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.

idLojasConsultaEstoqueRetaguardaIdentificador das lojas para consulta do estoquestring

Pode ser passar mais de um valor separando-os por vírgula (,)

N

idProdutoEmbalagemRetaguardaIdentificador da embalagemstringPode ser passar mais de um valor separando-os por vírgula (,)N

Retornos

Retorno da requisiçãoexpandDefinição dos campos de retornoIndica que ocorreu alguma problema com o loja lote e deve-se verificar
Deck of Cards
idProcessoOnlineEstoqueSaldoDC
Card
label200 - OK

Campo

Tipo

Descrição

successBooleanoIndica se a requisição retornou sucesso
messageStringCampo com as mensagens de erro
dataLista de ObjetosConteúdo de retorno
data.estoqueLista de ObjetosLista de estoques
data.estoque.armazemObjetoObjeto armazem
data.estoque.armazem.idStringIdentificador do armazem
data.estoque.armazem.descricaoStringdescrição do armazem
data.estoque.lojaObjetoObjeto loja
data.estoque.loja.enderecoStringEndereço da loja
data.estoque.loja.idRetaguardaStringIdentificador da loja na retaguarda
data.estoque.loja.descricaoStringDescrição da loja
data.estoque.quantidadeDecimalQuantidade em estoque
data.idRetaguardaProdutoStringIdentificador do produto na retaguarda
errorsNuloLista com erros
totalTimeInteiroTempo de requisição
numberOfRecordsInteiroNúmero de linhas retornadas
Expandir
title


{
    "success":

bool

true,
    "message": "

string

",
    "data": [
        {
            "

lote

estoque":

"string",

[
       

"loteOrigem": "string",

        {
                    "

lojaLotes

armazem":

[

{

   

       

{

                "

status

id":

int

"string",
                        "

errosIdentificados

descricao":

[

"string"
                   

{

},

   

                    "

tipoLote

loja":

int,

{
                        "

idRetaguarda

endereco": "string",
                        "

erro

idRetaguarda": "string",
                        "

tipoLojaLote

descricao":

int

"string"
                    },

 

             

],

     

         

"

idRetaguardaLoja

quantidade":

"string",

0.0
               

"idInquilino": "string",

}
           

    "dataAtualizacao": "datetime"

],
           

   

"

dataCadastro

idRetaguardaProduto": "

datetime",
                "id": int
 

string"
       

 

}
   

   

],

   

    "

pagina

errors":

int

null,
   

   

"

hasnext

totalTime":

bool

0,
   

}

"numberOfRecords": 0
}

Card
title
label400 - Bad Request

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de
erro retornada 
erros
Data
objeto
ObjetoObjeto 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

ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


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

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