| Informações |
|---|
| Endpoint responsável pelo retorno do status |
...
...
- 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/LojaLoteStatusRetornolojaloteretornos/{id lote externoIdInquilino}?/{parâmetrosLoteOrigem}
- 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:
Os parâmetros para a requisição estão abaixo
ParametroTipoObservaçãoinquilino| 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.
| Identificador do Inquilino | Obrigatório |
| IdRetaguardaLoja | string | Identificador da loja na retaguarda | Obrigatório |
Retornos
| Deck of Cards |
|---|
|
| Expandir |
|---|
| title | Retorno da requisição |
|---|
|
| Card |
|---|
| 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 |
|
|
booltrue,
"message": "string",
"data": [
{
"lote": "string",
"loteOrigem": "string",
" |
lojaLotes [
{
status int int "idRetaguarda": "string",
|
"erro": "string",
"tipoLojaLote": 0,
" |
tipoLojaLote int }
"idRetaguardaLoja": "string",
|
datetime2024-06-20T15:40:31.700Z",
|
datetime2024-06-20T15:40:31.700Z",
|
int pagina int hasnext bool } |
expand | title | Definição dos campos de retorno | Campo | Tipo | Descrição | Observação |
|---|
Success | bool | Indica se a requisição foi feita com sucesso |
|
|
|---|
| Message | string | Mensagem de erro retornada |
objetoData.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 |
|---|
|
| | Errors | Lista de objetos | Lista de erros | Somente é retornado na V3 | | Message | string | Mensagem de retorno de erros |
| | NumberOfRecords | Int | Número de registros |
| | TotalTime | Int | Tempo total da requisição |
|
{
"success": false,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
|
| 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
