Ir para o conteúdo principal

LojaCancelamentoTransferenciaEntrada (STATUS: DOCUMENTADO)

Documentação Técnica
Nome do cliente OSKLEN
Nome do projeto Integração LINX → ILLI (Cancelamento Transferência Entrada)
Biblioteca wosk_loja_cancelamento_transferencia_entrada
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 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 HTTP desta biblioteca aplica cancelamento lógico na entrada de transferência: após validar 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 setLojaEntradas.

  • Chamada: Requisição HTTP
  • Recurso: /bibliotecas/f98ab8bb-96d1-4983-b875-a71f333af549/wosk_loja_cancelamento_transferencia_entrada
  • Método HTTP: POST
 
Estruturação de Dados
Parâmetros de entrada do endpoint
Campo Tipo Obrigatório Descrição
key string não Chave de API quando exigida pela plataforma.
COD_FILIAL string sim Código da filial de origem (usado para resolver FILIAL via tabela FILIAIS).
NUMERO string sim Identificador do romaneio (ROMANEIO_PRODUTO) na consulta a LOJA_ENTRADAS).

Exemplo de payload enviado para o endpoint (JSON):

{
  "key": "<API_KEY_SE_APLICAVEL>",
  "COD_FILIAL": "<COD_FILIAL>",
  "NUMERO": "<NUMERO_ROMANEIO>"
}
 
Tratamento de Dados

Pré-validação: validar($params) é chamado com a lista de campos do endpoint (vazia no arquivo analisado, logo sem regras adicionais declaradas em $fields).

Resolução de filial: consulta FILIAIS por COD_FILIAL preenchido com 6 dígitos à esquerda com zeros; obtém FILIAL. Consulta LOJAS_VAREJO por FILIAL para obter CODIGO_FILIAL e GERENTE_LOJA (COD_GERENTE_LOJA).

Cancelamento em LOJA_ENTRADAS: localiza registro por FILIAL_ORIGEM = FILIAL dos parâmetros e ROMANEIO_PRODUTO = NUMERO; obtém FILIAL destino do registro encontrado. Atualiza com QTDE_TOTAL = 0, VALOR_TOTAL = 0, ENTRADA_CANCELADA = 1, DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s, demais campos conforme hidratação definida no código.

Itens em LOJA_ENTRADAS_PRODUTO: para cada linha com mesmo FILIAL destino e ROMANEIO_PRODUTO, define VALOR = 0, QTDE_ENTRADA = 0, PRECO1 = 0, EN1 a EN48 = 0, DATA_PARA_TRANSFERENCIA com data/hora atual no formato Y-m-d H:i:s.

Saída ao chamador: em sucesso, Mensagem = OK e Mensagem Detalhada com texto de sucesso; em falha, Mensagem = ERROR e Mensagem Detalhada com o texto da exceçã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

Diagrama do processo


Critérios de Aceitação
Processo Subprocesso Descrição Situação esperada
Endpoint (API) Entrada Deve 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ência Deve 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) Retorno Deve preencher Mensagem com OK ou ERROR e mensagem detalhada conforme o resultado. Resposta coerente com sucesso ou falha do fluxo.
Nenhum comentário
Voltar ao topo