Ir para o conteúdo principal

LojaCancelamentoTransferenciaSaida (STATUS: DOCUMENTADO)

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 HTTP 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 da biblioteca 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
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 (resolvido em FILIAIS).
NUMERO string sim Romaneio de saída (ROMANEIO_PRODUTO em LOJA_SAIDAS).

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) com $fields vazio no arquivo analisado.

Resolução de filial: FILIAIS por COD_FILIAL com padding; LOJAS_VAREJO por FILIAL para CODIGO_FILIAL e GERENTE_LOJA.

LOJA_SAIDAS: atualiza ROMANEIO_PRODUTO, QTDE_TOTAL e VALOR_TOTAL com 0, SAIDA_CANCELADA = 1, DATA_PARA_TRANSFERENCIA com data/hora atual (Y-m-d H:i:s), chave FILIAL e ROMANEIO_PRODUTO = NUMERO.

LOJA_SAIDAS_PRODUTO: para cada produto/cor do romaneio, VALOR = 0, QTDE_SAIDA = 0, PRECO1 = 0, EN1 a EN48 = 0, DATA_PARA_TRANSFERENCIA atual.

Entrada vinculada: se existir linha em LOJA_ENTRADAS com FILIAL_ORIGEM = FILIAL dos parâmetros e ROMANEIO_NF_SAIDA = NUMERO, chama o fluxo de cancelamento da entrada com FILIAL de origem e NUMERO = ROMANEIO_PRODUTO da entrada encontrada, registrando o retorno em LOJA_ENTRADAS no array de saída.

Resposta: Mensagem e Mensagem Detalhada conforme sucesso ou exceção.

Integração

Não há chamada HTTP externa ao ILLI neste arquivo; persistência em LOJA_SAIDAS, LOJA_SAIDAS_PRODUTO e eventualmente LOJA_ENTRADAS / LOJA_ENTRADAS_PRODUTO via fluxo reutilizado de cancelamento de entrada.

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

Diagrama do processo


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 run 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.