Ir para o conteúdo principal

LojaReservaSaida (STATUS: DOCUMENTADO)

Documentação Técnica
Nome do cliente OSKLEN
Nome do projeto Integração LINX → ILLI (Reserva Saída)
Biblioteca wosk_loja_reserva_saida
Data 26/03/2026

Histórico de Versões
Data Versão Modificado por Descrição da Mudança
26/03/2026 1.0 Maykon/Gustavo Criação da documentação técnica do processo Loja Reserva Saída (LINX).

Descrição

Este serviço de reserva de saída e movimentos relacionados recebe o payload pelo endpoint, valida produtos quando informados, resolve filial e loja e ramifica o processamento conforme a natureza de operação.
Inclui fluxos de reserva (saída), retirada de uniforme e demais ramos definidos no código, com persistência em LOJA_RESERVA, LOJA_SAIDAS, LOJA_SAIDAS_PRODUTO e tabelas associadas.

Endpoint (API)

O endpoint aplica validação base, validação de produtos quando PRODUTOS vem preenchido, resolve FILIAL, COD_CLIFOR e dados em LOJAS_VAREJO, e executa o ramo conforme NATUREZA_OPERACAO_CODIGO (ex.: 5912 para reserva de saída com montagem de itens por tamanho; códigos 5910, 5910 U, 6910, 6910 U para saída tipo uniforme; outros ramos conforme implementação no arquivo-fonte).

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/e831c4ce-6bc9-4cdc-900f-1ee4427a830a/wosk_loja_reserva_saida
  • Método HTTP: POST
 
Estruturação de Dados
Campos de alto nível
Campo Tipo Obrigatório Descrição
key string não Chave de API quando exigida pela plataforma.
COD_FILIAL string sim Filial (via FILIAIS).
NATUREZA_OPERACAO_CODIGO string sim Seleciona o ramo de reserva ou saída.
NUMERO string condicional Pode ser gerado por sequência quando vazio conforme regra.
PRODUTOS array condicional Itens com PRODUTO, COR_PRODUTO, TAMANHO, QTDE, PRECO, etc.
INSUMO string não Restrições por ramo (ex.: não permitido com insumo em certos fluxos).

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "<API_KEY_SE_APLICAVEL>",
  "COD_FILIAL": "000001",
  "NATUREZA_OPERACAO_CODIGO": "5912",
  "NUMERO": "",
  "CODIGO": "<CODIGO_CLIENTE_OU_LOJA>",
  "DATA_EMISSAO": "<DATA>",
  "PRODUTOS": []
}
 
Tratamento de Dados

Agrega quantidades por produto-cor e distribui por colunas de grade (EN1EN48), calcula totais e valores, insere ou atualiza LOJA_RESERVA, LOJA_RESERVA_PRODUTO, LOJA_SAIDAS e LOJA_SAIDAS_PRODUTO conforme o ramo; utiliza funções auxiliares do próprio arquivo e validações de insumo e natureza.

 
Tratamento de retorno

Sucesso: Mensagem OK. Falha: ERROR com detalhe da exceção.

 
Fluxo do Processo

Diagrama do processo


Critérios de Aceitação
Processo Subprocesso Descrição Situação esperada
Endpoint (API) Ramos por natureza Deve aplicar apenas o ramo compatível com NATUREZA_OPERACAO_CODIGO e regras de insumo. Persistência coerente ou erro explícito.