A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Busca as situações a partir do seu módulo.
curl |
curl |
PHP |
$apikey = "{apikey}"; |
C# |
public static void ExecuteGetSituacao() { |
Parâmetro | Descrição | Tipo |
apikey | API key gerada no sistema. | string |
módulo | Módulo das situações que você deseja consultar. Utilizar o nome exibido na tabela de módulos. | string |
Tabela de módulos
Nome | Módulo |
Vendas | Pedidos de Venda |
PedidosCompra | Pedidos de Compra |
OrdemServico | Ordem de Serviço |
Retorno
Em caso de sucesso, retornará as situações do módulo especificado, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Exemplo:
{
"retorno": {
"situacoes": [
{
"situacao": {
"id": "6",
"idHerdado": "0",
"nome": "Em aberto",
"cor": "#E9DC40"
}
},
{
"situacao": {
"id": "9",
"idHerdado": "0",
"nome": "Atendido",
"cor": "#3FB57A"
}
},
{
"situacao": {
"id": "12",
"idHerdado": "0",
"nome": "Cancelado",
"cor": "#CBCBCB"
}
},
{
"situacao": {
"id": "15",
"idHerdado": "0",
"nome": "Em andamento",
"cor": "#0065F9"
}
},
{
"situacao": {
"id": "18",
"idHerdado": "0",
"nome": "Venda Agenciada",
"cor": "#FF7835"
}
},
{
"situacao": {
"id": "21",
"idHerdado": "0",
"nome": "Em digitação",
"cor": "#FF66E3"
}
},
{
"situacao": {
"id": "24",
"idHerdado": "0",
"nome": "Verificado",
"cor": "#85F39E"
}
}
]
}
}