Geral ·
ProdutosCaracteristicasCaracterísticas do produto
2consultas
3alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Altera a característica de um produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCaract | texto · até 60 | 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. |
cCodIntProd | texto · até 60 | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cConteudo | texto · até 60 | Conteúdo da característica. |
cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N).Ex.: S, N |
cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N).Ex.: S, N |
cExibirOrdemProd | texto · até 1 | Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N).Ex.: S, N |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
Retorno 6O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
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. |
cCodIntProd | texto | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
POST /api/v1/geral/prodcaract/
curl -s https://app.omie.com.br/api/v1/geral/prodcaract/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarCaractProduto", "param": [{"nCodProd": 0, "cCodIntProd": "", "nCodCaract": 0, "cCodIntCaract": "", "cConteudo": "", "cExibirItemNF": "S", "cExibirItemPedido": "S", "cExibirOrdemProd": "S"}]}'import os
import requests
corpo = {'call': 'AlterarCaractProduto',
'param': [{'nCodProd': 0,
'cCodIntProd': '',
'nCodCaract': 0,
'cCodIntCaract': '',
'cConteudo': '',
'cExibirItemNF': 'S',
'cExibirItemPedido': 'S',
'cExibirOrdemProd': 'S'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/prodcaract/",
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/prodcaract/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/prodcaract/");
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": "AlterarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/prodcaract/")
corpo = <<~'JSON'
{
"call": "AlterarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
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": "AlterarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/prodcaract/"))
.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/prodcaract/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarCaractProduto"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """", ""nCodCaract"": 0, ""cCodIntCaract"": """", ""cConteudo"": """", ""cExibirItemNF"": ""S"", ""cExibirItemPedido"": ""S"", ""cExibirOrdemProd"": ""S""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsultar uma característica de um produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCaract | texto · até 60 | 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. |
cCodIntProd | texto · até 60 | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
Retorno 10O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
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. |
cCodIntProd | texto | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cConteudo | texto | Conteúdo da característica. |
cExibirItemNF | texto | Exibir esta característica no item da NF-e emitida (S/N). |
cExibirItemPedido | texto | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
cExibirOrdemProd | texto | Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N). |
cNomeCaract | texto | Nome da característica. |
info | objeto | Informações complemetares da característica. |
info.cImpAPI | texto | Importado pela API (S/N). |
info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
info.uAlt | texto | Usuário da Alteração. |
info.uInc | texto | Usuário da Inclusão. |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
POST /api/v1/geral/prodcaract/
curl -s https://app.omie.com.br/api/v1/geral/prodcaract/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarCaractProduto", "param": [{"nCodProd": 0, "cCodIntProd": "", "nCodCaract": 0, "cCodIntCaract": ""}]}'import os
import requests
corpo = {'call': 'ConsultarCaractProduto',
'param': [{'nCodProd': 0, 'cCodIntProd': '', 'nCodCaract': 0, 'cCodIntCaract': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/prodcaract/",
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/prodcaract/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/prodcaract/");
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": "ConsultarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/prodcaract/")
corpo = <<~'JSON'
{
"call": "ConsultarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
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": "ConsultarCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/prodcaract/"))
.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/prodcaract/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarCaractProduto"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """", ""nCodCaract"": 0, ""cCodIntCaract"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExcluir um característica de um produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCaract | texto · até 60 | 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. |
cCodIntProd | texto · até 60 | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
Retorno 6O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
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. |
cCodIntProd | texto | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
POST /api/v1/geral/prodcaract/
curl -s https://app.omie.com.br/api/v1/geral/prodcaract/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirCaractProduto", "param": [{"nCodProd": 0, "cCodIntProd": "", "nCodCaract": 0, "cCodIntCaract": ""}]}'import os
import requests
corpo = {'call': 'ExcluirCaractProduto',
'param': [{'nCodProd': 0, 'cCodIntProd': '', 'nCodCaract': 0, 'cCodIntCaract': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/prodcaract/",
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/prodcaract/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/prodcaract/");
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": "ExcluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/prodcaract/")
corpo = <<~'JSON'
{
"call": "ExcluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
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": "ExcluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/prodcaract/"))
.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/prodcaract/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirCaractProduto"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """", ""nCodCaract"": 0, ""cCodIntCaract"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclui uma característica a um produto.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
cConteudo | texto · até 60 | Conteúdo da característica. |
Opcionais 7Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCaract | texto · até 60 | 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. |
cCodIntProd | texto · até 60 | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cExibirItemNF | texto · até 1 | Exibir esta característica no item da NF-e emitida (S/N).Ex.: S, N |
cExibirItemPedido | texto · até 1 | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N).Ex.: S, N |
cExibirOrdemProd | texto · até 1 | Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N).Ex.: S, N |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
Retorno 6O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
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. |
cCodIntProd | texto | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
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. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
POST /api/v1/geral/prodcaract/
curl -s https://app.omie.com.br/api/v1/geral/prodcaract/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirCaractProduto", "param": [{"nCodProd": 0, "cCodIntProd": "", "nCodCaract": 0, "cCodIntCaract": "", "cConteudo": "", "cExibirItemNF": "S", "cExibirItemPedido": "S", "cExibirOrdemProd": "S"}]}'import os
import requests
corpo = {'call': 'IncluirCaractProduto',
'param': [{'nCodProd': 0,
'cCodIntProd': '',
'nCodCaract': 0,
'cCodIntCaract': '',
'cConteudo': '',
'cExibirItemNF': 'S',
'cExibirItemPedido': 'S',
'cExibirOrdemProd': 'S'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/prodcaract/",
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/prodcaract/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/prodcaract/");
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": "IncluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/prodcaract/")
corpo = <<~'JSON'
{
"call": "IncluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
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": "IncluirCaractProduto",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"nCodCaract": 0,
"cCodIntCaract": "",
"cConteudo": "",
"cExibirItemNF": "S",
"cExibirItemPedido": "S",
"cExibirOrdemProd": "S"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/prodcaract/"))
.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/prodcaract/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirCaractProduto"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """", ""nCodCaract"": 0, ""cCodIntCaract"": """", ""cConteudo"": """", ""cExibirItemNF"": ""S"", ""cExibirItemPedido"": ""S"", ""cExibirOrdemProd"": ""S""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista as características de um produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 10Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntProd | texto · até 60 | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
cOrdemDecrescente | texto · até 1 | Indica se a ordem de exibição é Decrescente caso seja informado "S". |
cOrdenarPor | texto · até 100 | Ordena os resultados da página por: CODIGO - Código da Característica. CODINT - Código de Integração da Característica. NOME - Nome da Característica. |
dDtAltAte | texto · até 10 | Data de alteração final. No formato dd/mm/aaaa. |
dDtAltDe | texto · até 10 | Data de alteração inicial. No formato dd/mm/aaaa. |
dDtIncAte | texto · até 10 | Data de inclusão final. No formato dd/mm/aaaa. |
dDtIncDe | texto · até 10 | Data de inclusão inicial. No formato dd/mm/aaaa. |
nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
nPagina | número inteiro | Número da página que se deseja resgatar. O padrão é "1". |
nRegPorPagina | número inteiro | Número de registros retornados por página. O padrão é 20. O limite máximo é 50 por página. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
listaCaracteristicas | lista de objetos | Lista de características de produto. |
listaCaracteristicas[].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. |
listaCaracteristicas[].cCodIntProd | texto | Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada. |
listaCaracteristicas[].cConteudo | texto | Conteúdo da característica. |
listaCaracteristicas[].cExibirItemNF | texto | Exibir esta característica no item da NF-e emitida (S/N). |
listaCaracteristicas[].cExibirItemPedido | texto | Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N). |
listaCaracteristicas[].cExibirOrdemProd | texto | Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N). |
listaCaracteristicas[].cNomeCaract | texto | Nome da característica. |
listaCaracteristicas[].info | objeto | Informações complemetares da característica. |
listaCaracteristicas[].info.cImpAPI | texto | Importado pela API (S/N). |
listaCaracteristicas[].info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
listaCaracteristicas[].info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
listaCaracteristicas[].info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
listaCaracteristicas[].info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
listaCaracteristicas[].info.uAlt | texto | Usuário da Alteração. |
listaCaracteristicas[].info.uInc | texto | Usuário da Inclusão. |
listaCaracteristicas[].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. |
listaCaracteristicas[].nCodProd | número inteiro | Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie. |
nPagina | número inteiro | Número da página resgatada. |
nRegistros | número inteiro | Número de registros retornados na página. |
nTotPaginas | número inteiro | Número total de páginas encontradas. |
nTotRegistros | número inteiro | Número total de registros encontrados. |
POST /api/v1/geral/prodcaract/
curl -s https://app.omie.com.br/api/v1/geral/prodcaract/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarCaractProduto", "param": [{"nPagina": 1, "nRegPorPagina": 50, "nCodProd": 0}]}'import os
import requests
corpo = {'call': 'ListarCaractProduto',
'param': [{'nPagina': 1, 'nRegPorPagina': 50, 'nCodProd': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/prodcaract/",
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/prodcaract/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarCaractProduto",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nCodProd": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/prodcaract/");
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": "ListarCaractProduto",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nCodProd": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/prodcaract/")
corpo = <<~'JSON'
{
"call": "ListarCaractProduto",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nCodProd": 0
}
]
}
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": "ListarCaractProduto",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nCodProd": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/prodcaract/"))
.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/prodcaract/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarCaractProduto"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50, ""nCodProd"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados