Ir para o conteúdo principal

LojaReservaEntrada (STATUS: DOCUMENTADO)

Documentação Técnica
Nome do clienteOSKLEN
Nome do projetoIntegração LINX → ILLI (Reserva Entrada)
Bibliotecawosk_loja_reserva_entrada
Data26/03/2026

Histórico de Versões
DataVersãoModificado porDescrição da Mudança
26/03/20261.0Maykon/GustavoCriação da documentação técnica do processo Loja Reserva Entrada (LINX).

Descrição

Este serviço de retorno de reserva (entrada) recebe dados pelo endpoint, valida produtos quando informados e atualiza reserva e itens no LINX quando a natureza de operação corresponde ao fluxo de retorno.
Não há envio ao ILLI no arquivo analisado; a persistência ocorre em LOJA_RESERVA e LOJA_RESERVA_PRODUTO.

Endpoint (API)

O endpoint valida o payload, resolve FILIAL via FILIAIS, exige NATUREZA_OPERACAO_CODIGO e, para o código configurado para retorno de reserva (entrada), executa atualização em LOJA_RESERVA e zera quantidades e valores nos itens de LOJA_RESERVA_PRODUTO conforme o método interno analisado.

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/c3ae9fe6-81b8-4b84-a5a2-93364cfee98d/wosk_loja_reserva_entrada
  • Método HTTP: POST
Estruturação de Dados
Campos relevantes do fluxo principal
CampoTipoObrigatórioDescrição
keystringnãoChave de API quando exigida pela plataforma.
COD_FILIALstringsimFilial (resolvida em FILIAIS).
NATUREZA_OPERACAO_CODIGOstringsimNatureza; valor 1913 aciona o fluxo de retorno de reserva.
NUMEROstringcondicionalNúmero da reserva (saída) para o fluxo de retorno.
INSUMOstringnãoNão deve ser informado no fluxo de retorno de reserva.
PRODUTOSarraycondicionalQuando informado, validado via serviço de produtos da venda.

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "<API_KEY_SE_APLICAVEL>",
  "COD_FILIAL": "000001",
  "NATUREZA_OPERACAO_CODIGO": "1913",
  "NUMERO": "<NUMERO_RESERVA>",
  "PRODUTOS": []
}
Tratamento de Dados

Para o fluxo de retorno: atualização parametrizada em LOJA_RESERVA e recálculo/zeragem de campos de quantidade, preço e grades (EN1 a EN48) em LOJA_RESERVA_PRODUTO por item, com nova DATA_PARA_TRANSFERENCIA nos itens.

Tratamento de retorno

Sucesso: Mensagem OK e mensagem detalhada de sucesso. Falha: ERROR com texto da exceção (validação, filial, natureza, insumo indevido, reserva não encontrada, etc.).

Fluxo do Processo

Diagrama do processo


Critérios de Aceitação
ProcessoSubprocessoDescriçãoSituação esperada
Endpoint (API)Retorno de reservaCom natureza 1913, deve localizar reserva e atualizar cabeçalho e itens sem insumo.Registros atualizados no LINX ou erro documentado.