Este método é responsável pela consulta de lojas disponíveis na retaguarda. Ao realizarmos uma requisição na API de lojas, será gerada uma consulta com todos os dados da loja.
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/retaguardapdvsyncclient/v2/LojaLoteStatusRetornolojas/{id lote externoCNPJ}?/{parâmetrosCodigoIdentificacaoLoja}
- 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:
| Parametro | Descrição | Tipo | Observação |
|---|
| inquilino | Id inquilino do loja lote | string | Obrigatório |
loteorigem | Lote origem que será buscado o status| CNPJ | CNPJ da loja que será buscada | string | Obrigatório |
idRetaguardaLoja | Id retaguarda da loja que será buscado o status| CodigoIdentificacaoLoja | Código de identificação de loja | 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.
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| Campo | Tipo | Descrição |
|---|
| success | Booleano | Indica se a requisição deu sucesso | | message | String | Mensagem de retorno | | data | Objeto | Objeto retornado | | data.idRetaguarda | String | Identificador da retaguarda | | data.razaoSocial | String | Razão social | | data.nomeFantasia | String | Nome fantasia | | data.cnpj | String | CNPJ | | data.codigoIdentificacaoLoja | String | Código de identificação da loja | | data.situacao | Inteiro | Situação da loja | | data.modeloFiscal | Inteiro | Modelo fiscal | | data.regimeTributario | Inteiro | Regime tributário | | data.numeroLoja | String | Número da loja | | data.tenantId | String | Identificador do tenant | | data.statusLicenciamento | Inteiro | Status do licenciamento | | data.idInquilino | String | Identificador do inquilino | | data.dataAtualizacao | Data/Hora | Ultima data de atualização da loja | | data.dataCadastro | Data/Hora | Data de cadastro da loja | | data.id | String | Identificador da loja no POSH | | errors | Lista | Lista de erros | | totalTime | Inteiro | Tempo de busca | | numberOfRecords | Inteiro | Numero de linhas |
| Expandir |
|---|
| title | Retorno da requisição |
|---|
| {
"success": |
|
booltrue,
"message": "string",
"data": {
" |
|
loteidRetaguarda": "string",
" |
|
loteOrigemrazaoSocial": "string",
" |
|
lojaLotes [ {
statuscodigoIdentificacaoLoja": |
|
int errosIdentificados [ {
"tipoLote": int,
idRetaguarda "string" "erro "tipoLojaLote": int
}
],
idRetaguardaLoja "string" "dataAtualizacao": "datetime",
|
|
"dataCadastro": "datetime",
|
|
int"1",
"_expandables": []
},
|
|
] pagina int hasnext bool
}
} |
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a requisição foi feita com sucesso |
| Message | string | Mensagem de erro retornada |
| Data | objeto | Objeto de retorno |
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 de objetos | 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 |
| Expandir |
|---|
|
|
| Código | Nome | Descrição |
|---|
| 0 | EmPreparacao | Indica que o POSH está criando o loja lote |
| 1 | EmProcessamento | Indica que o POSH está validando o loja lote |
| 2 | Disponivel | Indica que o loja lote está disponível para a baixa pelo PDV Omni |
| 3 | Indisponivel | Indica que o loja lote está indisponível para baixa pelo PDV Omni |
| 4 | EmProcessoDeBaixa | Indica que o loja lote está sendo baixado pelo PDV Omni |
| 5 | BaixadoComSucesso | Indica que todos os dados enviados para o loja lote foram integrados com sucesso ao PDV Omni |
| 6 | BaixadoComErro | Indica que ao menos um item deu erro na integração com o PDV Omni |
| 7 | EnviadoComSucesso | Indica que o loja lote foi envidado com sucesso para a retaguarda |
| 8 | EnviadoComErro | Indica que o loja lote não foi enviado com sucesso para a retaguarda |
9 | ComProblemaVerificar | Indica que ocorreu alguma problema com o loja lote e deve-se verificar
