OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Geral · ProdutosCaracteristicas

Características do produto

POSThttps://app.omie.com.br/api/v1/geral/prodcaract/WSDL
2consultas
3alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

AlterarCaractProduto

altera dadosClaudeMCP

Altera a característica de um produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 8Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntCaracttexto · até 60Có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.
cCodIntProdtexto · até 60Có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.
cConteudotexto · até 60Conteúdo da característica.
cExibirItemNFtexto · até 1Exibir esta característica no item da NF-e emitida (S/N).Ex.: S, N
cExibirItemPedidotexto · até 1Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N).Ex.: S, N
cExibirOrdemProdtexto · até 1Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N).Ex.: S, N
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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
CampoTipoDescrição
cCodIntCaracttextoCó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.
cCodIntProdtextoCó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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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"}]}'

ConsultarCaractProduto

consultaClaudeMCP

Consultar uma característica de um produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntCaracttexto · até 60Có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.
cCodIntProdtexto · até 60Có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.
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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
CampoTipoDescrição
cCodIntCaracttextoCó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.
cCodIntProdtextoCó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.
cConteudotextoConteúdo da característica.
cExibirItemNFtextoExibir esta característica no item da NF-e emitida (S/N).
cExibirItemPedidotextoExibir esta característica no item do Pedido, Remessa ou Devolução (S/N).
cExibirOrdemProdtextoExibir esta característica na Ordem de Produção e Mapa de Custo (S/N).
cNomeCaracttextoNome da característica.
infoobjetoInformações complemetares da característica.
info.cImpAPItextoImportado pela API (S/N).
info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
info.hAlttextoHora da Alteração. No formato hh:mm:ss.
info.hInctextoHora da Inclusão. No formato hh:mm:ss.
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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": ""}]}'

ExcluirCaractProduto

altera dadosClaudeMCP

Excluir um característica de um produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntCaracttexto · até 60Có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.
cCodIntProdtexto · até 60Có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.
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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
CampoTipoDescrição
cCodIntCaracttextoCó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.
cCodIntProdtextoCó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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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": ""}]}'

IncluirCaractProduto

altera dadosClaudeMCP

Inclui uma característica a um produto.

Obrigatórios 1

CampoTipoDescrição
cConteudotexto · até 60Conteúdo da característica.
Opcionais 7Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntCaracttexto · até 60Có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.
cCodIntProdtexto · até 60Có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.
cExibirItemNFtexto · até 1Exibir esta característica no item da NF-e emitida (S/N).Ex.: S, N
cExibirItemPedidotexto · até 1Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N).Ex.: S, N
cExibirOrdemProdtexto · até 1Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N).Ex.: S, N
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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
CampoTipoDescrição
cCodIntCaracttextoCó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.
cCodIntProdtextoCó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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
nCodCaractnúmero inteiroCó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.
nCodProdnúmero inteiroCó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"}]}'

ListarCaractProduto

consultaClaudeMCP

Lista as características de um produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 10Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntProdtexto · até 60Có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.
cOrdemDecrescentetexto · até 1Indica se a ordem de exibição é Decrescente caso seja informado "S".
cOrdenarPortexto · até 100Ordena 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.
dDtAltAtetexto · até 10Data de alteração final. No formato dd/mm/aaaa.
dDtAltDetexto · até 10Data de alteração inicial. No formato dd/mm/aaaa.
dDtIncAtetexto · até 10Data de inclusão final. No formato dd/mm/aaaa.
dDtIncDetexto · até 10Data de inclusão inicial. No formato dd/mm/aaaa.
nCodProdnúmero inteiroCó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.
nPaginanúmero inteiroNúmero da página que se deseja resgatar. O padrão é "1".
nRegPorPaginanúmero inteiroNú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
CampoTipoDescrição
listaCaracteristicaslista de objetosLista de características de produto.
listaCaracteristicas[].cCodIntCaracttextoCó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[].cCodIntProdtextoCó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[].cConteudotextoConteúdo da característica.
listaCaracteristicas[].cExibirItemNFtextoExibir esta característica no item da NF-e emitida (S/N).
listaCaracteristicas[].cExibirItemPedidotextoExibir esta característica no item do Pedido, Remessa ou Devolução (S/N).
listaCaracteristicas[].cExibirOrdemProdtextoExibir esta característica na Ordem de Produção e Mapa de Custo (S/N).
listaCaracteristicas[].cNomeCaracttextoNome da característica.
listaCaracteristicas[].infoobjetoInformações complemetares da característica.
listaCaracteristicas[].info.cImpAPItextoImportado pela API (S/N).
listaCaracteristicas[].info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
listaCaracteristicas[].info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
listaCaracteristicas[].info.hAlttextoHora da Alteração. No formato hh:mm:ss.
listaCaracteristicas[].info.hInctextoHora da Inclusão. No formato hh:mm:ss.
listaCaracteristicas[].info.uAlttextoUsuário da Alteração.
listaCaracteristicas[].info.uInctextoUsuário da Inclusão.
listaCaracteristicas[].nCodCaractnúmero inteiroCó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[].nCodProdnúmero inteiroCó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.
nPaginanúmero inteiroNúmero da página resgatada.
nRegistrosnúmero inteiroNúmero de registros retornados na página.
nTotPaginasnúmero inteiroNúmero total de páginas encontradas.
nTotRegistrosnúmero inteiroNú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}]}'