Ir para o conteúdo principal

LojaReservaSaidaCancelamento

Documentação Técnica
Nome do clienteOSKLEN
Nome do projetoIntegração LINX → ILLI (Cancelamento Reserva Saída)
Bibliotecawosk_loja_reserva_saida_cancelamento
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 Saída Cancelamento (LINX).

Descrição

Este serviço cancela movimentos de saída vinculados à reserva no LINX, marcando a saída como cancelada e zerando quantidades e valores nos itens de LOJA_SAIDAS_PRODUTO conforme o fluxo implementado.
Não há integração HTTP com o ILLI no arquivo analisado.

Endpoint (API)

Após validação e resolução de FILIAL, o processamento localiza o romaneio em LOJA_SAIDAS, atualiza flags de cancelamento e propaga zeragem para os itens em LOJA_SAIDAS_PRODUTO.

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/988f11fd-2965-4c21-afb9-35fcbec90f44/wosk_loja_reserva_saida_cancelamento
  • Método HTTP: POST
Estruturação de Dados
Parâmetros de entrada do endpoint (payload recebido no processamento principal)
CampoTipoObrigatórioDescrição
keystringnãoChave de autenticação/controle da chamada.
eventIdstring (UUID)nãoIdentificador do evento de origem; o método executa o processamento principal desta biblioteca não utiliza este campo.
COD_FILIALstringsimCódigo da filial (consulta em FILIAIS e LOJAS_VAREJO).
NUMEROstringsimRomaneio (ROMANEIO_PRODUTO) da saída a cancelar.
DATAstring (datetime)nãoPode integrar o payload; o método executa o processamento principal desta biblioteca não utiliza este campo.
NF_CHAVEstringnãoChave de acesso da NF; não referenciada no fluxo de cancelamento deste arquivo.
NF_SERIE, NF_MODELO, NF_NUMEROnumbernãoDados fiscais de referência; não utilizados no registra saídas da loja analisado.
DATA_CANCELAMENTOstring (datetime)nãoData/hora do cancelamento fiscal; não gravada diretamente pelos campos deste fluxo (o código atualiza DATA_PARA_TRANSFERENCIA com a data/hora do processamento).
PROTOCOLO_CANCELAMENTOstringnãoProtocolo de cancelamento da NF; não persistido no trecho analisado.

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "df9b5d7f-da04-42f1-80b2-6b6bbbc39152",
  "DATA": "2026-03-24 11:00:08",
  "NUMERO": "I0387317",
  "eventId": "feb79851-762b-41ee-96bf-24658dfdbbcf",
  "NF_CHAVE": "33260335943604008300550550000261331835829560",
  "NF_SERIE": 55,
  "NF_MODELO": 55,
  "NF_NUMERO": 26133,
  "COD_FILIAL": "000424",
  "DATA_CANCELAMENTO": "2026-03-24 11:13:01",
  "PROTOCOLO_CANCELAMENTO": "233260131405633"
}
Operações com Dados

No fluxo principal do endpoint:

  • Validação: validação base do serviço (valida os dados).
  • Filial: consulta em FILIAIS pelo COD_FILIAL; preenche-se FILIAL.
  • Loja: consulta em LOJAS_VAREJO por FILIAL; preenchem-se CODIGO_FILIAL e GERENTE_LOJA.
  • Cancelamento: registra saídas da loja localiza o cabeçalho em LOJA_SAIDAS por FILIAL e ROMANEIO_PRODUTO (NUMERO), aplica o UPDATE do romaneio e, em seguida, lê todas as linhas de LOJA_SAIDAS_PRODUTO do romaneio e atualiza cada uma com zeragem de quantidades e valores.
Tratamento de Dados

Modificações explícitas aplicadas aos dados de entrada ou aos registros atualizados:

  • Consulta de filial: COD_FILIAL é alinhado com preenchimento à esquerda até 6 posições antes da busca em FILIAIS.
  • LOJA_SAIDAS (cabeçalho): definem-se QTDE_TOTAL e VALOR_TOTAL como zero, SAIDA_CANCELADA como 1 e DATA_PARA_TRANSFERENCIA com a data/hora corrente do processamento.
  • LOJA_SAIDAS_PRODUTO (itens): para cada produto/cor do romaneio, definem-se VALOR, QTDE_SAIDA e PRECO1 como zero, todas as colunas EN1EN48 como zero e DATA_PARA_TRANSFERENCIA com a data/hora corrente do processamento.
Tratamento de retorno

Sucesso: Mensagem OK. Falha: ERROR com mensagem da exceção (registro não encontrado, falha de update, etc.).

Fluxo do Processo

Diagrama do processo


Critérios de Aceitação
ProcessoSubprocessoDescriçãoSituação esperada
Endpoint (API)CancelamentoDeve localizar saída e itens e aplicar cancelamento e zeragem conforme regra.Tabelas atualizadas ou erro retornado.