wosk_easypro_pedido_compra (STATUS: AJUSTANDO)

DocumentacaoDocumentação TecnicaTécnica

Nome do cliente	OSKLEN
Nome do projeto	IntegracaoIntegração LINX - EasyPro
Biblioteca	wosk_easypro_pedido_compra
Data	30/03/2026

 

HistoricoHistórico de VersoesVersões

Data	VersaoVersão	Modificado por	DescricaoDescrição da MudancaMudança
30/03/2026	1.0	Maykon/Gustavo	CriacaoCriação da documentacaodocumentação tecnicatécnica do servicoserviço de pedido de compra EasyPro.

 

DescricaoDescrição

Este servicoserviço de pedido de compra disponibiliza consulta e atualizacaoatualização de itens de pedido no EasyPro.
O fluxo valida os parametrosparâmetros recebidos, busca os dados em views de apoio e persiste a inspecaoinspeção de itens na tabela de compras.

 

Endpoint (API)

O endpoint recebe parametrosparâmetros de consulta para listar pedidos de compra com paginacaopaginação opcional e detalhes de itens por pedido. No modo de atualizacao,atualização, recebe o numeronúmero do pedido e a lista de itens inspecionados para atualizar os registros correspondentes.

Contrato HTTP - Consulta

• Chamada: RequisicaoRequisição HTTP
• Recurso: /bibliotecas/3e4db338-c809-489b-a571-45caff304f86/wosk_easypro_pedido_compra
• MetodoMétodo HTTP: GET

Contrato HTTP - AtualizacaoAtualização

• Chamada: RequisicaoRequisição HTTP
• Recurso: /bibliotecas/3e4db338-c809-489b-a571-45caff304f86/wosk_easypro_pedido_compra
• MetodoMétodo HTTP: PUT

Campos adicionais tratados no fluxo interno de gravacao:gravação: PEDIDO, PRODUTO, COR_PRODUTO, QTDE_INSPECIONADA e DATA_PARA_TRANSFERENCIA, com validacaovalidação de existenciaexistência previaprévia na tabela COMPRAS_PRODUTO antes da atualizacao.atualização.

 

EstruturacaoEstruturação de Dados

Campos de entrada para consulta (GET)

Campo	Tipo	ObrigatorioObrigatório	DescricaoDescrição
key	string	Sim	Chave de autenticacaoautenticação da requisicao.requisição.
EMISSAO	datetime	Condicional	ObrigatorioObrigatório quando PEDIDO, FORNECEDOR e COD_FORNECEDOR naonão saosão informados.
PEDIDO	string	NaoNão	NumeroNúmero do pedido de compra.
FORNECEDOR	string	NaoNão	Nome do fornecedor associado ao pedido.
COD_FORNECEDOR	string	NaoNão	CodigoCódigo do fornecedor associado ao pedido.
OFFSET	number	Condicional	ObrigatorioObrigatório quando LIMIT for informado.
LIMIT	number	NaoNão	Quantidade maximamáxima de linhas retornadas.

Campos de entrada para atualizacaoatualização (PUT)

Campo	Tipo	ObrigatorioObrigatório	DescricaoDescrição
key	string	Sim	Chave de autenticacaoautenticação da requisicao.requisição.
PEDIDO	string	Sim	NumeroNúmero do pedido de compra que seraserá atualizado.
ITENS	array	Sim	Lista de itens inspecionados para atualizacao.atualização.

Estrutura de cada elemento de ITENS

Campo	Tipo	ObrigatorioObrigatório	DescricaoDescrição
PRODUTO	number	Sim	CodigoCódigo referenciareferência do produto.
COR_PRODUTO	string	Sim	CodigoCódigo 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 dinamicosdinâmicos de EMISSAO, PEDIDO, FORNECEDOR e COD_FORNECEDOR, alemalém de paginacaopaginação 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 servicoserviço 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>'

ValidacaoValidação pre-atualizacao:pré-atualização: o servicoserviço valida o contrato do payload e confirma se cada combinacaocombinação de PEDIDO, PRODUTO e COR_PRODUTO existe na tabela COMPRAS_PRODUTO antes de iniciar a gravacao.gravação.

Persistencia:Persistência: a atualizacaoatualização ocorre com transacaotransação explicitaexplícita na tabela COMPRAS_PRODUTO, preenchendo QTDE_INSPECIONADA e DATA_PARA_TRANSFERENCIA com data/hora corrente para cada item recebido.

 

IntegracaoIntegração

• Processamento: Consulta e atualizacaoatualização 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, alemalém de metadados com Mensagem = OK e Mensagem Detalhada = Listagem Efetuada.
Sucesso em atualizacao:atualização: retorna os dados recebidos com Mensagem = OK e Mensagem Detalhada = Registrado com sucesso.
Erro: validacoesvalidações obrigatorias,obrigatórias, metodométodo naonão implementado e falhas de transacaotransação geram excecaoexceção com detalhe do motivo.

 

Fluxo do Processo

 

CriteriosCritérios de AceitacaoAceitação

Processo	Subprocesso	DescricaoDescrição	SituacaoSituação esperada
Endpoint (API)	Consulta de pedidos	Ao enviar GET com filtros validos,válidos, o servicoserviço deve aplicar filtros dinamicosdinâmicos na view de pedidos e montar ITENS para cada pedido retornado.	Resposta com ROWS preenchido e TOTAL coerente com os filtros.
Endpoint (API)	ValidacaoValidação de contrato	Ao enviar PUT sem PEDIDO ou sem ITENS, o servicoserviço deve bloquear a gravacaogravação e retornar erro de validacao.validação.	Sem atualizacaoatualização em COMPRAS_PRODUTO e excecaoexceção com mensagem descritiva.
Endpoint (API)	AtualizacaoAtualização de itens	Ao enviar PUT com PEDIDO e itens existentes, o servicoserviço deve atualizar QTDE_INSPECIONADA e DATA_PARA_TRANSFERENCIA em transacaotransação unica.única.	Registros atualizados em COMPRAS_PRODUTO e retorno com Mensagem = OK.

 

SituacoesSituações consideradas

Valor	Significado
GET	Executa consulta de pedidos com filtros e paginacaopaginação opcional.
PUT	Atualiza itens inspecionados do pedido na tabela COMPRAS_PRODUTO.
Mensagem = OK	OperacaoOperação finalizada com sucesso para consulta ou atualizacao.atualização.