OmieapiDocumentaçãoOperações
← Referência das operações

IncluirProdutoaltera dados

Incluir um produto.

Identificação

Operaçãogeral/produtos:IncluirProduto
ServiçoProdutosCadastro
MóduloGeral
Endpoint/api/v1/geral/produtos/

Como as pessoas pedem isso

incluir produto

Parâmetros

CampoTipoDescrição
aliquota_cbslista de numberAlíquota da CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
aliquota_cofinsnumberAlíquota do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
aliquota_ibptnumberDEPRECATED.
aliquota_ibs_munlista de numberAlíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
aliquota_ibs_uflista de numberAlíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
aliquota_icmsnumberAlíquota de ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
aliquota_pisnumberAlíquota do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
alturanumberAltura (centimentos). Preenchimento Opcional. Localizado na aba "Informações Adicionais"
armamentoobjectDetalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação.
bloqueadostringIndica se o registro está bloqueado (S/N). Preenchimento Opcional.
bloquear_exclusaostringIndica se a exclusão do registro está bloqueada (S/N). Preenchimento Opcional.
caracteristicaslista de objectlista de caracteristicas do produto.
ceststringDEPRECATED.
cfopstringCFOP do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
class_triblista de stringCódigo de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
codInt_familiastringCódigo de Integração da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV.
codigo obrigatóriostringCódigo do Produto. É um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie. Não recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag "codigo_produto".
codigo_beneficiostringCódigo do Beneficio Fiscal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
codigo_familiaintegerCódigo da Familia do Produto. Preenchimento Opcional.
codigo_produtointegerCódigo do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Esse campo não deve ser informado na inclusão de produtos. Essa informação não será exibida nas telas do Omie.
codigo_produto_integracao obrigatóriostringCódigo de integração do produto. É o código do produto no aplicativo que você está integrando ao Omie. É utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. O preenchimento desse campo é obrigatório na inclusão de produtos. Essa informação não será exibida nas telas do Omie.
combustivelobjectDetalhamento específico para cadastro de combustíveis.
componentes_kitlista de objectComponetes do KIT.
csosn_icmsstringCódigo da Situação Tributária para Simples Nacional. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
cst_cofinsstringCódigo da Situação Tributária do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
cst_ibs_cbslista de stringCódigo de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
cst_icmsstringCódigo da Situação Tributária do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
cst_pisstringCódigo da Situação Tributária do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
dadosIbptobjectDados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV.
descr_detalhadastringDescrição Detalhada para o Produto. Preenchimento Opcional.
descricao obrigatóriostringDescrição do produto. Preenchimento Obrigatório na inclusão.
descricao_familiastringDescrição da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV.
dias_crossdockingintegerDias de Crossdocking. Preenchimento Opcional. Localizado na aba "Informações Adicionais"
dias_garantiaintegerDias de Garantia. Preenchimento Opcional. Localizado na aba "Informações Adicionais"
eanstringCódigo EAN (GTIN - Global Trade Item Number). Preenchimento Opcional.
estoque_minimonumberDEPRECATED.
exibir_descricao_nfestringIndica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N).
exibir_descricao_pedidostringIndica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N).
id_produto_variacaolista de integerCódigo interno do produto variação que deu origem a variação. Campo disponível apenas para consulta. No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'.
imagenslista de objectLista de imagens do produto.
importado_apistringIndica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração.
inativostringIndica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração.
infoobjectInformações complemetares do cadastro do produto.
larguranumberLargura (centimetros) Preenchimento Opcional. Localizado na aba "Informações Adicionais"
lead_timeintegerLead Time médio de ressuprimento em dias.
marcastringMarca. Preenchimento Opcional. Localizado na aba "Informações Adicionais"
medicamento obrigatórioobjectDetalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos
modalidade_icmsstringModalidade da Base de Cálculo do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
modelostringModelo. Preenchimento Opcional. Localizado na aba "Informações Adicionais"
motivo_deson_icmsstringMotivo da desoneração do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
ncm obrigatóriostringCódigo da Nomenclatura Comum do Mercosul (NCM). Preenchimento Obrigatório na Inclusão.
obs_internasstringObservações Internas. (ficam registradas apenas no cadastro do produto). Preenchimento Opcional.
origem_impostostringOrigem do Imposto "NCM" ou "PRD" Esse campo não deve ser informado na inclusão ou alteração. Finalidade: Indicar se a regra de imposto utilizada pelos PDV"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto.
per_icms_fcpnumberPercentual do Fundo de Combate a Pobreza do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
perc_reducao_cbslista de numberPercentual da redução de alíquota do CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
perc_reducao_ibs_munlista de numberPercentual da redução de alíquota IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
perc_reducao_ibs_uflista de numberPercentual da redução de alíquota do IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
peso_brutonumberPeso Bruto (Kg). Preenchimento Opcional. Localizado na aba "Informações Adicionais"
peso_liqnumberPeso Líquido (Kg). Preenchimento Opcional. Localizado na aba "Informações Adicionais"
produto_lotelista de stringIndica se o produto possui lote. (S/N) .
produto_variacaolista de stringIndica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) .
profundidadenumberProfundidade (centimetros). Preenchimento Opcional. Localizado na aba "Informações Adicionais"
quantidade_estoquenumberDEPRECATED.
recomendacoes_fiscaisobjectRecomendações Fiscais.
red_base_cofinsnumberPercentual de redução de base do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
red_base_icmsnumberPercentual de redução de base do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
red_base_pisnumberPercentual de redução de base do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão.
tabelas_precolista de objectLista de tabelas de preço.
tipoItemlista de stringCódigo do Tipo do Item para o SPED. Preenchimento Opcional. Pode ser: 00 - Mercadoria para Revenda 01 - Matéria Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros Insumos 99 - Outras
unidade obrigatóriostringCódigo da Unidade. Preenchimento Obrigatório.
valor_unitarionumberPreço Unitário de Venda. Preenchimento Obrigatório.
variacaolista de stringIndica se o Produto é uma variação de produto. (S/N) . No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'.
veiculoobjectDetalhamento específico para cadastro de veículos
videoslista de objectLista de videos do produto.

Exemplo de chamada

{
  "codigo_produto_integracao": "#TS#",
  "codigo": "teste0001",
  "descricao": "Produto de teste",
  "unidade": "UN"
}
Esta operação altera dados de verdade, na hora. Não existe ambiente de ensaio neste endereço.
api.omie.com.br/mcp · Documentação · Operações