Geral ·
ProdutosCadastroCadastro de Produtos
3consultas
6alterações
Claude 9 de 9 · ChatGPT 3 de 9 · MCP 9 de 9pelos assistentes de IA
JSON · XMLformato
Altera um produto já cadastrado.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto_integracao | texto · até 60 | 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. |
medicamento | objeto | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
medicamento.cod_anvisa | texto · até 13 | Código de produto Anvisa |
medicamento.preco_max_cons | número | Preço máximo consumidor |
Opcionais 72Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aliquota_cbs | número | 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 | número | 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 | número | DEPRECATED. |
aliquota_ibs_mun | número | 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 | número | 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 | número | 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 | número | 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 | número | Altura (centimentos). Localizado na aba "Informações Adicionais" |
armamento | objeto | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
armamento.descr_arma | texto · até 256 | Descrição completa da arma |
armamento.serie_arma | texto · até 15 | Número de série da arma |
armamento.serie_cano | texto · até 15 | Número de série do cano |
armamento.tipo_arma | texto · até 1 | Indicador do tipo de arma de fogo |
bloqueado | texto · até 1 | Indica se o registro está bloqueado (S/N). |
bloquear_exclusao | texto · até 1 | Indica se a exclusão do registro está bloqueada (S/N). |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto · até 20 | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto · até 60 | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto · até 1 | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto · até 30 | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
cest | texto · até 9 | DEPRECATED. |
cfop | texto · até 10 | 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 | texto · até 6 | 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 | texto · até 20 | 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 | texto · até 60 | 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 | texto · até 20 | 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 | número inteiro | Código da Familia do Produto. |
codigo_produto | número inteiro | 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. |
combustivel | objeto | Detalhamento específico para cadastro de combustíveis. |
combustivel.codigo_anp | texto · até 9 | Código de Produto da ANP. |
combustivel.descr_anp | texto · até 95 | Descrição do Produto conforme ANP. |
combustivel.percent_gas_imp | número | Percentual de Gás Natural Importado. |
combustivel.percent_gas_nac | número | Percentual de Gás Natural Nacional. |
combustivel.percent_glp | número | Percentual de GLP Derivado do Petróleo. |
combustivel.valor_part | número | Valor de partida |
componentes_kit | lista de objetos | Componetes do KIT. |
componentes_kit[].codigo_componente | número inteiro | Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie. |
componentes_kit[].codigo_produto_componente | número inteiro | Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. |
componentes_kit[].local_estoque_componente | número inteiro | Local estoque do componente. |
componentes_kit[].quantidade_componente | número | Quantidade do componente. |
componentes_kit[].valor_unitario_componente | número | Valor unitário do componente. |
csosn_icms | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 2 | 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 | objeto | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqEstadual | número | Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqFederal | número | Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqMunicipal | número | Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.chave | texto · até 6 | Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.fonte | texto · até 34 | Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_ate | texto · até 10 | Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_de | texto · até 10 | Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.versao | texto · até 6 | Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
descr_detalhada | texto | Descrição Detalhada para o Produto. |
descricao | texto · até 120 | Descrição do produto. |
descricao_familia | texto · até 50 | 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 | número inteiro | Dias de Crossdocking. Localizado na aba "Informações Adicionais" |
dias_garantia | número inteiro | Dias de Garantia. Localizado na aba "Informações Adicionais" |
ean | texto · até 14 | Código EAN (GTIN - Global Trade Item Number). |
estoque_minimo | número | DEPRECATED. |
exibir_descricao_nfe | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
exibir_descricao_pedido | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
id_produto_variacao | número inteiro | 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 objetos | Lista de imagens do produto. |
imagens[].url_imagem | texto | URL da Imagem do produto. |
importado_api | texto · até 1 | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
inativo | texto · até 1 | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
largura | número | Largura (centimetros) Localizado na aba "Informações Adicionais" |
lead_time | número inteiro | Lead Time médio de ressuprimento em dias. |
marca | texto · até 60 | Marca. Localizado na aba "Informações Adicionais" |
modalidade_icms | texto · até 1 | 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 | texto · até 60 | Modelo. Localizado na aba "Informações Adicionais" |
motivo_deson_icms | texto · até 2 | 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 | texto · até 13 | Código da Nomenclatura Comum do Mercosul (NCM). |
obs_internas | texto | Observações Internas. (ficam registradas apenas no cadastro do produto). |
origem_imposto | texto · até 10 | 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 | número | 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 | número | Percentual da redução de 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. |
perc_reducao_ibs_mun | número | 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 | número | 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 | número | Peso Bruto (Kg). Localizado na aba "Informações Adicionais" |
peso_liq | número | Peso Líquido (Kg). Localizado na aba "Informações Adicionais" |
produto_lote | texto · até 1 | Indica se o produto possui lote. (S/N) . |
produto_variacao | texto · até 1 | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
profundidade | número | Profundidade (centimetros). Localizado na aba "Informações Adicionais" |
quantidade_estoque | número | DEPRECATED. |
recomendacoes_fiscais | objeto | Recomendações Fiscais. |
recomendacoes_fiscais.cnpj_fabricante | texto · até 20 | CNPJ do Fabricante da Mercadoria. |
recomendacoes_fiscais.cupom_fiscal | texto · até 1 | Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com "S" ou "N". |
recomendacoes_fiscais.id_cest | texto · até 9 | Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99 |
recomendacoes_fiscais.id_preco_tabelado | número inteiro | ID do Preço tabelado (Pauta). |
recomendacoes_fiscais.indicador_escala | texto · até 1 | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
recomendacoes_fiscais.market_place | texto · até 1 | Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com "S" ou "N". |
recomendacoes_fiscais.origem_mercadoria | texto · até 1 | Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 1 - Estrangeira - Importação direta, 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 e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70 |
red_base_cofins | número | 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 | número | 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 | número | 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 objetos | Lista de tabelas de preço. |
tabelas_preco[].cNomeTabPreco | texto · até 50 | Nome da tabela de preço. |
tabelas_preco[].nCodTabPreco | número inteiro | Id da tabela de preço. |
tabelas_preco[].nValorTabPreco | número | Valor do produto na tabela de preço. |
tipoItem | texto · até 2 | Código do Tipo do Item para o SPED. 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 | texto · até 6 | Código da Unidade. |
valor_unitario | número | Preço Unitário de Venda. |
variacao | texto · até 1 | 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 | objeto | Detalhamento específico para cadastro de veículos |
veiculo.ano_fabr | texto · até 4 | |
veiculo.ano_modelo | texto · até 4 | Ano modelo de fabricação |
veiculo.chassi | texto · até 17 | Chassi do veículo |
veiculo.cilin | texto · até 4 | Cilindradas |
veiculo.cmt | texto · até 9 | Capacidade máxima de tração |
veiculo.cod_cor_den | texto · até 2 | Código da cor DENATRAN |
veiculo.cod_cor_veic | texto · até 4 | Código da cor do veículo |
veiculo.cod_modelo | texto · até 6 | Código marca modelo |
veiculo.cond_veic | texto · até 1 | Condição do veículo |
veiculo.cond_vin | texto · até 1 | Condição do VIN |
veiculo.descr_cor | texto · até 40 | Descrição da cor |
veiculo.dist_eixo | texto · até 4 | Distância entre eixos |
veiculo.especie_veic | texto · até 1 | Espécie do veículo |
veiculo.lota_max | texto · até 3 | Capacidade máxima de lotação |
veiculo.motor | texto · até 21 | Número do motor |
veiculo.peso_bruto_veic | texto · até 9 | Peso bruto |
veiculo.peso_liquido_veic | texto · até 9 | Peso líquido |
veiculo.potencia | texto · até 4 | Potência motor |
veiculo.serie_veic | texto · até 9 | Série do veículo |
veiculo.tipo_comb | texto · até 2 | Tipo de combustível |
veiculo.tipo_oper | texto · até 1 | Tipo da operação |
veiculo.tipo_pintura | texto · até 1 | Tipo de pintura |
veiculo.tipo_restricao | texto · até 1 | Restrição |
veiculo.tipo_veic | texto · até 2 | Tipo de veículo de acordo com a tabela RENAVAM |
videos | lista de objetos | Lista de videos do produto. |
videos[].url_video | texto | URL do Video do produto. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarProduto", "param": [{"codigo_produto_integracao": "1790774103", "codigo": "teste0001", "descricao": "Produto de teste", "unidade": "UN"}]}'import os
import requests
corpo = {'call': 'AlterarProduto',
'param': [{'codigo_produto_integracao': '1790774103',
'codigo': 'teste0001',
'descricao': 'Produto de teste',
'unidade': 'UN'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "AlterarProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarProduto"", ""param"": [{""codigo_produto_integracao"": ""1790774103"", ""codigo"": ""teste0001"", ""descricao"": ""Produto de teste"", ""unidade"": ""UN""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosAtiva ou inativa o cadastro de um produto.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
inativo | texto · até 1 | Situação desejada para o cadastro. "S" inativa o produto e "N" o ativa. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | |
codigo_produto_integracao | texto | |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarSituacaoProduto", "param": [{"codigo_produto": 0, "codigo_produto_integracao": "", "codigo": "", "inativo": "N"}]}'import os
import requests
corpo = {'call': 'AlterarSituacaoProduto',
'param': [{'codigo_produto': 0,
'codigo_produto_integracao': '',
'codigo': '',
'inativo': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarSituacaoProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": "",
"inativo": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarSituacaoProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": "",
"inativo": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "AlterarSituacaoProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": "",
"inativo": "N"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarSituacaoProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": "",
"inativo": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarSituacaoProduto"", ""param"": [{""codigo_produto"": 0, ""codigo_produto_integracao"": """", ""codigo"": """", ""inativo"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosAssocia um código de integração do produto.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
Opcionais 1Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AssociarCodIntProduto", "param": [{"codigo_produto": 0, "codigo_produto_integracao": ""}]}'import os
import requests
corpo = {'call': 'AssociarCodIntProduto',
'param': [{'codigo_produto': 0, 'codigo_produto_integracao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AssociarCodIntProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AssociarCodIntProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "AssociarCodIntProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AssociarCodIntProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AssociarCodIntProduto"", ""param"": [{""codigo_produto"": 0, ""codigo_produto_integracao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta um produto.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto_integracao | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
Retorno 74O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
aliquota_cbs | decimal | 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 | decimal | 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 | decimal | DEPRECATED. |
aliquota_ibs_mun | decimal | 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 | decimal | 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 | decimal | 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 | decimal | 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 | decimal | Altura (centimentos). Localizado na aba "Informações Adicionais" |
armamento | objeto | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
armamento.descr_arma | texto | Descrição completa da arma |
armamento.serie_arma | texto | Número de série da arma |
armamento.serie_cano | texto | Número de série do cano |
armamento.tipo_arma | texto | Indicador do tipo de arma de fogo |
bloqueado | texto | Indica se o registro está bloqueado (S/N). |
bloquear_exclusao | texto | Indica se a exclusão do registro está bloqueada (S/N). |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
cest | texto | DEPRECATED. |
cfop | texto | 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 | texto | 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 | texto | 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 | texto | 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 | texto | 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 | número inteiro | Código da Familia do Produto. |
codigo_produto | número inteiro | 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 | texto | 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 | objeto | Detalhamento específico para cadastro de combustíveis. |
combustivel.codigo_anp | texto | Código de Produto da ANP. |
combustivel.descr_anp | texto | Descrição do Produto conforme ANP. |
combustivel.percent_gas_imp | decimal | Percentual de Gás Natural Importado. |
combustivel.percent_gas_nac | decimal | Percentual de Gás Natural Nacional. |
combustivel.percent_glp | decimal | Percentual de GLP Derivado do Petróleo. |
combustivel.valor_part | decimal | Valor de partida |
componentes_kit | lista de objetos | Componetes do KIT. |
componentes_kit[].codigo_componente | número inteiro | Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie. |
componentes_kit[].codigo_produto_componente | número inteiro | Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. |
componentes_kit[].local_estoque_componente | número inteiro | Local estoque do componente. |
componentes_kit[].quantidade_componente | decimal | Quantidade do componente. |
componentes_kit[].valor_unitario_componente | decimal | Valor unitário do componente. |
csosn_icms | texto | 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 | texto | 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 | texto | 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 | texto | 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 | texto | 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 | objeto | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqEstadual | decimal | Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqFederal | decimal | Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqMunicipal | decimal | Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.chave | texto | Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.fonte | texto | Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_ate | texto | Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_de | texto | Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.versao | texto | Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
descr_detalhada | texto | Descrição Detalhada para o Produto. |
descricao | texto | Descrição do produto. |
descricao_familia | texto | 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 | número inteiro | Dias de Crossdocking. Localizado na aba "Informações Adicionais" |
dias_garantia | número inteiro | Dias de Garantia. Localizado na aba "Informações Adicionais" |
ean | texto | Código EAN (GTIN - Global Trade Item Number). |
estoque_minimo | decimal | DEPRECATED. |
exibir_descricao_nfe | texto | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
exibir_descricao_pedido | texto | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
id_produto_variacao | número inteiro | 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 objetos | Lista de imagens do produto. |
imagens[].url_imagem | texto | URL da Imagem do produto. |
importado_api | texto | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
inativo | texto | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
largura | decimal | Largura (centimetros) Localizado na aba "Informações Adicionais" |
lead_time | número inteiro | Lead Time médio de ressuprimento em dias. |
marca | texto | Marca. Localizado na aba "Informações Adicionais" |
medicamento | objeto | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
medicamento.cod_anvisa | texto | Código de produto Anvisa |
medicamento.preco_max_cons | decimal | Preço máximo consumidor |
modalidade_icms | texto | 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 | texto | Modelo. Localizado na aba "Informações Adicionais" |
motivo_deson_icms | texto | 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 | texto | Código da Nomenclatura Comum do Mercosul (NCM). |
obs_internas | texto | Observações Internas. (ficam registradas apenas no cadastro do produto). |
origem_imposto | texto | 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 | decimal | 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 | decimal | Percentual da redução de 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. |
perc_reducao_ibs_mun | decimal | 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 | decimal | 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 | decimal | Peso Bruto (Kg). Localizado na aba "Informações Adicionais" |
peso_liq | decimal | Peso Líquido (Kg). Localizado na aba "Informações Adicionais" |
produto_lote | texto | Indica se o produto possui lote. (S/N) . |
produto_variacao | texto | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
profundidade | decimal | Profundidade (centimetros). Localizado na aba "Informações Adicionais" |
quantidade_estoque | decimal | DEPRECATED. |
recomendacoes_fiscais | objeto | Recomendações Fiscais. |
recomendacoes_fiscais.cnpj_fabricante | texto | CNPJ do Fabricante da Mercadoria. |
recomendacoes_fiscais.cupom_fiscal | texto | Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com "S" ou "N". |
recomendacoes_fiscais.id_cest | texto | Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99 |
recomendacoes_fiscais.id_preco_tabelado | número inteiro | ID do Preço tabelado (Pauta). |
recomendacoes_fiscais.indicador_escala | texto | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
recomendacoes_fiscais.market_place | texto | Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com "S" ou "N". |
recomendacoes_fiscais.origem_mercadoria | texto | Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 1 - Estrangeira - Importação direta, 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 e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70 |
red_base_cofins | decimal | 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 | decimal | 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 | decimal | 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 objetos | Lista de tabelas de preço. |
tabelas_preco[].cNomeTabPreco | texto | Nome da tabela de preço. |
tabelas_preco[].nCodTabPreco | número inteiro | Id da tabela de preço. |
tabelas_preco[].nValorTabPreco | decimal | Valor do produto na tabela de preço. |
tipoItem | texto | Código do Tipo do Item para o SPED. 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 | texto | Código da Unidade. |
valor_unitario | decimal | Preço Unitário de Venda. |
variacao | texto | 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 | objeto | Detalhamento específico para cadastro de veículos |
veiculo.ano_fabr | texto | |
veiculo.ano_modelo | texto | Ano modelo de fabricação |
veiculo.chassi | texto | Chassi do veículo |
veiculo.cilin | texto | Cilindradas |
veiculo.cmt | texto | Capacidade máxima de tração |
veiculo.cod_cor_den | texto | Código da cor DENATRAN |
veiculo.cod_cor_veic | texto | Código da cor do veículo |
veiculo.cod_modelo | texto | Código marca modelo |
veiculo.cond_veic | texto | Condição do veículo |
veiculo.cond_vin | texto | Condição do VIN |
veiculo.descr_cor | texto | Descrição da cor |
veiculo.dist_eixo | texto | Distância entre eixos |
veiculo.especie_veic | texto | Espécie do veículo |
veiculo.lota_max | texto | Capacidade máxima de lotação |
veiculo.motor | texto | Número do motor |
veiculo.peso_bruto_veic | texto | Peso bruto |
veiculo.peso_liquido_veic | texto | Peso líquido |
veiculo.potencia | texto | Potência motor |
veiculo.serie_veic | texto | Série do veículo |
veiculo.tipo_comb | texto | Tipo de combustível |
veiculo.tipo_oper | texto | Tipo da operação |
veiculo.tipo_pintura | texto | Tipo de pintura |
veiculo.tipo_restricao | texto | Restrição |
veiculo.tipo_veic | texto | Tipo de veículo de acordo com a tabela RENAVAM |
videos | lista de objetos | Lista de videos do produto. |
videos[].url_video | texto | URL do Video do produto. |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarProduto", "param": [{"codigo_produto": 0, "codigo_produto_integracao": "", "codigo": ""}]}'import os
import requests
corpo = {'call': 'ConsultarProduto',
'param': [{'codigo_produto': 0, 'codigo_produto_integracao': '', 'codigo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ConsultarProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "ConsultarProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ConsultarProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarProduto"", ""param"": [{""codigo_produto"": 0, ""codigo_produto_integracao"": """", ""codigo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExclui um produto
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto_integracao | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirProduto", "param": [{"codigo_produto": 0, "codigo_produto_integracao": "", "codigo": ""}]}'import os
import requests
corpo = {'call': 'ExcluirProduto',
'param': [{'codigo_produto': 0, 'codigo_produto_integracao': '', 'codigo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ExcluirProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "ExcluirProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ExcluirProduto",
"param": [
{
"codigo_produto": 0,
"codigo_produto_integracao": "",
"codigo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirProduto"", ""param"": [{""codigo_produto"": 0, ""codigo_produto_integracao"": """", ""codigo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosIncluir um produto.
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 60 | 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_produto_integracao | texto · até 60 | 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. |
descricao | texto · até 120 | Descrição do produto. |
medicamento | objeto | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
medicamento.cod_anvisa | texto · até 13 | Código de produto Anvisa |
medicamento.preco_max_cons | número | Preço máximo consumidor |
ncm | texto · até 13 | Código da Nomenclatura Comum do Mercosul (NCM). |
unidade | texto · até 6 | Código da Unidade. |
Opcionais 68Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aliquota_cbs | número | 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 | número | 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 | número | DEPRECATED. |
aliquota_ibs_mun | número | 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 | número | 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 | número | 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 | número | 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 | número | Altura (centimentos). Localizado na aba "Informações Adicionais" |
armamento | objeto | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
armamento.descr_arma | texto · até 256 | Descrição completa da arma |
armamento.serie_arma | texto · até 15 | Número de série da arma |
armamento.serie_cano | texto · até 15 | Número de série do cano |
armamento.tipo_arma | texto · até 1 | Indicador do tipo de arma de fogo |
bloqueado | texto · até 1 | Indica se o registro está bloqueado (S/N). |
bloquear_exclusao | texto · até 1 | Indica se a exclusão do registro está bloqueada (S/N). |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto · até 20 | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto · até 60 | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto · até 1 | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto · até 30 | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
cest | texto · até 9 | DEPRECATED. |
cfop | texto · até 10 | 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 | texto · até 6 | 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 | texto · até 20 | 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_beneficio | texto · até 20 | 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 | número inteiro | Código da Familia do Produto. |
codigo_produto | número inteiro | 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. |
combustivel | objeto | Detalhamento específico para cadastro de combustíveis. |
combustivel.codigo_anp | texto · até 9 | Código de Produto da ANP. |
combustivel.descr_anp | texto · até 95 | Descrição do Produto conforme ANP. |
combustivel.percent_gas_imp | número | Percentual de Gás Natural Importado. |
combustivel.percent_gas_nac | número | Percentual de Gás Natural Nacional. |
combustivel.percent_glp | número | Percentual de GLP Derivado do Petróleo. |
combustivel.valor_part | número | Valor de partida |
componentes_kit | lista de objetos | Componetes do KIT. |
componentes_kit[].codigo_componente | número inteiro | Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie. |
componentes_kit[].codigo_produto_componente | número inteiro | Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. |
componentes_kit[].local_estoque_componente | número inteiro | Local estoque do componente. |
componentes_kit[].quantidade_componente | número | Quantidade do componente. |
componentes_kit[].valor_unitario_componente | número | Valor unitário do componente. |
csosn_icms | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 2 | 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 | objeto | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqEstadual | número | Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqFederal | número | Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqMunicipal | número | Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.chave | texto · até 6 | Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.fonte | texto · até 34 | Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_ate | texto · até 10 | Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_de | texto · até 10 | Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.versao | texto · até 6 | Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
descr_detalhada | texto | Descrição Detalhada para o Produto. |
descricao_familia | texto · até 50 | 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 | número inteiro | Dias de Crossdocking. Localizado na aba "Informações Adicionais" |
dias_garantia | número inteiro | Dias de Garantia. Localizado na aba "Informações Adicionais" |
ean | texto · até 14 | Código EAN (GTIN - Global Trade Item Number). |
estoque_minimo | número | DEPRECATED. |
exibir_descricao_nfe | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
exibir_descricao_pedido | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
id_produto_variacao | número inteiro | 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 objetos | Lista de imagens do produto. |
imagens[].url_imagem | texto | URL da Imagem do produto. |
importado_api | texto · até 1 | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
inativo | texto · até 1 | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
largura | número | Largura (centimetros) Localizado na aba "Informações Adicionais" |
lead_time | número inteiro | Lead Time médio de ressuprimento em dias. |
marca | texto · até 60 | Marca. Localizado na aba "Informações Adicionais" |
modalidade_icms | texto · até 1 | 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 | texto · até 60 | Modelo. Localizado na aba "Informações Adicionais" |
motivo_deson_icms | texto · até 2 | 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. |
obs_internas | texto | Observações Internas. (ficam registradas apenas no cadastro do produto). |
origem_imposto | texto · até 10 | 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 | número | 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 | número | Percentual da redução de 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. |
perc_reducao_ibs_mun | número | 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 | número | 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 | número | Peso Bruto (Kg). Localizado na aba "Informações Adicionais" |
peso_liq | número | Peso Líquido (Kg). Localizado na aba "Informações Adicionais" |
produto_lote | texto · até 1 | Indica se o produto possui lote. (S/N) . |
produto_variacao | texto · até 1 | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
profundidade | número | Profundidade (centimetros). Localizado na aba "Informações Adicionais" |
quantidade_estoque | número | DEPRECATED. |
recomendacoes_fiscais | objeto | Recomendações Fiscais. |
recomendacoes_fiscais.cnpj_fabricante | texto · até 20 | CNPJ do Fabricante da Mercadoria. |
recomendacoes_fiscais.cupom_fiscal | texto · até 1 | Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com "S" ou "N". |
recomendacoes_fiscais.id_cest | texto · até 9 | Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99 |
recomendacoes_fiscais.id_preco_tabelado | número inteiro | ID do Preço tabelado (Pauta). |
recomendacoes_fiscais.indicador_escala | texto · até 1 | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
recomendacoes_fiscais.market_place | texto · até 1 | Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com "S" ou "N". |
recomendacoes_fiscais.origem_mercadoria | texto · até 1 | Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 1 - Estrangeira - Importação direta, 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 e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70 |
red_base_cofins | número | 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 | número | 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 | número | 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 objetos | Lista de tabelas de preço. |
tabelas_preco[].cNomeTabPreco | texto · até 50 | Nome da tabela de preço. |
tabelas_preco[].nCodTabPreco | número inteiro | Id da tabela de preço. |
tabelas_preco[].nValorTabPreco | número | Valor do produto na tabela de preço. |
tipoItem | texto · até 2 | Código do Tipo do Item para o SPED. 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 |
valor_unitario | número | Preço Unitário de Venda. |
variacao | texto · até 1 | 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 | objeto | Detalhamento específico para cadastro de veículos |
veiculo.ano_fabr | texto · até 4 | |
veiculo.ano_modelo | texto · até 4 | Ano modelo de fabricação |
veiculo.chassi | texto · até 17 | Chassi do veículo |
veiculo.cilin | texto · até 4 | Cilindradas |
veiculo.cmt | texto · até 9 | Capacidade máxima de tração |
veiculo.cod_cor_den | texto · até 2 | Código da cor DENATRAN |
veiculo.cod_cor_veic | texto · até 4 | Código da cor do veículo |
veiculo.cod_modelo | texto · até 6 | Código marca modelo |
veiculo.cond_veic | texto · até 1 | Condição do veículo |
veiculo.cond_vin | texto · até 1 | Condição do VIN |
veiculo.descr_cor | texto · até 40 | Descrição da cor |
veiculo.dist_eixo | texto · até 4 | Distância entre eixos |
veiculo.especie_veic | texto · até 1 | Espécie do veículo |
veiculo.lota_max | texto · até 3 | Capacidade máxima de lotação |
veiculo.motor | texto · até 21 | Número do motor |
veiculo.peso_bruto_veic | texto · até 9 | Peso bruto |
veiculo.peso_liquido_veic | texto · até 9 | Peso líquido |
veiculo.potencia | texto · até 4 | Potência motor |
veiculo.serie_veic | texto · até 9 | Série do veículo |
veiculo.tipo_comb | texto · até 2 | Tipo de combustível |
veiculo.tipo_oper | texto · até 1 | Tipo da operação |
veiculo.tipo_pintura | texto · até 1 | Tipo de pintura |
veiculo.tipo_restricao | texto · até 1 | Restrição |
veiculo.tipo_veic | texto · até 2 | Tipo de veículo de acordo com a tabela RENAVAM |
videos | lista de objetos | Lista de videos do produto. |
videos[].url_video | texto | URL do Video do produto. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirProduto", "param": [{"codigo_produto_integracao": "1790774103", "codigo": "teste0001", "descricao": "Produto de teste", "unidade": "UN"}]}'import os
import requests
corpo = {'call': 'IncluirProduto',
'param': [{'codigo_produto_integracao': '1790774103',
'codigo': 'teste0001',
'descricao': 'Produto de teste',
'unidade': 'UN'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "IncluirProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirProduto"", ""param"": [{""codigo_produto_integracao"": ""1790774103"", ""codigo"": ""teste0001"", ""descricao"": ""Produto de teste"", ""unidade"": ""UN""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista completa do Cadastro de Produtos
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
filtrar_apenas_omiepdv | texto · até 1 | Filtrar apenas produtos marcados para venda via PDV. ATENÇÃO: Todos os PDVs integrados devem preencher esse campo com "S". O preenchimento desse campo é obrigatório e o seu padrão é "S". Quando preenchido como "S" filtra apenas o produtos que tenham configuração de impostos definidas para o PDV. Preencher com "S" ou "N". |
Opcionais 27Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | Exibir apenas os registros gerados pela API. Preencher com "S" ou "N". |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto · até 20 | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto · até 60 | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto · até 1 | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto · até 30 | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
ean | texto · até 14 | Código EAN (GTIN - Global Trade Item Number). |
exibir_caracteristicas | texto · até 1 | Exibir as características do produto (S/N). Preencher com "S" ou "N". |
exibir_info_variacoes | texto · até 1 | Opcional. Indica se deve retornar informações sobre as variações de produto. Preencher com S/N. Disponível apenas para o método ListarProdutos. |
exibir_kit | texto · até 1 | Exibir os componentes do KIT (S/N). Preencher com "S" ou "N". |
exibir_obs | texto · até 1 | Exibir as observações do produto (S/N). Preencher com "S" ou "N". |
exibir_tabelas_preco | texto · até 1 | Exibir as tabelas de preço do produto (S/N). Preencher com "S" ou "N". |
filtrar_apenas_alteracao | texto · até 1 | Filtrar apenas os registros alterados (S/N). Preencher com "S" ou "N". |
filtrar_apenas_descricao | texto · até 200 | Filtro pela descrição do produto. Para filtrar utilize: "TEXTO" - Para pesquisa exata. "TEXTO%" - Para pesquisa começando com. "%TEXTO" - Para pesquisa terminando com. "%TEXTO%" - Para pesquisa contendo. |
filtrar_apenas_familia | texto · até 50 | Filtrar por ID da Familia de Produto. |
filtrar_apenas_inclusao | texto · até 1 | Filtrar apenas os registros incluídos (S/N). Preencher com "S" ou "N". |
filtrar_apenas_marketplace | texto · até 1 | Filtrar apenas produtos marcados para venda via Market Place ou e-Commerce. Preencher com "S" ou "N". |
filtrar_apenas_pdv | texto · até 1 | Filtrar apenas produtos marcados para venda via Ponto de Venda (PDV). Preencher com "S" ou "N". |
filtrar_apenas_tipo | texto · até 2 | Código do Tipo do Item para o SPED. 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 |
filtrar_por_data_ate | texto · até 10 | Filtrar os registros até uma data. Formato: "dd/mm/aaaa" |
filtrar_por_data_de | texto · até 10 | Filtrar os registros a partir de uma data. Formato: "dd/mm/aaaa" |
filtrar_por_hora_ate | texto · até 8 | Filtrar até a hora. Formato: "hh:mm:ss" |
filtrar_por_hora_de | texto · até 8 | Filtrar a partir da hora. Formato: "hh:mm:ss" |
inativo | texto · até 1 | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
ncm | texto · até 13 | Código da Nomenclatura Comum do Mercosul (NCM). |
ordem_decrescente | texto · até 1 | Se a lista será apresentada em ordem decrescente (S/N). Preencher com "S" ou "N". |
ordem_descrescente | texto · até 1 | DEPRECATED. |
ordenar_por | texto · até 100 | Ordem de exibição dos dados. Padrão: Código. |
pagina | número inteiro | Número da página para resgatar os dados. Default 1. |
produtosPorCodigo | lista de objetos | Filtro por código do produto. |
produtosPorCodigo[].codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
produtosPorCodigo[].codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
produtosPorCodigo[].codigo_produto_integracaoobrigatório | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
registros_por_pagina | número inteiro | Número de registros a serem exibidos por página. Máximo 500. Default 50. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
pagina | número inteiro | Número da página retornada |
produto_servico_cadastro | lista de objetos | Cadastro completo de produtos |
produto_servico_cadastro[].aliquota_cbs | decimal | 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. |
produto_servico_cadastro[].aliquota_cofins | decimal | 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. |
produto_servico_cadastro[].aliquota_ibpt | decimal | DEPRECATED. |
produto_servico_cadastro[].aliquota_ibs_mun | decimal | 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. |
produto_servico_cadastro[].aliquota_ibs_uf | decimal | 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. |
produto_servico_cadastro[].aliquota_icms | decimal | 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. |
produto_servico_cadastro[].aliquota_pis | decimal | 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. |
produto_servico_cadastro[].altura | decimal | Altura (centimentos). Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].armamento | objeto | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
produto_servico_cadastro[].armamento.descr_arma | texto | Descrição completa da arma |
produto_servico_cadastro[].armamento.serie_arma | texto | Número de série da arma |
produto_servico_cadastro[].armamento.serie_cano | texto | Número de série do cano |
produto_servico_cadastro[].armamento.tipo_arma | texto | Indicador do tipo de arma de fogo |
produto_servico_cadastro[].bloqueado | texto | Indica se o registro está bloqueado (S/N). |
produto_servico_cadastro[].bloquear_exclusao | texto | Indica se a exclusão do registro está bloqueada (S/N). |
produto_servico_cadastro[].caracteristicas | lista de objetos | lista de caracteristicas do produto. |
produto_servico_cadastro[].caracteristicas[].cCodIntCaract | texto | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
produto_servico_cadastro[].caracteristicas[].cConteudo | texto | Conteúdo da característica. |
produto_servico_cadastro[].caracteristicas[].cExibirItemNF | texto | Exibir esta característica no item da NF-e emitida (S/N). |
produto_servico_cadastro[].caracteristicas[].cExibirItemPedido | texto | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
produto_servico_cadastro[].caracteristicas[].cExibirOrdemProd | texto | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
produto_servico_cadastro[].caracteristicas[].cNomeCaract | texto | Nome da característica. |
produto_servico_cadastro[].caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
produto_servico_cadastro[].cest | texto | DEPRECATED. |
produto_servico_cadastro[].cfop | texto | 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. |
produto_servico_cadastro[].class_trib | texto | 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. |
produto_servico_cadastro[].codInt_familia | texto | 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. |
produto_servico_cadastro[].codigo | texto | 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". |
produto_servico_cadastro[].codigo_beneficio | texto | 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. |
produto_servico_cadastro[].codigo_familia | número inteiro | Código da Familia do Produto. |
produto_servico_cadastro[].codigo_produto | número inteiro | 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. |
produto_servico_cadastro[].codigo_produto_integracao | texto | 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. |
produto_servico_cadastro[].combustivel | objeto | Detalhamento específico para cadastro de combustíveis. |
produto_servico_cadastro[].combustivel.codigo_anp | texto | Código de Produto da ANP. |
produto_servico_cadastro[].combustivel.descr_anp | texto | Descrição do Produto conforme ANP. |
produto_servico_cadastro[].combustivel.percent_gas_imp | decimal | Percentual de Gás Natural Importado. |
produto_servico_cadastro[].combustivel.percent_gas_nac | decimal | Percentual de Gás Natural Nacional. |
produto_servico_cadastro[].combustivel.percent_glp | decimal | Percentual de GLP Derivado do Petróleo. |
produto_servico_cadastro[].combustivel.valor_part | decimal | Valor de partida |
produto_servico_cadastro[].componentes_kit | lista de objetos | Componetes do KIT. |
produto_servico_cadastro[].componentes_kit[].codigo_componente | número inteiro | Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie. |
produto_servico_cadastro[].componentes_kit[].codigo_produto_componente | número inteiro | Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. |
produto_servico_cadastro[].componentes_kit[].local_estoque_componente | número inteiro | Local estoque do componente. |
produto_servico_cadastro[].componentes_kit[].quantidade_componente | decimal | Quantidade do componente. |
produto_servico_cadastro[].componentes_kit[].valor_unitario_componente | decimal | Valor unitário do componente. |
produto_servico_cadastro[].csosn_icms | texto | 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. |
produto_servico_cadastro[].cst_cofins | texto | 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. |
produto_servico_cadastro[].cst_ibs_cbs | texto | 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. |
produto_servico_cadastro[].cst_icms | texto | 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. |
produto_servico_cadastro[].cst_pis | texto | 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. |
produto_servico_cadastro[].dadosIbpt | objeto | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.aliqEstadual | decimal | Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.aliqFederal | decimal | Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.aliqMunicipal | decimal | Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.chave | texto | Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.fonte | texto | Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.valido_ate | texto | Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.valido_de | texto | Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dadosIbpt.versao | texto | Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].descr_detalhada | texto | Descrição Detalhada para o Produto. |
produto_servico_cadastro[].descricao | texto | Descrição do produto. |
produto_servico_cadastro[].descricao_familia | texto | Descrição da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
produto_servico_cadastro[].dias_crossdocking | número inteiro | Dias de Crossdocking. Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].dias_garantia | número inteiro | Dias de Garantia. Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].ean | texto | Código EAN (GTIN - Global Trade Item Number). |
produto_servico_cadastro[].estoque_minimo | decimal | DEPRECATED. |
produto_servico_cadastro[].exibir_descricao_nfe | texto | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
produto_servico_cadastro[].exibir_descricao_pedido | texto | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
produto_servico_cadastro[].id_produto_variacao | número inteiro | 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'. |
produto_servico_cadastro[].imagens | lista de objetos | Lista de imagens do produto. |
produto_servico_cadastro[].imagens[].url_imagem | texto | URL da Imagem do produto. |
produto_servico_cadastro[].importado_api | texto | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].inativo | texto | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info | objeto | Informações complemetares do cadastro do produto. |
produto_servico_cadastro[].info.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].info.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
produto_servico_cadastro[].largura | decimal | Largura (centimetros) Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].lead_time | número inteiro | Lead Time médio de ressuprimento em dias. |
produto_servico_cadastro[].marca | texto | Marca. Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].medicamento | objeto | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
produto_servico_cadastro[].medicamento.cod_anvisa | texto | Código de produto Anvisa |
produto_servico_cadastro[].medicamento.preco_max_cons | decimal | Preço máximo consumidor |
produto_servico_cadastro[].modalidade_icms | texto | 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. |
produto_servico_cadastro[].modelo | texto | Modelo. Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].motivo_deson_icms | texto | 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. |
produto_servico_cadastro[].ncm | texto | Código da Nomenclatura Comum do Mercosul (NCM). |
produto_servico_cadastro[].obs_internas | texto | Observações Internas. (ficam registradas apenas no cadastro do produto). |
produto_servico_cadastro[].origem_imposto | texto | 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. |
produto_servico_cadastro[].per_icms_fcp | decimal | 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. |
produto_servico_cadastro[].perc_reducao_cbs | decimal | Percentual da redução de 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. |
produto_servico_cadastro[].perc_reducao_ibs_mun | decimal | 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. |
produto_servico_cadastro[].perc_reducao_ibs_uf | decimal | 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. |
produto_servico_cadastro[].peso_bruto | decimal | Peso Bruto (Kg). Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].peso_liq | decimal | Peso Líquido (Kg). Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].produto_lote | texto | Indica se o produto possui lote. (S/N) . |
produto_servico_cadastro[].produto_variacao | texto | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
produto_servico_cadastro[].profundidade | decimal | Profundidade (centimetros). Localizado na aba "Informações Adicionais" |
produto_servico_cadastro[].quantidade_estoque | decimal | DEPRECATED. |
produto_servico_cadastro[].recomendacoes_fiscais | objeto | Recomendações Fiscais. |
produto_servico_cadastro[].recomendacoes_fiscais.cnpj_fabricante | texto | CNPJ do Fabricante da Mercadoria. |
produto_servico_cadastro[].recomendacoes_fiscais.cupom_fiscal | texto | Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com "S" ou "N". |
produto_servico_cadastro[].recomendacoes_fiscais.id_cest | texto | Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99 |
produto_servico_cadastro[].recomendacoes_fiscais.id_preco_tabelado | número inteiro | ID do Preço tabelado (Pauta). |
produto_servico_cadastro[].recomendacoes_fiscais.indicador_escala | texto | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
produto_servico_cadastro[].recomendacoes_fiscais.market_place | texto | Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com "S" ou "N". |
produto_servico_cadastro[].recomendacoes_fiscais.origem_mercadoria | texto | Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 1 - Estrangeira - Importação direta, 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 e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70 |
produto_servico_cadastro[].red_base_cofins | decimal | 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. |
produto_servico_cadastro[].red_base_icms | decimal | 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. |
produto_servico_cadastro[].red_base_pis | decimal | 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. |
produto_servico_cadastro[].tabelas_preco | lista de objetos | Lista de tabelas de preço. |
produto_servico_cadastro[].tabelas_preco[].cNomeTabPreco | texto | Nome da tabela de preço. |
produto_servico_cadastro[].tabelas_preco[].nCodTabPreco | número inteiro | Id da tabela de preço. |
produto_servico_cadastro[].tabelas_preco[].nValorTabPreco | decimal | Valor do produto na tabela de preço. |
produto_servico_cadastro[].tipoItem | texto | Código do Tipo do Item para o SPED. 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 |
produto_servico_cadastro[].unidade | texto | Código da Unidade. |
produto_servico_cadastro[].valor_unitario | decimal | Preço Unitário de Venda. |
produto_servico_cadastro[].variacao | texto | 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'. |
produto_servico_cadastro[].veiculo | objeto | Detalhamento específico para cadastro de veículos |
produto_servico_cadastro[].veiculo.ano_fabr | texto | |
produto_servico_cadastro[].veiculo.ano_modelo | texto | Ano modelo de fabricação |
produto_servico_cadastro[].veiculo.chassi | texto | Chassi do veículo |
produto_servico_cadastro[].veiculo.cilin | texto | Cilindradas |
produto_servico_cadastro[].veiculo.cmt | texto | Capacidade máxima de tração |
produto_servico_cadastro[].veiculo.cod_cor_den | texto | Código da cor DENATRAN |
produto_servico_cadastro[].veiculo.cod_cor_veic | texto | Código da cor do veículo |
produto_servico_cadastro[].veiculo.cod_modelo | texto | Código marca modelo |
produto_servico_cadastro[].veiculo.cond_veic | texto | Condição do veículo |
produto_servico_cadastro[].veiculo.cond_vin | texto | Condição do VIN |
produto_servico_cadastro[].veiculo.descr_cor | texto | Descrição da cor |
produto_servico_cadastro[].veiculo.dist_eixo | texto | Distância entre eixos |
produto_servico_cadastro[].veiculo.especie_veic | texto | Espécie do veículo |
produto_servico_cadastro[].veiculo.lota_max | texto | Capacidade máxima de lotação |
produto_servico_cadastro[].veiculo.motor | texto | Número do motor |
produto_servico_cadastro[].veiculo.peso_bruto_veic | texto | Peso bruto |
produto_servico_cadastro[].veiculo.peso_liquido_veic | texto | Peso líquido |
produto_servico_cadastro[].veiculo.potencia | texto | Potência motor |
produto_servico_cadastro[].veiculo.serie_veic | texto | Série do veículo |
produto_servico_cadastro[].veiculo.tipo_comb | texto | Tipo de combustível |
produto_servico_cadastro[].veiculo.tipo_oper | texto | Tipo da operação |
produto_servico_cadastro[].veiculo.tipo_pintura | texto | Tipo de pintura |
produto_servico_cadastro[].veiculo.tipo_restricao | texto | Restrição |
produto_servico_cadastro[].veiculo.tipo_veic | texto | Tipo de veículo de acordo com a tabela RENAVAM |
produto_servico_cadastro[].videos | lista de objetos | Lista de videos do produto. |
produto_servico_cadastro[].videos[].url_video | texto | URL do Video do produto. |
registros | número inteiro | Número de registros retornados na página. |
total_de_paginas | número inteiro | Número total de páginas |
total_de_registros | número inteiro | total de registros encontrados |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarProdutos", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N", "filtrar_apenas_omiepdv": "N"}]}'import os
import requests
corpo = {'call': 'ListarProdutos',
'param': [{'pagina': 1,
'registros_por_pagina': 50,
'apenas_importado_api': 'N',
'filtrar_apenas_omiepdv': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarProdutos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarProdutos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "ListarProdutos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarProdutos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarProdutos"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N"", ""filtrar_apenas_omiepdv"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista os produtos cadastrados
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
filtrar_apenas_omiepdv | texto · até 1 | Filtrar apenas produtos marcados para venda via PDV. ATENÇÃO: Todos os PDVs integrados devem preencher esse campo com "S". O preenchimento desse campo é obrigatório e o seu padrão é "S". Quando preenchido como "S" filtra apenas o produtos que tenham configuração de impostos definidas para o PDV. Preencher com "S" ou "N". |
Opcionais 27Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | Exibir apenas os registros gerados pela API. Preencher com "S" ou "N". |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto · até 20 | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto · até 60 | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto · até 1 | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto · até 30 | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
ean | texto · até 14 | Código EAN (GTIN - Global Trade Item Number). |
exibir_caracteristicas | texto · até 1 | Exibir as características do produto (S/N). Preencher com "S" ou "N". |
exibir_info_variacoes | texto · até 1 | Opcional. Indica se deve retornar informações sobre as variações de produto. Preencher com S/N. Disponível apenas para o método ListarProdutos. |
exibir_kit | texto · até 1 | Exibir os componentes do KIT (S/N). Preencher com "S" ou "N". |
exibir_obs | texto · até 1 | Exibir as observações do produto (S/N). Preencher com "S" ou "N". |
exibir_tabelas_preco | texto · até 1 | Exibir as tabelas de preço do produto (S/N). Preencher com "S" ou "N". |
filtrar_apenas_alteracao | texto · até 1 | Filtrar apenas os registros alterados (S/N). Preencher com "S" ou "N". |
filtrar_apenas_descricao | texto · até 200 | Filtro pela descrição do produto. Para filtrar utilize: "TEXTO" - Para pesquisa exata. "TEXTO%" - Para pesquisa começando com. "%TEXTO" - Para pesquisa terminando com. "%TEXTO%" - Para pesquisa contendo. |
filtrar_apenas_familia | texto · até 50 | Filtrar por ID da Familia de Produto. |
filtrar_apenas_inclusao | texto · até 1 | Filtrar apenas os registros incluídos (S/N). Preencher com "S" ou "N". |
filtrar_apenas_marketplace | texto · até 1 | Filtrar apenas produtos marcados para venda via Market Place ou e-Commerce. Preencher com "S" ou "N". |
filtrar_apenas_pdv | texto · até 1 | Filtrar apenas produtos marcados para venda via Ponto de Venda (PDV). Preencher com "S" ou "N". |
filtrar_apenas_tipo | texto · até 2 | Código do Tipo do Item para o SPED. 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 |
filtrar_por_data_ate | texto · até 10 | Filtrar os registros até uma data. Formato: "dd/mm/aaaa" |
filtrar_por_data_de | texto · até 10 | Filtrar os registros a partir de uma data. Formato: "dd/mm/aaaa" |
filtrar_por_hora_ate | texto · até 8 | Filtrar até a hora. Formato: "hh:mm:ss" |
filtrar_por_hora_de | texto · até 8 | Filtrar a partir da hora. Formato: "hh:mm:ss" |
inativo | texto · até 1 | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
ncm | texto · até 13 | Código da Nomenclatura Comum do Mercosul (NCM). |
ordem_decrescente | texto · até 1 | Se a lista será apresentada em ordem decrescente (S/N). Preencher com "S" ou "N". |
ordem_descrescente | texto · até 1 | DEPRECATED. |
ordenar_por | texto · até 100 | Ordem de exibição dos dados. Padrão: Código. |
pagina | número inteiro | Número da página para resgatar os dados. Default 1. |
produtosPorCodigo | lista de objetos | Filtro por código do produto. |
produtosPorCodigo[].codigo | texto · até 60 | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
produtosPorCodigo[].codigo_produto | número inteiro | (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
produtosPorCodigo[].codigo_produto_integracaoobrigatório | texto · até 60 | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
registros_por_pagina | número inteiro | Número de registros a serem exibidos por página. Máximo 500. Default 50. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
pagina | número inteiro | Número da página retornada |
produto_servico_resumido | lista de objetos | Cadastro reduzido de produtos |
produto_servico_resumido[].codigo | texto | Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag "codigo_produto". |
produto_servico_resumido[].codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
produto_servico_resumido[].codigo_produto_integracao | texto | Código de integração do produto. Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
produto_servico_resumido[].descricao | texto | Descrição do produto |
produto_servico_resumido[].valor_unitario | decimal | Valor Unitário do produto |
registros | número inteiro | Número de registros retornados na página. |
total_de_paginas | número inteiro | Número total de páginas |
total_de_registros | número inteiro | total de registros encontrados |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarProdutosResumido", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N", "filtrar_apenas_omiepdv": "N"}]}'import os
import requests
corpo = {'call': 'ListarProdutosResumido',
'param': [{'pagina': 1,
'registros_por_pagina': 50,
'apenas_importado_api': 'N',
'filtrar_apenas_omiepdv': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarProdutosResumido",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarProdutosResumido",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "ListarProdutosResumido",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarProdutosResumido",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarProdutosResumido"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N"", ""filtrar_apenas_omiepdv"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRealiza a inclusão/alteração de produtos.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto_integracao | texto · até 60 | 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. |
medicamento | objeto | Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos |
medicamento.cod_anvisa | texto · até 13 | Código de produto Anvisa |
medicamento.preco_max_cons | número | Preço máximo consumidor |
Opcionais 72Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aliquota_cbs | número | 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 | número | 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 | número | DEPRECATED. |
aliquota_ibs_mun | número | 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 | número | 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 | número | 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 | número | 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 | número | Altura (centimentos). Localizado na aba "Informações Adicionais" |
armamento | objeto | Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação. |
armamento.descr_arma | texto · até 256 | Descrição completa da arma |
armamento.serie_arma | texto · até 15 | Número de série da arma |
armamento.serie_cano | texto · até 15 | Número de série do cano |
armamento.tipo_arma | texto · até 1 | Indicador do tipo de arma de fogo |
bloqueado | texto · até 1 | Indica se o registro está bloqueado (S/N). |
bloquear_exclusao | texto · até 1 | Indica se a exclusão do registro está bloqueada (S/N). |
caracteristicas | lista de objetos | lista de caracteristicas do produto. |
caracteristicas[].cCodIntCaract | texto · até 20 | Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
caracteristicas[].cConteudo | texto · até 60 | Conteúdo da característica. |
caracteristicas[].cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N). |
caracteristicas[].cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
caracteristicas[].cExibirOrdemProd | texto · até 1 | Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N). |
caracteristicas[].cNomeCaract | texto · até 30 | Nome da característica. |
caracteristicas[].nCodCaract | número inteiro | Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. |
cest | texto · até 9 | DEPRECATED. |
cfop | texto · até 10 | 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 | texto · até 6 | 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 | texto · até 20 | 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 | texto · até 60 | 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 | texto · até 20 | 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 | número inteiro | Código da Familia do Produto. |
codigo_produto | número inteiro | 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. |
combustivel | objeto | Detalhamento específico para cadastro de combustíveis. |
combustivel.codigo_anp | texto · até 9 | Código de Produto da ANP. |
combustivel.descr_anp | texto · até 95 | Descrição do Produto conforme ANP. |
combustivel.percent_gas_imp | número | Percentual de Gás Natural Importado. |
combustivel.percent_gas_nac | número | Percentual de Gás Natural Nacional. |
combustivel.percent_glp | número | Percentual de GLP Derivado do Petróleo. |
combustivel.valor_part | número | Valor de partida |
componentes_kit | lista de objetos | Componetes do KIT. |
componentes_kit[].codigo_componente | número inteiro | Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie. |
componentes_kit[].codigo_produto_componente | número inteiro | Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. |
componentes_kit[].local_estoque_componente | número inteiro | Local estoque do componente. |
componentes_kit[].quantidade_componente | número | Quantidade do componente. |
componentes_kit[].valor_unitario_componente | número | Valor unitário do componente. |
csosn_icms | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 3 | 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 | texto · até 2 | 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 | texto · até 2 | 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 | objeto | Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqEstadual | número | Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqFederal | número | Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.aliqMunicipal | número | Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.chave | texto · até 6 | Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.fonte | texto · até 34 | Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_ate | texto · até 10 | Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.valido_de | texto · até 10 | Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
dadosIbpt.versao | texto · até 6 | Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. |
descr_detalhada | texto | Descrição Detalhada para o Produto. |
descricao | texto · até 120 | Descrição do produto. |
descricao_familia | texto · até 50 | 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 | número inteiro | Dias de Crossdocking. Localizado na aba "Informações Adicionais" |
dias_garantia | número inteiro | Dias de Garantia. Localizado na aba "Informações Adicionais" |
ean | texto · até 14 | Código EAN (GTIN - Global Trade Item Number). |
estoque_minimo | número | DEPRECATED. |
exibir_descricao_nfe | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N). |
exibir_descricao_pedido | texto · até 1 | Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N). |
id_produto_variacao | número inteiro | 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 objetos | Lista de imagens do produto. |
imagens[].url_imagem | texto | URL da Imagem do produto. |
importado_api | texto · até 1 | Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração. |
inativo | texto · até 1 | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
largura | número | Largura (centimetros) Localizado na aba "Informações Adicionais" |
lead_time | número inteiro | Lead Time médio de ressuprimento em dias. |
marca | texto · até 60 | Marca. Localizado na aba "Informações Adicionais" |
modalidade_icms | texto · até 1 | 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 | texto · até 60 | Modelo. Localizado na aba "Informações Adicionais" |
motivo_deson_icms | texto · até 2 | 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 | texto · até 13 | Código da Nomenclatura Comum do Mercosul (NCM). |
obs_internas | texto | Observações Internas. (ficam registradas apenas no cadastro do produto). |
origem_imposto | texto · até 10 | 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 | número | 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 | número | Percentual da redução de 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. |
perc_reducao_ibs_mun | número | 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 | número | 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 | número | Peso Bruto (Kg). Localizado na aba "Informações Adicionais" |
peso_liq | número | Peso Líquido (Kg). Localizado na aba "Informações Adicionais" |
produto_lote | texto · até 1 | Indica se o produto possui lote. (S/N) . |
produto_variacao | texto · até 1 | Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) . |
profundidade | número | Profundidade (centimetros). Localizado na aba "Informações Adicionais" |
quantidade_estoque | número | DEPRECATED. |
recomendacoes_fiscais | objeto | Recomendações Fiscais. |
recomendacoes_fiscais.cnpj_fabricante | texto · até 20 | CNPJ do Fabricante da Mercadoria. |
recomendacoes_fiscais.cupom_fiscal | texto · até 1 | Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com "S" ou "N". |
recomendacoes_fiscais.id_cest | texto · até 9 | Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99 |
recomendacoes_fiscais.id_preco_tabelado | número inteiro | ID do Preço tabelado (Pauta). |
recomendacoes_fiscais.indicador_escala | texto · até 1 | Indicador de Produção em Escala Relevante. Pode ser: "S" para Produzido em Escala Relevante. "N" para Produzido em Escala NÃO Relevante. |
recomendacoes_fiscais.market_place | texto · até 1 | Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com "S" ou "N". |
recomendacoes_fiscais.origem_mercadoria | texto · até 1 | Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 1 - Estrangeira - Importação direta, 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 e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70 |
red_base_cofins | número | 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 | número | 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 | número | 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 objetos | Lista de tabelas de preço. |
tabelas_preco[].cNomeTabPreco | texto · até 50 | Nome da tabela de preço. |
tabelas_preco[].nCodTabPreco | número inteiro | Id da tabela de preço. |
tabelas_preco[].nValorTabPreco | número | Valor do produto na tabela de preço. |
tipoItem | texto · até 2 | Código do Tipo do Item para o SPED. 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 | texto · até 6 | Código da Unidade. |
valor_unitario | número | Preço Unitário de Venda. |
variacao | texto · até 1 | 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 | objeto | Detalhamento específico para cadastro de veículos |
veiculo.ano_fabr | texto · até 4 | |
veiculo.ano_modelo | texto · até 4 | Ano modelo de fabricação |
veiculo.chassi | texto · até 17 | Chassi do veículo |
veiculo.cilin | texto · até 4 | Cilindradas |
veiculo.cmt | texto · até 9 | Capacidade máxima de tração |
veiculo.cod_cor_den | texto · até 2 | Código da cor DENATRAN |
veiculo.cod_cor_veic | texto · até 4 | Código da cor do veículo |
veiculo.cod_modelo | texto · até 6 | Código marca modelo |
veiculo.cond_veic | texto · até 1 | Condição do veículo |
veiculo.cond_vin | texto · até 1 | Condição do VIN |
veiculo.descr_cor | texto · até 40 | Descrição da cor |
veiculo.dist_eixo | texto · até 4 | Distância entre eixos |
veiculo.especie_veic | texto · até 1 | Espécie do veículo |
veiculo.lota_max | texto · até 3 | Capacidade máxima de lotação |
veiculo.motor | texto · até 21 | Número do motor |
veiculo.peso_bruto_veic | texto · até 9 | Peso bruto |
veiculo.peso_liquido_veic | texto · até 9 | Peso líquido |
veiculo.potencia | texto · até 4 | Potência motor |
veiculo.serie_veic | texto · até 9 | Série do veículo |
veiculo.tipo_comb | texto · até 2 | Tipo de combustível |
veiculo.tipo_oper | texto · até 1 | Tipo da operação |
veiculo.tipo_pintura | texto · até 1 | Tipo de pintura |
veiculo.tipo_restricao | texto · até 1 | Restrição |
veiculo.tipo_veic | texto · até 2 | Tipo de veículo de acordo com a tabela RENAVAM |
videos | lista de objetos | Lista de videos do produto. |
videos[].url_video | texto | URL do Video do produto. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_produto | número inteiro | Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo "codigo_produto_integracao". |
codigo_produto_integracao | texto | Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos. |
codigo_status | texto | |
descricao_status | texto |
POST /api/v1/geral/produtos/
curl -s https://app.omie.com.br/api/v1/geral/produtos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "UpsertProduto", "param": [{"codigo_produto_integracao": "1790774103", "codigo": "teste0001", "descricao": "Produto de teste", "unidade": "UN"}]}'import os
import requests
corpo = {'call': 'UpsertProduto',
'param': [{'codigo_produto_integracao': '1790774103',
'codigo': 'teste0001',
'descricao': 'Produto de teste',
'unidade': 'UN'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/produtos/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/produtos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "UpsertProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/produtos/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "UpsertProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/produtos/")
corpo = <<~'JSON'
{
"call": "UpsertProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "UpsertProduto",
"param": [
{
"codigo_produto_integracao": "1790774103",
"codigo": "teste0001",
"descricao": "Produto de teste",
"unidade": "UN"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/produtos/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/produtos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""UpsertProduto"", ""param"": [{""codigo_produto_integracao"": ""1790774103"", ""codigo"": ""teste0001"", ""descricao"": ""Produto de teste"", ""unidade"": ""UN""}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados