wosk_easypro_pedido_compra (STATUS: GERADO)

Documentacao Tecnica

Nome do cliente	OSKLEN
Nome do projeto	Integracao LINX - EasyPro
Biblioteca	wosk_easypro_pedido_compra
Data	30/03/2026

Historico de Versoes

Data	Versao	Modificado por	Descricao da Mudanca
30/03/2026	1.0	Maykon/Gustavo	Criacao da documentacao tecnica do servico de pedido de compra EasyPro.

Descricao

Este servico de pedido de compra disponibiliza consulta e atualizacao de itens de pedido no EasyPro.
O fluxo valida os parametros recebidos, busca os dados em views de apoio e persiste a inspecao de itens na tabela de compras.

Endpoint (API)

O endpoint recebe parametros de consulta para listar pedidos de compra com paginacao opcional e detalhes de itens por pedido. No modo de atualizacao, recebe o numero do pedido e a lista de itens inspecionados para atualizar os registros correspondentes.

Contrato HTTP - Consulta

Chamada: Requisicao HTTP

Recurso: /bibliotecas/3e4db338-c809-489b-a571-45caff304f86/wosk_easypro_pedido_compra

Metodo HTTP: GET

Contrato HTTP - Atualizacao

Chamada: Requisicao HTTP

Recurso: /bibliotecas/3e4db338-c809-489b-a571-45caff304f86/wosk_easypro_pedido_compra

Metodo HTTP: PUT

Campos adicionais tratados no fluxo interno de gravacao: PEDIDO, PRODUTO, COR_PRODUTO, QTDE_INSPECIONADA e DATA_PARA_TRANSFERENCIA, com validacao de existencia previa na tabela COMPRAS_PRODUTO antes da atualizacao.

Estruturacao de Dados

Campos de entrada para consulta (`GET`)
Campo	Tipo	Obrigatorio	Descricao
`key`	string	Sim	Chave de autenticacao da requisicao.
`EMISSAO`	datetime	Condicional	Obrigatorio quando `PEDIDO`, `FORNECEDOR` e `COD_FORNECEDOR` nao sao informados.
`PEDIDO`	string	Nao	Numero do pedido de compra.
`FORNECEDOR`	string	Nao	Nome do fornecedor associado ao pedido.
`COD_FORNECEDOR`	string	Nao	Codigo do fornecedor associado ao pedido.
`OFFSET`	number	Condicional	Obrigatorio quando `LIMIT` for informado.
`LIMIT`	number	Nao	Quantidade maxima de linhas retornadas.

Campos de entrada para atualizacao (`PUT`)
Campo	Tipo	Obrigatorio	Descricao
`key`	string	Sim	Chave de autenticacao da requisicao.
`PEDIDO`	string	Sim	Numero do pedido de compra que sera atualizado.
`ITENS`	array	Sim	Lista de itens inspecionados para atualizacao.

Estrutura de cada elemento de `ITENS`
Campo	Tipo	Obrigatorio	Descricao
`PRODUTO`	number	Sim	Codigo referencia do produto.
`COR_PRODUTO`	string	Sim	Codigo SKU do produto.
`QTDE_INSPECIONADA`	number	Sim	Quantidade inspecionada para o item do pedido.

Exemplo de payload enviado para o endpoint (JSON):

{
    "key": "<API_KEY>",
    "PEDIDO": "<PEDIDO>",
    "ITENS": [
        {
            "PRODUTO": <PRODUTO>,
            "COR_PRODUTO": "<COR_PRODUTO>",
            "QTDE_INSPECIONADA": <QTDE_INSPECIONADA>
        }
    ]
}

Tratamento de Dados

Leitura principal (consulta): a listagem de pedidos utiliza a view W_ISNAPP_EASYPRO_PEDIDO_COMPRAS com filtros dinamicos de EMISSAO, PEDIDO, FORNECEDOR e COD_FORNECEDOR, alem de paginacao por ORDER BY PEDIDO ASC OFFSET/FETCH quando LIMIT e informado.

SELECT * FROM W_ISNAPP_EASYPRO_PEDIDO_COMPRAS

Leitura complementar de itens: para cada pedido retornado, o servico consulta os itens em W_ISNAPP_EASYPRO_PEDIDO_COMPRAS_ITEM, converte QTDE_ENTREGAR e QTDE_ENTREGUE com setNumeric e remove PEDIDO da subestrutura ITENS.

SELECT * FROM W_ISNAPP_EASYPRO_PEDIDO_COMPRAS_ITEM WHERE PEDIDO = '<PEDIDO>'

Validacao pre-atualizacao: o servico valida o contrato do payload e confirma se cada combinacao de PEDIDO, PRODUTO e COR_PRODUTO existe na tabela COMPRAS_PRODUTO antes de iniciar a gravacao.

Persistencia: a atualizacao ocorre com transacao explicita na tabela COMPRAS_PRODUTO, preenchendo QTDE_INSPECIONADA e DATA_PARA_TRANSFERENCIA com data/hora corrente para cada item recebido.

Integracao

Processamento: Consulta e atualizacao no banco LINX/EasyPro

Tabelas: W_ISNAPP_EASYPRO_PEDIDO_COMPRAS, W_ISNAPP_EASYPRO_PEDIDO_COMPRAS_ITEM, COMPRAS_PRODUTO

Tratamento de retorno

Sucesso em consulta: retorna estrutura JSON com ROWS e TOTAL, alem de metadados com Mensagem = OK e Mensagem Detalhada = Listagem Efetuada.
Sucesso em atualizacao: retorna os dados recebidos com Mensagem = OK e Mensagem Detalhada = Registrado com sucesso.
Erro: validacoes obrigatorias, metodo nao implementado e falhas de transacao geram excecao com detalhe do motivo.

Fluxo do Processo

Criterios de Aceitacao

Processo	Subprocesso	Descricao	Situacao esperada
Endpoint (API)	Consulta de pedidos	Ao enviar `GET` com filtros validos, o servico deve aplicar filtros dinamicos na view de pedidos e montar `ITENS` para cada pedido retornado.	Resposta com `ROWS` preenchido e `TOTAL` coerente com os filtros.
Endpoint (API)	Validacao de contrato	Ao enviar `PUT` sem `PEDIDO` ou sem `ITENS`, o servico deve bloquear a gravacao e retornar erro de validacao.	Sem atualizacao em `COMPRAS_PRODUTO` e excecao com mensagem descritiva.
Endpoint (API)	Atualizacao de itens	Ao enviar `PUT` com `PEDIDO` e itens existentes, o servico deve atualizar `QTDE_INSPECIONADA` e `DATA_PARA_TRANSFERENCIA` em transacao unica.	Registros atualizados em `COMPRAS_PRODUTO` e retorno com `Mensagem = OK`.

Situacoes consideradas

Valor	Significado
`GET`	Executa consulta de pedidos com filtros e paginacao opcional.
`PUT`	Atualiza itens inspecionados do pedido na tabela `COMPRAS_PRODUTO`.
`Mensagem = OK`	Operacao finalizada com sucesso para consulta ou atualizacao.