Histórico da Página

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 lote	string	Obrigatório
loteorigem	Lote origem que será buscado o status	string	Obrigatório
idRetaguardaLoja	Id retaguarda da loja que será buscado o status	string	Opcional
tipoLote	Tipo do lote que será buscado o status	int	Opcional

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

title	Retorno da requisição

Deck of Cards

id	credito_consulta_get

Card

label	200 - OK

Campo

Tipo

Descrição

Campo

Tipo

Indica se a requisição foi feita com sucesso

Success

Booleano

Mensagem de retorno de erros

Message

String

Lista com os créditos retornados

Data

Lista de Objetos

Lista de objetos de retorno

Data.Lote

String

Número do lote

Data.LoteOrigem

String

Número do lote origem

Data.Status

Inteiro

Status do lote

Data.IdOrigem

String

Identificador da origem

Data.ErrosIdentificados

Lista de Objetos

Lista de erros

Data.ErrosIdentificados.TipoLote

Inteiro

Tipo do lote

Data.ErrosIdentificados.IdRetaguarda

String

Identificador do lote na retaguarda

Data.ErrosIdentificados.Erro

String

Identificador do erro

Data.ErrosIdentificados.TipoLojaLote

Inteiro

Identificador do tipo loja lote

Data.ErrosIdentificados.Pagina

Inteiro

Número da página

Data.ErrosIdentificados.Hasnext

Booleano

Indica se há mais páginas

Data.IdRetaguardaLoja

String

Identificador da loja na retaguarda

Data.IdInquilino

String

Identificador do inquilino

Data.DataAtualizacao

Datetime

Data de atualização

Data.DataCadastro

Datetime

Data de cadastro

Data.Id

String

Identificador do loja lote

Errors

Objeto

Lista de erros

TotalTime

Inteiro

Tempo total da requisição

NumberOfRecords

Inteiro

Número de registros

400 - Bad Request

Expandir

title	Definição dos campos de retorno

label

Campo	Tipo	Descrição

Observação


Success	bool	Indica se a requisição foi feita com sucesso
Message	string	Mensagem de erro retornada
Data

Objeto

objeto

Objeto de retorno

Errors


Data.Lote	string	Número de identificação do lojaLote
Data.Loteorigem	string	Número de identificação do lote
Data.Lojalotes	lista de objetos	Lista com os loja lotes
Data.Lojalotes.Status	int	Indica o status em que o loja lote se encontra. (Definição dos status na seção abaixo)
Data.Lojalotes.Errosidentificados	lista

com o erros identificados na integração do loja lote
Data.Lojalotes.Errosidentificados.Tipolote	int	Indica o tipo do lote
Data.Lojalotes.Errosidentificados.Idretaguarda	string	Id retaguarda do item
Data.Lojalotes.Errosidentificados.Erro	string	Erro ocorrido com o item
Data.Lojalotes.ErrosidentificadosTipolojalote	int	Indio o tipo do loja lote do item
Data.Idretaguardaloja	string	Id retaguada da loja proprietária do lote
Data.Idinquilino	string	Identificação do inquilino
Data.Dataatualizacao	datetime	data de atualização do loja lote
Data.Datacadastro	datetime	data de cadastro do loja lote
Data.Id	int	Id do loja lote
Pagina	int	Indica em qual página está os dados
Hasnext	bool	Indica se há mais páginas de dados

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Retornos