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

Cadastro de características de produto

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

AlterarCaracteristica

altera dadosClaudeMCP

Altera uma característica de produto.

Obrigatórios 1

CampoTipoDescrição
cNomeCaracttexto · até 30Nome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição.
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.
cValorDeftexto · até 1Definir os conteúdos possíveis para essa característica (S/N). Como padrão o valor é "N".Ex.: S, N
conteudosPermitidoslista de objetos
conteudosPermitidos[].cConteudotextoDescrição do conteúdo da característica.
conteudosPermitidos[].nIdConteudonúmero inteiroId do do Conteúdo/valor da característica.
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.
Retorno 4O 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.
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.
POST /api/v1/geral/caracteristicas/
curl -s https://app.omie.com.br/api/v1/geral/caracteristicas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarCaracteristica", "param": [{"nCodCaract": 0, "cCodIntCaract": "", "cNomeCaract": ""}]}'

ConsultarCaracteristica

consultaClaudeMCP

Consulta uma característica de produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos 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.
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.
Retorno 5O 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.
cNomeCaracttextoNome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição.
conteudosPermitidoslista de objetos
conteudosPermitidos[].cConteudotextoDescrição do conteúdo da característica.
conteudosPermitidos[].nIdConteudonúmero inteiroId do do Conteúdo/valor da característica.
infoobjetoInformações complementares da característica do produto.
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.
POST /api/v1/geral/caracteristicas/
curl -s https://app.omie.com.br/api/v1/geral/caracteristicas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarCaracteristica", "param": [{"nCodCaract": 0, "cCodIntCaract": ""}]}'

ExcluirCaracteristica

altera dadosClaudeMCP

Exclui uma característica de produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos 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.
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.
Retorno 4O 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.
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.
POST /api/v1/geral/caracteristicas/
curl -s https://app.omie.com.br/api/v1/geral/caracteristicas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirCaracteristica", "param": [{"nCodCaract": 0, "cCodIntCaract": ""}]}'

IncluirCaracteristica

altera dadosClaudeMCP

Inclui uma característica de produto.

Obrigatórios 2

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.
cNomeCaracttexto · até 30Nome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cValorDeftexto · até 1Definir os conteúdos possíveis para essa característica (S/N). Como padrão o valor é "N".Ex.: S, N
conteudosPermitidoslista de objetos
conteudosPermitidos[].cConteudotextoDescrição do conteúdo da característica.
conteudosPermitidos[].nIdConteudonúmero inteiroId do do Conteúdo/valor da característica.
Retorno 4O 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.
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.
POST /api/v1/geral/caracteristicas/
curl -s https://app.omie.com.br/api/v1/geral/caracteristicas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirCaracteristica", "param": [{"cCodIntCaract": "CPROD1790776558", "cNomeCaract": ""}]}'

ListarCaracteristicas

consultaClaudeMCP

Listar as características de produto.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 8Campos e estruturas que você pode enviar
CampoTipoDescrição
cOrdemDecrescentetexto · até 1Indica se a ordem de exibição é Decrescente caso seja informado "S".
cOrdenarPortexto · até 100Ordem os resultados da página por: CODIGO - Código do 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.
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[].cNomeCaracttextoNome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição.
listaCaracteristicas[].conteudosPermitidoslista de objetos
listaCaracteristicas[].conteudosPermitidos[].cConteudotextoDescrição do conteúdo da característica.
listaCaracteristicas[].conteudosPermitidos[].nIdConteudonúmero inteiroId do do Conteúdo/valor da característica.
listaCaracteristicas[].infoobjetoInformações complementares da característica do produto.
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.
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/caracteristicas/
curl -s https://app.omie.com.br/api/v1/geral/caracteristicas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarCaracteristicas", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'