Ir para o conteúdo principal

EasyproProdutoGrade (STATUS: GERADO)

Documentacao Tecnica
Nome do cliente OSKLEN
Nome do projeto Integracao LINX - EasyPro
Biblioteca wosk_easypro_produto_grade
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 consulta de grade de produto EasyPro.

 

Descricao

Este servico de grade de produto disponibiliza a listagem de codigo de barra, grade e ordem por produto no EasyPro.
O fluxo valida parametros de entrada, consulta a view de grade e retorna os dados em formato JSON com totalizacao.

 

Endpoint (API)

O endpoint recebe parametros de consulta para listar grades de produto, com filtro opcional por produto e paginacao opcional por limite e deslocamento.

  • Chamada: Requisicao HTTP
  • Recurso: /bibliotecas/1bb8f825-8b15-408a-9152-76d40f9df135/wosk_easypro_produto_grade
  • Metodo HTTP: GET

 

Estruturacao de Dados
Campo Tipo Obrigatorio Descricao
key string Sim Chave de autenticacao da requisicao.
PRODUTO string Nao Codigo do produto usado no filtro da consulta.
OFFSET number Condicional Obrigatorio quando LIMIT for informado.
LIMIT number Nao Quantidade maxima de linhas retornadas.

Exemplo de payload enviado para o endpoint (JSON):

{
    "key": "<API_KEY>",
    "PRODUTO": "<PRODUTO>",
    "OFFSET": <OFFSET>,
    "LIMIT": <LIMIT>
}

 

Tratamento de Dados

Leitura principal: o servico consulta W_ISNAPP_GRADE_TAMANHOS com retorno de CODIGO_BARRA, PRODUTO, COR_PRODUTO, GRADE e ORDEM. Quando PRODUTO e informado, aplica filtro por igualdade.

SELECT CODIGO_BARRA, PRODUTO, COR_PRODUTO, GRADE, ORDEM FROM W_ISNAPP_GRADE_TAMANHOS

Consulta dinamica com paginacao: quando LIMIT e informado, o fluxo exige OFFSET, converte ambos para inteiro e aplica ordenacao por PRODUTO, GRADE e ORDEM com OFFSET/FETCH.

Transformacao de dados: o campo ORDEM e normalizado por setNumeric antes da serializacao da resposta.

 

Integracao
  • Processamento: Consulta no banco LINX/EasyPro
  • Tabelas: W_ISNAPP_GRADE_TAMANHOS

 

Tratamento de retorno

Sucesso: retorna JSON com ROWS, TOTAL, Mensagem = OK e Mensagem Detalhada = Listagem Efetuada.
Erro: parametros invalidos e metodos nao implementados resultam em excecao com descricao do problema.

 

Fluxo do Processo

Fluxo do processo

 

Criterios de Aceitacao
Processo Subprocesso Descricao Situacao esperada
Endpoint (API) Consulta geral Ao enviar GET sem filtro de produto, o servico deve listar grades conforme a view de origem. Resposta com ROWS preenchido e TOTAL correspondente ao volume retornado.
Endpoint (API) Filtro por produto Ao enviar GET com PRODUTO, o servico deve restringir a consulta para o produto informado. Somente linhas do produto informado devem ser retornadas.
Endpoint (API) Paginacao Ao enviar LIMIT sem OFFSET, o servico deve bloquear a execucao por validacao de contrato. Excecao com indicacao de parametro obrigatorio condicional.

 

Situacoes consideradas
Valor Significado
GET Executa a listagem de grade de produto.
LIMIT + OFFSET Ativa a paginacao ordenada da consulta.
Mensagem = OK Indica processamento concluido com sucesso.
Voltar ao topo