Produtos ·
PedidoVendaEtapaEtapas do processo de vendas de produtos
1consulta
0alterações
Claude · ChatGPT · MCPpelos assistentes de IA
JSON · XMLformato
Lista as etapas do Pedido de Venda de Produtos.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 11Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntPed | texto · até 60 | Código de Integração do Pedido de Venda de Produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do Pedido de Venda utilizado no seu aplicativo quando incluir um Pedido no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag cCodIntPed. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada. |
cEtapa | texto · até 2 | Etapa do Pedido de Venda. |
cHrFinal | texto · até 8 | Hora final. No Formato hh:mm:ss. |
cHrInicial | texto · até 8 | Hora inicial. No formato hh:mm:ss. |
cOrdemDecrescente | texto · até 1 | Indica se a ordem de exibição é Decrescente caso seja informado "S". |
cOrdenarPor | texto · até 100 | Ordem os resultados da página por: CODIGO - Código do Pedido de Venda. DATAHORA - Data + Hora da mudança da etapa do pedido. |
dDtFinal | texto · até 10 | Data final. No formato dd/mm/aaaa. |
dDtInicial | texto · até 10 | Data inicial. No formato dd/mm/aaaa. |
nCodPed | número inteiro | Código do Pedido de Venda de Produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do Pedido de Venda gerado pelo Omie. |
nPagina | número inteiro | Número da página que se deseja resgatar. O padrão é "1". |
nRegPorPagina | número inteiro | Nú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
| Campo | Tipo | Descrição |
|---|---|---|
etapasPedido | lista de objetos | Lista de status do pedido encontrados. |
etapasPedido[].cCodIntPed | texto | Código de Integração do Pedido de Venda de Produto. |
etapasPedido[].cEtapa | texto | Etapa do Pedido de Venda. |
etapasPedido[].cHrEtapa | texto | Hora da Etapa do Pedido de Venda. No formato hh:mm:ss. |
etapasPedido[].cNumero | texto | Número do Pedido de Venda. (Visualizado na tela do Omie.) |
etapasPedido[].cUsEtapa | texto | Usuário que mudou a Etapa do Pedido de Venda. |
etapasPedido[].cancelamento | objeto | Dados do Cancelamento. |
etapasPedido[].cancelamento.cCancelado | texto | Pedido de Vendas foi cancelado (S/N)? |
etapasPedido[].cancelamento.cHrCanc | texto | Hora do Cancelamento do Pedido. No formato hh:mm:ss. |
etapasPedido[].cancelamento.cUsCanc | texto | Usuário que realizou o Cancelamento do pedido. |
etapasPedido[].cancelamento.dDtCanc | texto | Data do Cancelamento do Pedido. No formato dd/mm/aaaa. |
etapasPedido[].dDtEtapa | texto | Data da Etapa do Pedido de Venda. No formato dd/mm/aaaa. |
etapasPedido[].devolucao | objeto | Dados da Devolução. |
etapasPedido[].devolucao.cDevolvido | texto | Pedido de Vendas foi devolvido (S/N)? |
etapasPedido[].devolucao.cHrDev | texto | Hora da Devolução do Pedido. No formato hh:mm:ss. |
etapasPedido[].devolucao.cUsDev | texto | Usuário que realizou a devolução do pedido. |
etapasPedido[].devolucao.dDtDev | texto | Data da Devolução do Pedido. No formato dd/mm/aaaa. |
etapasPedido[].faturamento | objeto | Dados do faturamento. |
etapasPedido[].faturamento.cAmbiente | texto | Ambiente em que a NF-e foi gerada. Pode ser: H - Homologação. P - Produção. |
etapasPedido[].faturamento.cAutorizado | texto | NFE foi autorizada (S/N)? |
etapasPedido[].faturamento.cChaveNFE | texto | Chave da NF-e gerada. |
etapasPedido[].faturamento.cDANFE | texto | DANFE foi gerado (S/N)? |
etapasPedido[].faturamento.cDenegado | texto | NFE foi denegada (S/N)? |
etapasPedido[].faturamento.cFaturado | texto | Pedido de Vendas foi faturado (S/N)? |
etapasPedido[].faturamento.cHrFat | texto | Hora do Faturamento do Pedido. No formato hh:mm:ss. |
etapasPedido[].faturamento.cHrSaida | texto | Hora de Saída da NF-e. |
etapasPedido[].faturamento.cNumNFE | texto | Número da NF-e Gerada. |
etapasPedido[].faturamento.cSerieNFE | texto | Série da NF-e gerada. |
etapasPedido[].faturamento.cUsDev | texto | Usuário que realizou o faturamento do pedido. |
etapasPedido[].faturamento.dDtFat | texto | Data de Faturamento do Pedido. No formato dd/mm/aaaa. |
etapasPedido[].faturamento.dDtSainda | texto | Data de Saída da NF-e. |
etapasPedido[].info | objeto | Outras informações do pedido. |
etapasPedido[].info.cImpAPI | texto | Importado pela API (S/N). |
etapasPedido[].info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
etapasPedido[].info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
etapasPedido[].info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
etapasPedido[].info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
etapasPedido[].info.uAlt | texto | Usuário da Alteração. |
etapasPedido[].info.uInc | texto | Usuário da Inclusão. |
etapasPedido[].nCodPed | número inteiro | Código do Pedido de Venda de Produto. |
nPagina | número inteiro | Número da página resgatada. |
nRegistros | número inteiro | Número de registros retornados na página. |
nTotPaginas | número inteiro | Número total de páginas encontradas. |
nTotRegistros | número inteiro | Número total de registros encontrados. |
POST /api/v1/produtos/pedidoetapas/
curl -s https://app.omie.com.br/api/v1/produtos/pedidoetapas/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarEtapasPedido", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'import os
import requests
corpo = {'call': 'ListarEtapasPedido', 'param': [{'nPagina': 1, 'nRegPorPagina': 20}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/pedidoetapas/",
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/pedidoetapas/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarEtapasPedido",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/pedidoetapas/");
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": "ListarEtapasPedido",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/pedidoetapas/")
corpo = <<~'JSON'
{
"call": "ListarEtapasPedido",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
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": "ListarEtapasPedido",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/pedidoetapas/"))
.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/pedidoetapas/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarEtapasPedido"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados