Pular para o conteúdo principal

Produtos

Cadastro de produtos e serviços usados em negócios, propostas, contratos e notas.

Produtos​

Recurso do plano: Produtos e Serviços.

MétodoRotaO que faz
GET/external/v1/productsLista com paginação
GET/external/v1/products/:idBusca um registro pelo ID
POST/external/v1/productsCria um registro
PUT/external/v1/products/:idAtualiza um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"productType":"SERVICE"}}):

curl -G "https://erp-api.ideros.api.br/external/v1/products" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"productType":"SERVICE"}}'

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/products/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
codestringNãoCódigo único de identificação do produto/serviço na empresa. Se vazio, será gerado automaticamente.
titlestringSimNome comercial ou título do produto/serviço.
descriptionstringNãoDescrição detalhada do produto ou serviço.
tagsstring[]NãoTags para categorizar e filtrar o produto/serviço.
productTypeenumSimTipo de produto/serviço. Valores: LABOR, SERVICE, PARTS, OTHERS.
unitstringNãoUnidade de medida do produto (UN, HR, KG, M, M2, M3, L, CX, PCT, SV, etc.).
imageUrlstringNãoURL da imagem principal do produto (S3).
thumbnailUrlstringNãoURL do thumbnail do produto.
brandstringNãoMarca do produto.
manufacturerstringNãoFabricante do produto.
productCategoryIdstringNãoID de categoria de produto.
barcodestringNãoCódigo de barras (EAN-13, EAN-8, etc.).
skustringNãoSKU interno (Stock Keeping Unit).
ncmstringNãoNCM fiscal (Nomenclatura Comum do Mercosul, 8 dígitos).
cfopstringNãoCFOP fiscal (Código Fiscal de Operações e Prestações, 4 dígitos).
originenumNãoOrigem da mercadoria (padrão SEFAZ, 1 dígito). Consulte GET /system-lookup/product-origin para a lista completa traduzida. Default: '0' (Nacional). Valores: 0, 1, 2, 3, 4, 5, 6, 7, 8.
isStockControlledbooleanNãoSe verdadeiro, habilita controle de saldo em estoque para este produto.
minimumStocknumberNãoEstoque mínimo para alerta.
maximumStocknumberNãoEstoque máximo.
defaultDurationMinutesnumberNãoDuração padrão do serviço em minutos (usado na Booking Page).
weightnumberNãoPeso do produto em quilogramas.
widthnumberNãoLargura do produto em centímetros.
heightnumberNãoAltura do produto em centímetros.
depthnumberNãoProfundidade do produto em centímetros.
serviceCodestringNãoCódigo do serviço conforme LC 116/2003. Obrigatório para NFS-e.
ceststringNãoCódigo Especificador da Substituição Tributária (CEST). Obrigatório quando produto está sujeito a ICMS-ST.
fiscalGroupIdstringNãoID de grupo fiscal. Centraliza a classificação tributária do produto.
ibsCbsCststringNãoCST do IBS/CBS (3 dígitos), da tabela oficial de CST (IT 2025.002). Nulo = herda.
ibsCbsClassTribstringNãoCódigo de classificação tributária do IBS/CBS (cClassTrib, 6 dígitos), da tabela oficial (IT 2025.002). Precisa pertencer ao CST informado. Nulo = herda.
ibsCbsIndOpstringNãoIndicador da operação do IBS/CBS (indOp, 6 dígitos, Anexo VII da NFS-e). Só para serviço. Nulo = herda ou vem da sugestão oficial.
ibsCbsOnerousbooleanNãoIndica se a operação é onerosa (com contraprestação). Muda o indOp (regra do Anexo VIII). Só para serviço.
ibsCbsAcquirerAbroadbooleanNãoIndica se o adquirente está no exterior. Muda o indOp (regra do Anexo VIII). Nulo = deduz do país do tomador.
isCststringNãoCST do Imposto Seletivo (3 dígitos). Só para produto sujeito ao IS.
isClassTribstringNãoClassificação tributária do Imposto Seletivo (6 dígitos). Só para produto sujeito ao IS.
isRatenumberNãoAlíquota ad valorem do Imposto Seletivo em fração decimal (ex.: 0.1 = 10%).
isSpecificRatenumberNãoAlíquota específica do Imposto Seletivo em reais por unidade tributável.
isUnitstringNãoUnidade tributável do Imposto Seletivo (ex.: LT, KG, UN).
simplesActivityCodestringNãoCódigo da atividade no Simples Nacional (cAtvSN, NT SE/CGNFS-e 009): 7 a 14 ou 90. Usado pela NFS-e do optante a partir de 2027.
taxReformPriceModeenumNãoComo o preço trata o IBS/CBS: ADDED = tributo acrescido ao preço; INCLUDED = embutido no preço. Nulo = herda da configuração fiscal da empresa. Valores: ADDED, INCLUDED.
issWithheldbooleanNãoIndica se o ISS é retido na fonte por padrão para este produto. Pode ser sobrescrito no item da nota.
partNumberstringNãoCódigo de peça do fabricante. Útil para revenda de componentes.
gtinstringNãoGTIN/EAN para NF-e. Quando produto não tem GTIN, o padrão na NF-e é enviar "SEM GTIN".
extipiCodestringNãoCódigo EX da TIPI para produtos com alíquota de IPI diferenciada.
curl -X POST "https://erp-api.ideros.api.br/external/v1/products" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Consultoria em TI",
"productType": "SERVICE"
}'

Atualizar​

Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.

Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.