OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · ProdutosVariacoes

Variação do produto

POSThttps://app.omie.com.br/api/v1/produtos/variacao/WSDL
2consultas
1alteração
Claude · MCPpelos assistentes de IA
JSON · XMLformato

ConsultarVariacoes

consultaClaudeMCP

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
CampoTipoDescrição
cCodIntProdtexto · até 60Có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".
nCodProdnúmero inteiroCó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
CampoTipoDescrição
identobjetoIdentificação do Produto.
ident.cCodIntProdtextoCó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.cCodProdutotextoCódigo do Produto exibido na tela de Produtos.
ident.cDescrProdutotextoDescrição do produto. Descrição do nome do produto no Omie.
ident.nCodProdnúmero inteiroCó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.
variacoeslista de objetosConjunto de variações do produto.
variacoes[].CaractVariacoeslista de objetosCaracterísticas das variações.
variacoes[].CaractVariacoes[].cConteudoCaractnúmero inteiroConteúdo da característica.
variacoes[].CaractVariacoes[].cNomeCaracttextoNome da característica variante.
variacoes[].CaractVariacoes[].nIdCaractnúmero inteiroId da Característica.
variacoes[].cDescProdVariacaotextoDescrição do produto variação .
variacoes[].nIdProdVariacaonúmero inteiroId do produto variação. Id do produto criado pelas características selecionadas.
variacoes[].nIdVariacaonúmero inteiroId 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": ""}]}'

IncluirVariacoes

altera dadosClaudeMCP

Mé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
CampoTipoDescrição
aCaracteristicaslista de objetosLista com as característica para a criação da variação do produto. É permitido informar no máximo 2 características.
aCaracteristicas[].nIdCaractobrigatórionúmero inteiroId da característica.
aVariacoeslista de objetosConfiguração manual da variação do produto. Deve ser preenchido apenas quando deseja informar manualmente as variações do produto.
aVariacoes[].aValoresCaracteristicaslista de objetos
aVariacoes[].aValoresCaracteristicas[].nIdCaractobrigatórionúmero inteiroId da característica.
aVariacoes[].aValoresCaracteristicas[].nIdValorobrigatórionúmero inteiroId do valor da característica.
aVariacoes[].cCodProdutotexto · até 60Código do produto variação. Quando informado, esse código será alocado ao novo produto gerado.
aVariacoes[].cDescrProdutotexto · até 120Descrição do produto variação. Quando informado, essa descrição será alocada ao novo produto gerado.
aVariacoes[].nCodProdAssocnúmero inteiroCó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.
cCodIntProdtexto · até 60Có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".
nCodProdnúmero inteiroCó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
CampoTipoDescrição
cCodStatustextoIdentificação do Produto.
cDesStatustexto
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}]}]}]}'

ListarVariacoes

consultaClaudeMCP

Mé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
CampoTipoDescrição
cExibirCaracteristicastexto · até 1Campo S/N para filtrar as características das variacoes.
cFiltrarApenasAlteracaotexto · até 1Filtrar apenas registros alterados para a data. (S/N).Ex.: S, N
cFiltrarApenasInclusaotexto · até 1Filtrar apenas registros incluídos para a data. (S/N).Ex.: S, N
cFiltrarPorDataAtetexto · até 10Informe aqui a data de início do filtro.
cFiltrarPorDataDetexto · até 10Informe aqui a data de início do filtro.
nPaginanúmero inteiro
nRegPorPaginanúmero inteiro
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
listaVariacoeslista de objetosInformações das variações.
listaVariacoes[].identobjetoIdentificação do Produto.
listaVariacoes[].ident.cCodIntProdtextoCó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.cCodProdutotextoCódigo do Produto exibido na tela de Produtos.
listaVariacoes[].ident.cDescrProdutotextoDescrição do produto. Descrição do nome do produto no Omie.
listaVariacoes[].ident.nCodProdnúmero inteiroCó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[].variacoeslista de objetosInformação das variações do produto.
listaVariacoes[].variacoes[].CaractVariacoeslista de objetosCaracterísticas das variações.
listaVariacoes[].variacoes[].CaractVariacoes[].cConteudoCaractnúmero inteiroConteúdo da característica.
listaVariacoes[].variacoes[].CaractVariacoes[].cNomeCaracttextoNome da característica variante.
listaVariacoes[].variacoes[].CaractVariacoes[].nIdCaractnúmero inteiroId da Característica.
listaVariacoes[].variacoes[].cDescProdVariacaotextoDescrição do produto variação .
listaVariacoes[].variacoes[].nIdProdVariacaonúmero inteiroId do produto variação. Id do produto criado pelas características selecionadas.
listaVariacoes[].variacoes[].nIdVariacaonúmero inteiroId da variação. Id criado para integrar com a característica do produto.
nPaginanúmero inteiroNúmero da página que será listada.
nRegistrosnúmero inteiroNúmero de registros retornados.
nTotPaginasnúmero inteiroTotal de páginas encontradas.
nTotRegistrosnúmero inteiroNú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}]}'