Produtos ·
ProdutosVariacoesVariação do produto
2consultas
1alteração
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Método para realizar a consulta da variação da grade do produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntProd | texto · até 60 | Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "nCodProd". |
nCodProd | 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. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
Retorno 2O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
ident | objeto | Identificação do Produto. |
ident.cCodIntProd | texto | Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "nCodProd". |
ident.cCodProduto | texto | Código do Produto exibido na tela de Produtos. |
ident.cDescrProduto | texto | Descrição do produto. Descrição do nome do produto no Omie. |
ident.nCodProd | 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. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
variacoes | lista de objetos | Conjunto de variações do produto. |
variacoes[].CaractVariacoes | lista de objetos | Características das variações. |
variacoes[].CaractVariacoes[].cConteudoCaract | número inteiro | Conteúdo da característica. |
variacoes[].CaractVariacoes[].cNomeCaract | texto | Nome da característica variante. |
variacoes[].CaractVariacoes[].nIdCaract | número inteiro | Id da Característica. |
variacoes[].cDescProdVariacao | texto | Descrição do produto variação . |
variacoes[].nIdProdVariacao | número inteiro | Id do produto variação. Id do produto criado pelas características selecionadas. |
variacoes[].nIdVariacao | número inteiro | Id da variação. Id criado para integrar com a característica do produto. |
POST /api/v1/produtos/variacao/
curl -s https://app.omie.com.br/api/v1/produtos/variacao/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarVariacoes", "param": [{"nCodProd": 0, "cCodIntProd": ""}]}'import os
import requests
corpo = {'call': 'ConsultarVariacoes', 'param': [{'nCodProd': 0, 'cCodIntProd': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/variacao/",
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/produtos/variacao/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/variacao/");
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": "ConsultarVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/variacao/")
corpo = <<~'JSON'
{
"call": "ConsultarVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": ""
}
]
}
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": "ConsultarVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/variacao/"))
.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/produtos/variacao/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarVariacoes"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosMétodo para realizar a inclusão da variação da grade do produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aCaracteristicas | lista de objetos | Lista com as característica para a criação da variação do produto. É permitido informar no máximo 2 características. |
aCaracteristicas[].nIdCaractobrigatório | número inteiro | Id da característica. |
aVariacoes | lista de objetos | Configuração manual da variação do produto. Deve ser preenchido apenas quando deseja informar manualmente as variações do produto. |
aVariacoes[].aValoresCaracteristicas | lista de objetos | |
aVariacoes[].aValoresCaracteristicas[].nIdCaractobrigatório | número inteiro | Id da característica. |
aVariacoes[].aValoresCaracteristicas[].nIdValorobrigatório | número inteiro | Id do valor da característica. |
aVariacoes[].cCodProduto | texto · até 60 | Código do produto variação. Quando informado, esse código será alocado ao novo produto gerado. |
aVariacoes[].cDescrProduto | texto · até 120 | Descrição do produto variação. Quando informado, essa descrição será alocada ao novo produto gerado. |
aVariacoes[].nCodProdAssoc | número inteiro | Código do produto a ser associado a essa variação. Caso informado, não será gerado um novo produto variação e sim, associado a esse produto informado. |
cCodIntProd | texto · até 60 | Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "nCodProd". |
nCodProd | 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. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
Retorno 2O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Identificação do Produto. |
cDesStatus | texto |
POST /api/v1/produtos/variacao/
curl -s https://app.omie.com.br/api/v1/produtos/variacao/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirVariacoes", "param": [{"nCodProd": 0, "cCodIntProd": "", "aCaracteristicas": [{"nIdCaract": 0}], "aVariacoes": [{"nCodProdAssoc": 0, "cDescrProduto": "", "cCodProduto": "", "aValoresCaracteristicas": [{"nIdCaract": 0, "nIdValor": 0}]}]}]}'import os
import requests
corpo = {'call': 'IncluirVariacoes',
'param': [{'nCodProd': 0,
'cCodIntProd': '',
'aCaracteristicas': [{'nIdCaract': 0}],
'aVariacoes': [{'nCodProdAssoc': 0,
'cDescrProduto': '',
'cCodProduto': '',
'aValoresCaracteristicas': [{'nIdCaract': 0,
'nIdValor': 0}]}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/variacao/",
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/produtos/variacao/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"aCaracteristicas": [
{
"nIdCaract": 0
}
],
"aVariacoes": [
{
"nCodProdAssoc": 0,
"cDescrProduto": "",
"cCodProduto": "",
"aValoresCaracteristicas": [
{
"nIdCaract": 0,
"nIdValor": 0
}
]
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/variacao/");
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": "IncluirVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"aCaracteristicas": [
{
"nIdCaract": 0
}
],
"aVariacoes": [
{
"nCodProdAssoc": 0,
"cDescrProduto": "",
"cCodProduto": "",
"aValoresCaracteristicas": [
{
"nIdCaract": 0,
"nIdValor": 0
}
]
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/variacao/")
corpo = <<~'JSON'
{
"call": "IncluirVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"aCaracteristicas": [
{
"nIdCaract": 0
}
],
"aVariacoes": [
{
"nCodProdAssoc": 0,
"cDescrProduto": "",
"cCodProduto": "",
"aValoresCaracteristicas": [
{
"nIdCaract": 0,
"nIdValor": 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": "IncluirVariacoes",
"param": [
{
"nCodProd": 0,
"cCodIntProd": "",
"aCaracteristicas": [
{
"nIdCaract": 0
}
],
"aVariacoes": [
{
"nCodProdAssoc": 0,
"cDescrProduto": "",
"cCodProduto": "",
"aValoresCaracteristicas": [
{
"nIdCaract": 0,
"nIdValor": 0
}
]
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/variacao/"))
.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/produtos/variacao/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirVariacoes"", ""param"": [{""nCodProd"": 0, ""cCodIntProd"": """", ""aCaracteristicas"": [{""nIdCaract"": 0}], ""aVariacoes"": [{""nCodProdAssoc"": 0, ""cDescrProduto"": """", ""cCodProduto"": """", ""aValoresCaracteristicas"": [{""nIdCaract"": 0, ""nIdValor"": 0}]}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosMétodo para realizar a listagem das variações de grade do produto.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 7Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cExibirCaracteristicas | texto · até 1 | Campo S/N para filtrar as características das variacoes. |
cFiltrarApenasAlteracao | texto · até 1 | Filtrar apenas registros alterados para a data.
(S/N).Ex.: S, N |
cFiltrarApenasInclusao | texto · até 1 | Filtrar apenas registros incluídos para a data.
(S/N).Ex.: S, N |
cFiltrarPorDataAte | texto · até 10 | Informe aqui a data de início do filtro. |
cFiltrarPorDataDe | texto · até 10 | Informe aqui a data de início do filtro. |
nPagina | número inteiro | |
nRegPorPagina | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
listaVariacoes | lista de objetos | Informações das variações. |
listaVariacoes[].ident | objeto | Identificação do Produto. |
listaVariacoes[].ident.cCodIntProd | texto | Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag "nCodProd". |
listaVariacoes[].ident.cCodProduto | texto | Código do Produto exibido na tela de Produtos. |
listaVariacoes[].ident.cDescrProduto | texto | Descrição do produto. Descrição do nome do produto no Omie. |
listaVariacoes[].ident.nCodProd | 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. Utilize a tag "codigo_produto" do método "ListarProdutos" da API /api/v1/geral/produtos/ para obter essa informação. |
listaVariacoes[].variacoes | lista de objetos | Informação das variações do produto. |
listaVariacoes[].variacoes[].CaractVariacoes | lista de objetos | Características das variações. |
listaVariacoes[].variacoes[].CaractVariacoes[].cConteudoCaract | número inteiro | Conteúdo da característica. |
listaVariacoes[].variacoes[].CaractVariacoes[].cNomeCaract | texto | Nome da característica variante. |
listaVariacoes[].variacoes[].CaractVariacoes[].nIdCaract | número inteiro | Id da Característica. |
listaVariacoes[].variacoes[].cDescProdVariacao | texto | Descrição do produto variação . |
listaVariacoes[].variacoes[].nIdProdVariacao | número inteiro | Id do produto variação. Id do produto criado pelas características selecionadas. |
listaVariacoes[].variacoes[].nIdVariacao | número inteiro | Id da variação. Id criado para integrar com a característica do produto. |
nPagina | número inteiro | Número da página que será listada. |
nRegistros | número inteiro | Número de registros retornados. |
nTotPaginas | número inteiro | Total de páginas encontradas. |
nTotRegistros | número inteiro | Número total de registros. |
POST /api/v1/produtos/variacao/
curl -s https://app.omie.com.br/api/v1/produtos/variacao/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarVariacoes", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'import os
import requests
corpo = {'call': 'ListarVariacoes', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/variacao/",
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/produtos/variacao/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarVariacoes",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/variacao/");
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": "ListarVariacoes",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/variacao/")
corpo = <<~'JSON'
{
"call": "ListarVariacoes",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
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": "ListarVariacoes",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/variacao/"))
.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/produtos/variacao/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarVariacoes"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados