Ir para o conteúdo principal

LojaCancelamentoTransferenciaEntrada

Documentação Técnica
Nome do clienteOSKLEN
Nome do projetoIntegração LINX → ILLI (Cancelamento Transferência Entrada)
Bibliotecawosk_loja_cancelamento_transferencia_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 Cancelamento Transferência Entrada.

Descrição

Este serviço de cancelamento de transferência (entrada) recebe identificação de filial e romaneio, localiza o destino da entrada e zera quantidades e valores nas tabelas de entrada da loja no LINX.
O retorno ao chamador indica sucesso ou erro em campos padronizados de mensagem.

Endpoint (API)

O serviço aplica o cancelamento na entrada de transferência: após valida os dados parâmetros, resolve a filial pelo código, confere cadastro em LOJAS_VAREJO e executa atualização em LOJA_ENTRADAS e LOJA_ENTRADAS_PRODUTO conforme a rotina interna registra entradas da loja.

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/f98ab8bb-96d1-4983-b875-a71f333af549/wosk_loja_cancelamento_transferencia_entrada
  • Método HTTP: POST
Estruturação de Dados
CampoTipoObrigatórioDescrição
keystringsimIdentificador/chave técnica da requisição.
DATAstring (datetime)simData de referência do evento no formato YYYY-MM-DD HH:MM:SS.
NUMEROstringsimIdentificador do romaneio (ROMANEIO_PRODUTO) utilizado na consulta de entrada.
eventIdstringsimIdentificador único do evento de origem.
NF_CHAVEstringsim (aceita vazio)Chave da nota fiscal associada ao evento, quando informada.
NF_SERIEstringsim (aceita vazio)Série da nota fiscal associada ao evento, quando informada.
NF_MODELOstringsim (aceita vazio)Modelo da nota fiscal associada ao evento, quando informado.
NF_NUMEROstringsim (aceita vazio)Número da nota fiscal associada ao evento, quando informado.
COD_FILIALstringsimCódigo da filial de origem (usado para resolver FILIAL via tabela FILIAIS).
DATA_CANCELAMENTOstring (datetime)simData e hora do cancelamento no formato YYYY-MM-DD HH:MM:SS.
PROTOCOLO_CANCELAMENTOstringsim (aceita vazio)Número de protocolo do cancelamento, quando informado.

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "df9b5d7f-da04-4299-80b2-6b6bbbc39152",
  "DATA": "2025-10-15 00:00:00",
  "NUMERO": "A1059976",
  "eventId": "fedd8c40-ea70-9960-83a2-dc7f525cc565",
  "NF_CHAVE": "",
  "NF_SERIE": "",
  "NF_MODELO": "",
  "NF_NUMERO": "",
  "COD_FILIAL": "000099",
  "DATA_CANCELAMENTO": "2025-10-15 18:52:09",
  "PROTOCOLO_CANCELAMENTO": ""
}
Operações com Dados

Consultas de apoio (sem modificação): consulta FILIAIS por COD_FILIAL preenchido com 6 dígitos à esquerda com zeros para obter FILIAL. Em seguida, consulta LOJAS_VAREJO por FILIAL para obter CODIGO_FILIAL e COD_GERENTE_LOJA.

Modificação persistida em LOJA_ENTRADAS: localiza o registro por FILIAL_ORIGEM = FILIAL e ROMANEIO_PRODUTO = NUMERO, identifica a filial destino e atualiza os campos QTDE_TOTAL = 0, VALOR_TOTAL = 0, ENTRADA_CANCELADA = 1 e DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s.

Modificação persistida em LOJA_ENTRADAS_PRODUTO: para cada item da mesma FILIAL destino e ROMANEIO_PRODUTO, atualiza VALOR = 0, QTDE_ENTRADA = 0, PRECO1 = 0, EN1 a EN48 = 0 e DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s.

Composição da saída: ao final do fluxo, o retorno é enriquecido com Mensagem (OK ou ERROR) e Mensagem Detalhada conforme o resultado da execução.

Integração

Não há chamada HTTP externa ao ILLI neste arquivo; a persistência ocorre nas tabelas LOJA_ENTRADAS e LOJA_ENTRADAS_PRODUTO no LINX.

Tratamento de retorno

O retorno é o próprio array de parâmetros enriquecido com Mensagem e Mensagem Detalhada. Falhas de consulta (filial ou loja não encontrada, romaneio inexistente, erro de atualização) geram exceção capturada e refletidas nesses campos.

Fluxo do Processo

wosk_loja_cancelamento_transferencia_entrada.drawio.jpg


Critérios de Aceitação
ProcessoSubprocessoDescriçãoSituação esperada
Endpoint (API)EntradaDeve aceitar POST no recurso /bibliotecas/f98ab8bb-96d1-4983-b875-a71f333af549/wosk_loja_cancelamento_transferencia_entrada com corpo contendo COD_FILIAL e NUMERO.Parâmetros repassados ao fluxo de cancelamento.
Endpoint (API)PersistênciaDeve marcar entrada cancelada e zerar quantidades e valores em LOJA_ENTRADAS e LOJA_ENTRADAS_PRODUTO quando o romaneio existir para a combinação informada.Registros atualizados ou erro documentado em Mensagem Detalhada.
Endpoint (API)RetornoDeve preencher Mensagem com OK ou ERROR e mensagem detalhada conforme o resultado.Resposta coerente com sucesso ou falha do fluxo.