URL para consumir a API: https://api.comexnfe.com.br/api/v2/produtos.json
Verbo HTTP: GET
Clique aqui para saber como encontrar a chave de acesso.
Parâmetros opcionais:
codigo: Filtro por código, deve ser idêntico
descricao: Filtro por descrição, pode estar no início, no meio ou no fim
zerados: Ao ser incluído, retorna também os produtos sem quantidade em estoque.
ativos: Ao ser incluído, exibe apenas os produtos ativos no estoque. Por padrão, produtos inativos também são exibidos.
ultima_modificacao: Filtro por data de modificação. Apenas os produtos com data de modificação superior à data informada serão exibidos. O formato da data deve ser YYYY-MM-dd HH:mm:ss
integracao: Exibe atributos específicos para integrações com e-commerces. Abaixo, há mais detalhes
page: Página da busca
Paginação:
Para que a performance do servidor não seja afetada, todas as chamadas são paginadas a cada 100 itens. O JSON retornado possui as informações de paginação, como exemplificado abaixo, com as informações das páginas e do total.
Parâmetros obrigatórios:
api_key: A chave de acesso à API
Formato do retorno:
{ "pagination": { "next_page": "/api/v2/produtos?api_key=&page=2", // Também há um atributo "previous_page" "total": }, "produtos": [ // Primeiro item { "codigo": "0001", // Código "descricao": "Produto Teste", // Descrição "pu": 80.0, // Preço Unitário de Entrada "pu_saida": 150.0, // Preço Unitário de Saída "qtde": 1.0, // Quantidade em estoque "qtde_comprometida": 0.0 // Quantidade comprometida em pedidos "gtin": "7891111222226", "codigo_de_barras_interno": "978020137962", "ncm":"85369010", "ativo": true, "ultima_modificacao":"2017-06-09T07:43:27.745-03:00"}, { "codigo": "TST02", "descricao": "Produto Teste 2", "pu": 3.5527, "pu_saida": 9.0, "qtde": 10.0, "qtde_comprometida": 5.0, "gtin": "7891111222226", "codigo_de_barras_interno": null, "ncm":"85369010", "ativo": true, "ultima_modificacao":"2017-06-09T07:43:27.745-03:00" }, { "codigo": "PROD03", "descricao": "Produto Teste 3", "pu": 37.54, "pu_saida": 66.0, "qtde": 1.0, "qtde_comprometida": 0.0, "gtin": "7891111222226", "codigo_de_barras_interno": "978020137962", "ncm":"85369010", "ativo": true, "ultima_modificacao":"2017-06-09T07:43:27.745-03:00" } ]}Integrações
É possível solicitar informações específicas para uma integração. Por padrão, são exibidas apenas informações genéricas do produto. Para buscar informações específicas de um ecommerce, é preciso passar o parâmetro opcional integracao com a integração desejada.
Xtech
Ao fazer a requisição com o parâmetro integracao=xtech, é retornado um novo objeto xtech para cada um dos produtos, com suas respectivas categorias e características, ambas num array de strings.
Por exemplo, na requisição:
GET /api/v2/produtos.json?api_key=<API_KEY>&integracao=xtech
Teremos uma resposta parecida com a seguinte:
{
"produtos": [
{
"id": 551590,
"codigo": "001",
"descricao": "LAMPADA LED AZUL",
"informacoes_complementares": "",
"descricao_completa": null,
"peso_liquido": null,
"peso_bruto": null,
"pu": 10.47,
"pu_saida": 30.0,
"qtde": 5,
"qtde_comprometida": 0,
"qtde_armazenada": 0,
"gtin": null,
"codigo_de_barras_interno": null,
"ncm": "85392200",
"ativo": true,
"ultima_modificacao": "2018-07-27T17:31:33.085-03:00",
"xtech": {
"caracteristicas": [],
"categorias": ["1196452", "1196453", "1196454"]
}
},
{
"id": 1096911,
"codigo": "01576081",
"descricao": "LAMPADA LED BRANCO FRIO",
"informacoes_complementares": "",
"descricao_completa": null,
"peso_liquido": null,
"peso_bruto": null,
"pu": 30.0,
"pu_saida": 40.0,
"qtde": 6,
"qtde_comprometida": 0,
"qtde_armazenada": 0,
"gtin": null,
"codigo_de_barras_interno": null,
"ncm": "85437099",
"ativo": true,
"ultima_modificacao": "2018-07-27T17:31:33.264-03:00",
"xtech": {
"caracteristicas": ["1050672"],
"categorias": ["1196452", "1196453", "1196455"]
}
}
],
"pagination": {
"total": 590,
"next_page": "/api/v2/produtos?api_key=&integracao=xtech&page=2&per_page=1"
}
}