Ir para o conteúdo principal

EasyproProdutoGrade (STATUS: GERADO)

Documentação TecnicaTécnica
Nome do cliente OSKLEN
Nome do projeto IntegracaoIntegração LINX - EasyPro
Biblioteca wosk_easypro_produto_grade
Data 30/03/2026

Histórico de Versões
Data Versão Modificado por Descrição da Mudança
30/03/2026 1.0 Maykon/Gustavo Criação da documentação técnica do serviço de consulta de grade de produto EasyPro.

Descrição

Este servicoserviço de grade de produto disponibiliza a listagem de codigocódigo de barra, grade e ordem por produto no EasyPro.
O fluxo valida parametrosparâmetros de entrada, consulta a view de grade e retorna os dados em formato JSON com totalizacao.totalização.

Endpoint (API)

O endpoint recebe parametrosparâmetros de consulta para listar grades de produto, com filtro opcional por produto e paginação opcional por limite e deslocamento.

  • Chamada: RequisicaoRequisição HTTP
  • Recurso: /bibliotecas/1bb8f825-8b15-408a-9152-76d40f9df135/wosk_easypro_produto_grade
  • MetodoMétodo HTTP: GET

Estruturação de Dados
Campo Tipo Obrigatório Descrição
key string Sim Chave de autenticacaoautenticação da requisicao.requisição.
PRODUTO string NaoNão CodigoCódigo do produto usado no filtro da consulta.
OFFSET number Condicional ObrigatorioObrigatório quando LIMIT for informado.
LIMIT number NaoNão Quantidade maximamáxima 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 servicoserviço 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 dinâmica com paginacao:paginação: quando LIMIT eé informado, o fluxo exige OFFSET, converte ambos para inteiro e aplica ordenacaoordenação por PRODUTO, GRADE e ORDEM com OFFSET/FETCH.

TransformacaoTransformação de dados: o campo ORDEM eé normalizado por setNumeric antes da serializacaoserialização da resposta.

IntegracaoIntegração
  • 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: parametrosparâmetros invalidosinválidos e metodosmétodos naonão implementados resultam em excecaoexceção com descricaodescrição do problema.

Fluxo do Processo

Fluxo do processo

CriteriosCritérios de AceitacaoAceitação
Processo Subprocesso DescricaoDescrição SituacaoSituação esperada
Endpoint (API) Consulta geral Ao enviar GET sem filtro de produto, o servicoserviço 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 servicoserviço deve restringir a consulta para o produto informado. Somente linhas do produto informado devem ser retornadas.
Endpoint (API) PaginacaoPaginação Ao enviar LIMIT sem OFFSET, o servicoserviço deve bloquear a execucaoexecução por validacaovalidação de contrato. ExcecaoExceção com indicacaoindicação de parametroparâmetro obrigatorioobrigatório condicional.

SituacoesSituações consideradas
Valor Significado
GET Executa a listagem de grade de produto.
LIMIT + OFFSET Ativa a paginacaopaginação ordenada da consulta.
Mensagem = OK Indica processamento concluidoconcluído com sucesso.