IncluirProdutoaltera dadosIncluir um produto.
| Operação | geral/produtos:IncluirProduto |
|---|---|
| Serviço | ProdutosCadastro |
| Módulo | Geral |
| Endpoint | /api/v1/geral/produtos/ |
incluir produto
| Campo | Tipo | Descrição |
|---|---|---|
aliquota_cbs | lista de number | Alí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_cofins | number | Alí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_ibpt | number | DEPRECATED. |
aliquota_ibs_mun | lista de number | Alí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_uf | lista de number | Alí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_icms | number | Alí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_pis | number | Alí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. |
altura | number | Altura (centimentos). Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
armamento | object | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
bloqueado | string | Indica se o registro está bloqueado (S/N). Preenchimento Opcional. |
bloquear_exclusao | string | Indica se a exclusão do registro está bloqueada (S/N). Preenchimento Opcional. |
caracteristicas | lista de object | lista de caracteristicas do produto. |
cest | string | DEPRECATED. |
cfop | string | CFOP 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_trib | lista de string | Có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_familia | string | Có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ório | string | Có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_beneficio | string | Có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_familia | integer | Código da Familia do Produto. Preenchimento Opcional. |
codigo_produto | integer | Có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ório | string | Có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. |
combustivel | object | Detalhamento específico para cadastro de combustíveis. |
componentes_kit | lista de object | Componetes do KIT. |
csosn_icms | string | Có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_cofins | string | Có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_cbs | lista de string | Có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_icms | string | Có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_pis | string | Có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. |
dadosIbpt | object | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
descr_detalhada | string | Descrição Detalhada para o Produto. Preenchimento Opcional. |
descricao obrigatório | string | Descrição do produto. Preenchimento Obrigatório na inclusão. |
descricao_familia | string | Descrição da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dias_crossdocking | integer | Dias de Crossdocking. Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
dias_garantia | integer | Dias de Garantia. Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
ean | string | Código EAN (GTIN - Global Trade Item Number). Preenchimento Opcional. |
estoque_minimo | number | DEPRECATED. |
exibir_descricao_nfe | string | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
exibir_descricao_pedido | string | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
id_produto_variacao | lista de integer | Có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'. |
imagens | lista de object | Lista de imagens do produto. |
importado_api | string | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
inativo | string | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
info | object | Informações complemetares do cadastro do produto. |
largura | number | Largura (centimetros) Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
lead_time | integer | Lead Time médio de ressuprimento em dias. |
marca | string | Marca. Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
medicamento obrigatório | object | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
modalidade_icms | string | Modalidade 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. |
modelo | string | Modelo. Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
motivo_deson_icms | string | Motivo 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ório | string | Código da Nomenclatura Comum do Mercosul (NCM). Preenchimento Obrigatório na Inclusão. |
obs_internas | string | Observações Internas. (ficam registradas apenas no cadastro do produto). Preenchimento Opcional. |
origem_imposto | string | Origem 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_fcp | number | Percentual 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_cbs | lista de number | Percentual 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_mun | lista de number | Percentual 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_uf | lista de number | Percentual 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_bruto | number | Peso Bruto (Kg). Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
peso_liq | number | Peso Líquido (Kg). Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
produto_lote | lista de string | Indica se o produto possui lote. (S/N) . |
produto_variacao | lista de string | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
profundidade | number | Profundidade (centimetros). Preenchimento Opcional. Localizado na aba "Informações Adicionais" |
quantidade_estoque | number | DEPRECATED. |
recomendacoes_fiscais | object | Recomendações Fiscais. |
red_base_cofins | number | Percentual 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_icms | number | Percentual 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_pis | number | Percentual 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_preco | lista de object | Lista de tabelas de preço. |
tipoItem | lista de string | Có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ório | string | Código da Unidade. Preenchimento Obrigatório. |
valor_unitario | number | Preço Unitário de Venda. Preenchimento Obrigatório. |
variacao | lista de string | Indica 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'. |
veiculo | object | Detalhamento específico para cadastro de veículos |
videos | lista de object | Lista de videos do produto. |
{
"codigo_produto_integracao": "#TS#",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}