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

Cotação, contratação e rastreio de frete

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

CancelarCotacao

altera dadosClaudeMCP

Cancelamento de uma cotação de frete.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarCotacao", "param": [{"nIdPedido": 3478512690}]}'

CotarFrete

altera dadosClaudeMCP

Realiza a cotação de frete.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
listaCotacaolista de objetoslista de opções de frete encontrados.
listaCotacao[].cDescricaoServicotextoDescrição do serviço de entrega.
listaCotacao[].cMetodoFretetextoMétodo de envio. Exemplo: STANDARD EXPRESS
listaCotacao[].cNomeTransportadoratextoNome da empresa responsável pela entrega.
listaCotacao[].cTipoServicotextoTipo do serviço de entrega. Exemplo: Correios PAC Correios SEDEX
listaCotacao[].nDiasEntreganúmero inteiroPrazo em dias para a entrega ser efetuada.
listaCotacao[].nIdFretenúmero inteiroID do frete. É utilizado para identificar a opção de entrega, esse campo será utilizado para gerar o frete. Essa informação é obtida executando o método CotarFrete, onde é retornado as opções de entrega disponíveis.
listaCotacao[].nValorFretedecimalValor do frete.
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CotarFrete", "param": [{"nIdPedido": 3478512690}]}'

GerarEtiqueta

altera dadosClaudeMCP

Gera as etiquetas do frete.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
listaEtiquetalista de objetosLista das etiquetas.
listaEtiqueta[].cUrlEtiquetatextoURL da etiqueta em formato PDF.
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GerarEtiqueta", "param": [{"nIdPedido": 3478512690}]}'

GerarFrete

altera dadosClaudeMCP

Gera o frete de um pedido de venda.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
cUrlRastreiotextoURL de rastreio do frete.
listaVolumelista de objetosLista de volumes do frete.
listaVolume[].cCodigoRastreiotextoCódigo de rastreio do volume do frete.
nIdPedidonúmero inteiroID do Pedido de Venda.
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GerarFrete", "param": [{"nIdPedido": 3478512690}]}'

ListarStatusFrete

consultaClaudeMCP

Obtem a listagem contendo os status das entregas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 6Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodigoStatustexto · até 3Filtra pelo código do status da entrega (3 caracteres; precisa existir na tabela de status de frete).
dStatustextoFiltra pela data da última atualização do status, no formato dd/mm/aaaa.
hStatustexto · até 8Filtra pela hora exata da última atualização do status, no formato hh:mm:ss.
nIdTranspnúmero inteiroFiltra pelo código da transportadora do pedido (código interno do cadastro de clientes e fornecedores).
nPaginanúmero inteiroNúmero da página. Padrão 1.
nRegPorPaginanúmero inteiroRegistros por página. Padrão 100, máximo 100 (valor maior volta a 100).
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoPreenchido só quando nada é encontrado ("100", com o aviso em cDesStatus).
cDesStatustextoDescrição do aviso quando nada é encontrado.
listaStatusFretelista de objetos
listaStatusFrete[].cCodigoOperadoratextoCódigo da operadora de frete (ex.: CORREIOS, MELHORENVIO, INTELIPOST).
listaStatusFrete[].cCodigoRastreiotextoCódigo de rastreio do volume na operadora.
listaStatusFrete[].cCodigoStatustextoCódigo do status da entrega, com 3 caracteres, conforme a tabela de status de frete da Omie.
listaStatusFrete[].cDescricaoStatustextoDescrição do status da entrega.
listaStatusFrete[].dEntregatextoPrevisão de entrega informada pela operadora, no formato dd/mm/aaaa.
listaStatusFrete[].dStatustextoData da última atualização do status, no formato dd/mm/aaaa.
listaStatusFrete[].hStatustextoHora da última atualização do status, no formato hh:mm:ss.
listaStatusFrete[].nIdPedidonúmero inteiroCódigo interno do pedido de venda.
listaStatusFrete[].nIdTranspnúmero inteiroCódigo da transportadora do pedido de venda (código interno do cadastro de clientes e fornecedores).
nPaginanúmero inteiroNúmero da página devolvida.
nRegistrosnúmero inteiroRegistros devolvidos nesta página.
nTotPaginasnúmero inteiroTotal de páginas.
nTotRegistrosnúmero inteiroTotal de registros encontrados.
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarStatusFrete", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'

