A API disponibiliza os seguintes campos :
Atributo | Tipo | Descrição |
---|---|---|
id | número | Id do grupo de produto no Nomus ERP |
nome | texto | Nome do grupo de produto no Nomus ERP |
classificacao | texto | Classificação do grupo de produto |
analitico | booleano | True se é analítico, ou false caso seja sintético |
Serviços disponíveis
Consultar um grupo de produto
Retorna as informações de um grupo de produto com o id passado por parâmetro.
GET - /rest/gruposProduto/{id_grupo_de_produto}
Retorno:
{ "ativo": true, "classificacao": "002", "id": 1, "nome": "Embalagens", "tipo": 1 }
Consultar todos grupos de produto
GET - /rest/gruposProduto
Este serviço lista todos os grupos de produto. O resultado é listado de forma paginada, retornando no máximo 50 registros. Se nenhuma página for passada será retornado os 50 registros mais recentes. Para listar todos os resultados é necessário passar o número da página. Exemplo:
gruposProduto?pagina=2
Retorno (exemplo simplificado)::
[ { "ativo": true, "classificacao": "Teste2", "id": 117, "nome": "Teste2", "tipo": 1 }, { "ativo": true, "classificacao": "Produto acabado", "id": 116, "nome": "Desodorante", "tipo": 0 }, { "ativo": true, "classificacao": "HOMEM", "id": 115, "nome": "3103", "tipo": 1 }, ... ]
Consultar clientes filtrando por parâmetro
GET - /rest/gruposProduto?query={parâmetros}
Podem ser usados os seguintes operadores de comparação
Igual a:
==
Não igual a:
!=
Menor que:
<
Menor ou igual que: <=
Maior que:
>
Maior ou igual que:
>=
Operadores lógicos:
- E: ;
- OU: ,
Para filtrar usando o operador E por 2 atributos diferentes adicionaria: ?query=campo1==valor;campo2==valor2
É possível consultar no Nomus ERP através de qualquer um dos campos listados acima e da combinação deles.
A resposta será um JSON com os campos solicitados no método preenchidos desde que todas as condições sejam atingidas.
O limite por retorno são 50 registros por consulta. Para retornar além dessa quantidade é necessário passar o parâmetro pagina.
Exemplo:
gruposProduto?query=tipo==1
Retorno (exemplo simplificado)::
[ { "ativo": true, "classificacao": "Teste2", "id": 117, "nome": "Teste2", "tipo": 1 }, { "ativo": true, "classificacao": "HOMEM", "id": 115, "nome": "3103", "tipo": 1 }, { "ativo": true, "classificacao": "00009", "id": 114, "nome": "Corte e Solda", "tipo": 1 }, ... ]