Ir para o conteúdo principal

LojaCancelamentoTransferenciaSaida

Documentação Técnica
Nome do cliente OSKLEN
Nome do projeto Integração LINX → ILLI (Cancelamento Transferência Saída)
Biblioteca wosk_loja_cancelamento_transferencia_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 Cancelamento Transferência Saída.

Descrição

Este serviço de cancelamento de transferência (saída) encerra a saída no LINX, zera itens em LOJA_SAIDAS_PRODUTO e, quando houver entrada de destino vinculada, aciona o fluxo de cancelamento da entrada correspondente.
O resultado é devolvido ao chamador com indicadores de mensagem padronizados.

Endpoint (API)

O serviço resolve a filial a partir de COD_FILIAL, valida cadastro em LOJAS_VAREJO, atualiza LOJA_SAIDAS e LOJA_SAIDAS_PRODUTO para o romaneio informado e, se existir LOJA_ENTRADAS com FILIAL_ORIGEM e ROMANEIO_NF_SAIDA associados, delega o cancelamento da entrada ao fluxo do serviço de cancelamento de entrada.

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/8b02cff5-67ba-4c62-a235-73c509dd9d88/wosk_loja_cancelamento_transferencia_saida
  • Método HTTP: POST
Estruturação de Dados
Campo Tipo Obrigatório Descrição
key string sim Identificador/chave técnica da requisição.
DATA string (datetime) sim Data de referência do evento no formato YYYY-MM-DD HH:MM:SS.
NUMERO string sim Romaneio de saída (ROMANEIO_PRODUTO em LOJA_SAIDAS).
eventId string sim Identificador único do evento de origem.
NF_CHAVE string sim Chave da nota fiscal associada ao evento.
NF_SERIE number sim Série da nota fiscal associada ao evento.
NF_MODELO number sim Modelo da nota fiscal associada ao evento.
NF_NUMERO number sim Número da nota fiscal associada ao evento.
COD_FILIAL string sim Código da filial (resolvido em FILIAIS).
DATA_CANCELAMENTO string (datetime) sim Data e hora do cancelamento no formato YYYY-MM-DD HH:MM:SS.
PROTOCOLO_CANCELAMENTO string sim Número de protocolo do cancelamento.

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "df9b5d7f-da04-42f1-80b2-6b6b99c39152",
  "DATA": "2026-03-29 16:38:01",
  "NUMERO": "I3396252",
  "eventId": "f7345474-c5ae-4973-aa1e-be1751e1d51b",
  "NF_CHAVE": "33260335943604001632550550000703741865393221",
  "NF_SERIE": 55,
  "NF_MODELO": 55,
  "NF_NUMERO": 70374,
  "COD_FILIAL": "000025",
  "DATA_CANCELAMENTO": "2026-03-29 17:00:26",
  "PROTOCOLO_CANCELAMENTO": "233260139308583"
}
Operações com Dados

Consultas de apoio (sem modificação): consulta FILIAIS por COD_FILIAL com padding para obter FILIAL e consulta LOJAS_VAREJO por FILIAL para obter CODIGO_FILIAL e COD_GERENTE_LOJA.

Modificação persistida em LOJA_SAIDAS: atualiza o romaneio identificado por FILIAL e ROMANEIO_PRODUTO = NUMERO, definindo QTDE_TOTAL = 0, VALOR_TOTAL = 0, SAIDA_CANCELADA = 1 e DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s.

Modificação persistida em LOJA_SAIDAS_PRODUTO: para cada item do romaneio, atualiza VALOR = 0, QTDE_SAIDA = 0, PRECO1 = 0, EN1 a EN48 = 0 e DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s.

Encadeamento com entrada vinculada: quando existe registro em LOJA_ENTRADAS por FILIAL_ORIGEM e ROMANEIO_NF_SAIDA, o fluxo aciona o cancelamento da entrada correspondente (que pode gerar novas modificações em LOJA_ENTRADAS e LOJA_ENTRADAS_PRODUTO).

Composição da saída: o retorno é enriquecido com Mensagem e Mensagem Detalhada conforme sucesso ou exceção.

Tratamento de retorno

Retorno é o array de parâmetros com Mensagem OK ou ERROR e detalhe em Mensagem Detalhada. Erros de não encontrado ou falha de atualização são capturados e convertidos em mensagem.

Fluxo do Processo

wosk_loja_cancelamento_transferencia_saida.drawio.jpg


Critérios de Aceitação
Processo Subprocesso Descrição Situação esperada
Endpoint (API) Contrato Deve aceitar POST em /bibliotecas/8b02cff5-67ba-4c62-a235-73c509dd9d88/wosk_loja_cancelamento_transferencia_saida com COD_FILIAL e NUMERO. Parâmetros recebidos pelo executa o processamento principal do endpoint.
Endpoint (API) Cancelamento saída Deve zerar totais e marcar saída cancelada em LOJA_SAIDAS e itens em LOJA_SAIDAS_PRODUTO quando o romaneio existir na filial. Atualização consistente ou erro retornado.
Endpoint (API) Encadeamento Quando houver entrada vinculada, deve acionar cancelamento da entrada correspondente. Campo LOJA_ENTRADAS preenchido no retorno quando o encadeamento ocorrer.