A API disponibiliza os seguintes campos :
| Atributo | Tipo | Descrição |
|---|---|---|
| id | número | Id do produto no Nomus ERP |
| codigo | texto | Nome do produto |
| descricao | texto | Descrição do produto |
| codigoGTIN | texto | Código GTIN do produto |
| informacoesAdicionais | texto | Informações adicionais do produto |
| siglaUnidadeMedida | texto | A sigla da unidade de medida do produto |
| idUnidadeMedida | número | Id da unidade de medida do produto |
| nomeTipoProduto | texto | Nome do tipo de produto |
| idTipoProduto | número | Id do tipo de produto |
| nomeGrupoProduto | texto | Nome do grupo de produto |
| idGrupoProduto | número | Id do grupo de produto |
| nomeFamiliaProduto | texto | Nome da família de produto |
| idFamiliaProduto | número | Id da família de produto |
| metodoRessuprimento | número | 1 - Comprado 2 - Fabricado 3 - Como padrão fabricado 4 - Como padrão comprado |
| controlaLote | booleano | True se controla lote, ou false caso contrário |
| controlaSerie | booleano | True se controla série, ou false caso contrário |
| ativo | booleano | True se ativo, ou false caso contrário |
| observacoes | texto | Observações do produto |
| dataHoraUltimaModificacao | data (dd/mm/aaaa hh:mm) | Data e hora da última modificação feita no produto |
| dataCriacao | data (dd/mm/aaaa hh:mm) | Data e hora da criação do produto |
| dataModificacao | data (dd/mm/aaaa hh:mm) | Data e hora da última vez que o produto foi editado |
| pesoLiquidoUnitario | número | Peso líquido unitário do produto |
| pesoBrutoUnitario | número | Peso bruto unitário do produto |
| ncm | texto | Código do NCM (Nomenclatura Comum do Mercosul) do produto |
| excecaoNcm | texto | Exceção do NCM do produto |
| cest | texto | CEST (Código Especificador da Substituição Tributária) do produto |
| origemProdutoPadrao | número | 0 - Nacional (exceto as indicadas nos códigos de 3 a 5) 1 - Estrangeira - Importação direto (exceto a indicada no código 6) 2 - Estrangeira - Adquirida no mercado interno (exceto a indicada no código 7) 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70% 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40% 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70% |
| numeroControleFCI | texto | número de controle da FCI (Ficha de Conteúdo de Importação) |
| indicadorProducaoEscalaRelevante | texto | http://ajuda.nomus.com.br/support/solutions/articles/27000048912-passo-1-indicador-de-produc%C3%A3o-em-escala-relevante |
| tabelasPreco | lista de tabelas de preço | Ver abaixo |
tabelasPreco
| Atributo | Tipo | Descrição |
|---|---|---|
| id | número | Id da tabela de preço |
| nome | texto | Nome da tabela de preço |
| percentualDescontoPadrao | número | Percentual de desconto padrão da tabela de preço |
| percentualDescontoMaximo | número | Percentual de desconto máximo da tabela de preço |
| preco | número | Preço do produto na tabela de preço |
Serviços disponíveis
Consultar um produto
Retorna as informações de um produto com o id passado por parâmetro.
GET - /rest/produtos/1
Retorno:
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": false,
"controlaSerie": false,
"dataCriacao": "01/03/2007 12:19:48",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"descricao": "",
"excecaoNcm": "",
"id": 1,
"idGrupoProduto": 30,
"idTipoProduto": 5,
"idUnidadeMedida": 1,
"metodoRessuprimento": 1,
"ncm": "01023190",
"nomeGrupoProduto": "Soquete para Compactação",
"nomeTipoProduto": "Produto industrializado",
"numeroControleFCI": "",
"origemProdutoPadrao": "0",
"siglaUnidadeMedida": "UN",
"tabelasPreco": [
{
"id": 39,
"nome": "teste",
"preco": "0,0000"
},
{
"id": 50,
"nome": "Bloco Kit K hahah",
"preco": "312,5000"
}
]
}Consultar todos produtos
GET - /rest/produtos
Este serviço lista todaos produtos. 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:
produtos?pagina=2
Retorno (exemplo simplificado)::
[
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": true,
"controlaSerie": false,
"dataCriacao": "06/05/2019 13:03:47",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"descricao": "produtomaster_descricao dimensaograde_AshtarCor_nome dimensaograde_AshtarTipoGravacao_nome",
"excecaoNcm": "",
"id": 8523,
"idTipoProduto": 8,
"idUnidadeMedida": 31,
"metodoRessuprimento": 1,
"ncm": "01012100",
"nomeTipoProduto": "Produto comercializado",
"numeroControleFCI": "",
"origemProdutoPadrao": "0",
"siglaUnidadeMedida": "BD"
},
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": false,
"controlaSerie": false,
"dataCriacao": "02/05/2019 18:50:41",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"excecaoNcm": "",
"id": 8522,
"idFamiliaProduto": 40,
"idTipoProduto": 38,
"idUnidadeMedida": 31,
"metodoRessuprimento": 3,
"nomeFamiliaProduto": "Black Garnet",
"nomeTipoProduto": "Art - Produto Acabado",
"numeroControleFCI": "",
"siglaUnidadeMedida": "BD"
},
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": false,
"controlaSerie": false,
"dataCriacao": "02/05/2019 15:09:09",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"descricao": "sola",
"excecaoNcm": "",
"id": 8521,
"idTipoProduto": 29,
"idUnidadeMedida": 124,
"metodoRessuprimento": 2,
"nomeTipoProduto": "Materia Prima",
"numeroControleFCI": "",
"siglaUnidadeMedida": "UN"
},
...
]Consultar produtos filtrando por parâmetro
GET - /rest/produtos?query={condições}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:
produtos?query=idUnidadeMedida==31
Retorno (exemplo simplificado)::
[
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": true,
"controlaSerie": false,
"dataCriacao": "06/05/2019 13:03:47",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"descricao": "produtomaster_descricao dimensaograde_AshtarCor_nome dimensaograde_AshtarTipoGravacao_nome",
"excecaoNcm": "",
"id": 8523,
"idTipoProduto": 8,
"idUnidadeMedida": 31,
"metodoRessuprimento": 1,
"ncm": "01012100",
"nomeTipoProduto": "Produto comercializado",
"numeroControleFCI": "",
"origemProdutoPadrao": "0",
"siglaUnidadeMedida": "BD"
},
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": false,
"controlaSerie": false,
"dataCriacao": "02/05/2019 18:50:41",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"excecaoNcm": "",
"id": 8522,
"idFamiliaProduto": 40,
"idTipoProduto": 38,
"idUnidadeMedida": 31,
"metodoRessuprimento": 3,
"nomeFamiliaProduto": "Black Garnet",
"nomeTipoProduto": "Art - Produto Acabado",
"numeroControleFCI": "",
"siglaUnidadeMedida": "BD"
},
{
"ativo": true,
"codigoGTIN": "",
"controlaLote": false,
"controlaSerie": false,
"dataCriacao": "16/04/2019 13:33:26",
"dataHoraUltimaModificacao": "28/05/2019 16:54:22",
"dataModificacao": "28/05/2019 16:54:22",
"descricao": "produtomaster_descricao dimensaograde_AshtarCor_nome dimensaograde_AshtarTipoGravacao_nome",
"excecaoNcm": "",
"id": 8508,
"idTipoProduto": 19,
"idUnidadeMedida": 31,
"metodoRessuprimento": 2,
"nomeTipoProduto": "Produto Acabado",
"numeroControleFCI": "",
"siglaUnidadeMedida": "BD"
},
...
]