ObterRastreio

consultaClaudeMCP

Obtem a URL de rastreio do frete.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodRastreiotextoCódigo de Rastreio do Pedido
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
cUrlRastreiotextoURL do rastreio do frete.
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterRastreio", "param": [{"nIdPedido": 3478512690}]}'

SelecionarFrete

altera dadosClaudeMCP

Seleciona o frete a partir das opção de uma cotação.

Obrigatórios 1

CampoTipoDescrição
nIdFretenúmero inteiroID do frete. É utilizado para identificar a opção de entrega, esse campo será utilizado para gerar o frete. Essa informação é obtida executando o método CotarFrete, onde é retornado as opções de entrega disponíveis.
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
lGratissim/nãoIndica se o frete amarrado ao pedido é grátis
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "SelecionarFrete", "param": [{"nIdFrete": 3478519021, "lGratis": false}]}'

StatusFrete

consultaClaudeMCP

Obtêm o status da entrega.

Obrigatórios 1

CampoTipoDescrição
nIdPedidonúmero inteiroID do Pedido de Venda.
Retorno 10O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do status do processamento. "0" é sucesso; outro valor indica recusa, com o motivo em cDesStatus.
cCodigoOperadoratextoCódigo da operadora de frete (ex.: CORREIOS, MELHORENVIO, INTELIPOST).
cCodigoRastreiotextoCódigo de rastreio do volume na operadora.
cCodigoStatustextoCódigo do status da entrega, com 3 caracteres, conforme a tabela de status de frete da Omie.
cDesStatustextoDescrição do status do processamento.
cDescricaoStatustextoDescrição do status da entrega.
dEntregatextoPrevisão de entrega informada pela operadora, no formato dd/mm/aaaa.
dStatustextoData da última atualização do status, no formato dd/mm/aaaa.
hStatustextoHora da última atualização do status, no formato hh:mm:ss.
nIdTranspnúmero inteiroCódigo da transportadora do pedido de venda (código interno do cadastro de clientes e fornecedores).
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "StatusFrete", "param": [{"nIdPedido": 3478512690}]}'

VincularFrete

altera dadosClaudeMCP

Vincular um Tipo de serviço de Frete a um pedido.

Obrigatórios 3

CampoTipoDescrição
cCodigoOperadoratexto · até 50Código da operadora de frete integrada e habilitada na empresa (ex.: CORREIOS, MELHORENVIO, MANDAE, FRENET, LOGGI, INTELIPOST, TOTALEXPRESS, FRETERAPIDO).
cTipoServicotexto · até 100Tipo do serviço de entrega. Exemplo: Correios PAC Correios SEDEX 03220 F_3
nIdPedidonúmero inteiroCódigo interno do pedido de venda.
Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodigoCotacaotexto · até 100Código da cotação. Usado somente quando o cCodigoOperadora == "INTELIPOST"
cNomeTransportadoratexto · até 100Nome da empresa responsável pela entrega. Nas operadoras com serviço cadastrado o nome vem do cadastro do serviço.
lGratissim/nãotrue deixa o frete sem custo para o cliente.
nDiasEntreganúmero inteiroPrazo de entrega em dias.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDesStatustextoDescrição do Status
POST /api/v1/produtos/frete/
curl -s https://app.omie.com.br/api/v1/produtos/frete/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "VincularFrete", "param": [{"nIdPedido": 3478512690, "cCodigoOperadora": "CORREIOS", "cTipoServico": "03298", "nDiasEntrega": 5, "lGratis": false}]}'