Api do Demander - Políticas de Horário de Utilização

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir políticas de horário de utilização.

Conceito e funcionamento: Políticas de Horário de Utilização.

Consulta

Lista as políticas de horário da empresa. Sem filtro, retorna todas.

Rota: {host}/public/v1/politicas-de-horario?filtroDataAlteracao={data}&operadorFiltro={operador}&mostrarVendedores={boolean}
Método: GET

Cuidado

Filtros

• filtroDataAlteracao (opcional) — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (padrão >=)
• mostrarVendedores (opcional) — 1/true inclui a lista de códigos dos vendedores vinculados

Retorno:

[
  {
    "id": 123,
    "codigo": 1,
    "descricao": "Liberado Seg. a Sex. - 08:00 às 18:00",
    "ativo": true,
    "mensagemBloqueio": "Fora do horário permitido para utilização do aplicativo.",
    "operacoesBloqueadas": [
      "sincronizacaoMobile",
      "iniciarPedidoMobile"
    ],
    "horarios": {
      "segunda": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "18:00"
          }
        ]
      },
      "terca": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "18:00"
          }
        ]
      },
      "quarta": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "12:00"
          },
          {
            "inicio": "13:00",
            "fim": "18:00"
          }
        ]
      },
      "quinta": {
        "opcao": "liberado",
        "intervalos": []
      },
      "sexta": {
        "opcao": "liberado",
        "intervalos": []
      },
      "sabado": {
        "opcao": "bloqueado",
        "intervalos": []
      },
      "domingo": {
        "opcao": "bloqueado",
        "intervalos": []
      }
    },
    "dataAlteracao": "2025-06-10 14:30:00",
    "vendedores": [
      10,
      25,
      30
    ]
  }
]

Consulta única

Retorna uma política pelo codigo.

Rota: {host}/public/v1/politicas-de-horario/{codigo}?mostrarVendedores={boolean}
Método: GET

Retorno: mesmo objeto da listagem (sem o array).

Inserir ou atualizar

POST upsert pela chave codigo. Se codigo for omitido na inclusão, o Demander gera o próximo disponível.

Rota: {host}/public/v1/politicas-de-horario
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	int			Código da política. Na inclusão é opcional (auto). Se já existir, a requisição atualiza.
descricao	string		✓	Nome da política.
ativo	boolean			Indica se a política está ativa. Padrão na inclusão: true.
mensagemBloqueio	string			Mensagem exibida ao vendedor no bloqueio.
operacoesBloqueadas	array		✓	Operações bloqueadas fora do horário. Veja valores aceitos.
horarios	object		✓	Configuração dos 7 dias. Veja configuração de horários.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 200.

Atualização

• Apenas o atributo codigo é obrigatório. Demais campos opcionais (atualização parcial). Retorno 200.

Body:

{
  "descricao": "Liberado Seg. a Sex. - 08:00 às 18:00",
  "ativo": true,
  "mensagemBloqueio": "Fora do horário permitido para utilização do aplicativo.",
  "operacoesBloqueadas": [
    "sincronizacaoMobile",
    "iniciarPedidoMobile"
  ],
  "horarios": {
    "segunda": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "terca": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "quarta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "quinta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "sexta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "sabado": {
      "opcao": "bloqueado",
      "intervalos": []
    },
    "domingo": {
      "opcao": "bloqueado",
      "intervalos": []
    }
  }
}

Retorno:

{
  "mensagem": "Política de horário de utilização salva com sucesso.",
  "codigo": 1
}

Excluir

Remove a política pelo codigo.

Rota: {host}/public/v1/politicas-de-horario/{codigo}
Método: DELETE

Cuidado

Restrições

• Não exclui se estiver vinculada a vendedores ou for a política padrão da empresa. Retorno HTTP 422.

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}

Cuidado

Vínculo

• Esta API gerencia o cadastro das políticas. Para vincular à empresa ou a um vendedor, use o Demander Web em Configurações da Empresa ou Cadastro de Vendedores.

Operações bloqueadas

Valores aceitos em operacoesBloqueadas:

Valor	Descrição
sincronizacaoMobile	Sincronização no mobile (exportar/importar)
iniciarPedidoMobile	Iniciar digitação de novo pedido
editarPedidoMobile	Editar pedido existente
excluirPedidoMobile	Excluir pedido no mobile
salvarPedidoMobile	Salvar pedido no mobile
enviarPedidosParaWS	Exportar pedidos do mobile para o Demander Web
finalizarPedidosWeb	Finalizar pedidos no Demander Web

Configuração de horários

O objeto horarios deve conter os 7 dias: segunda, terca, quarta, quinta, sexta, sabado, domingo.

Propriedade	Tipo	Obrigatório	Descrição
opcao	string	✓	liberado, bloqueado ou liberadoEntre.
intervalos	array		Obrigatório quando opcao=liberadoEntre (até 2 intervalos). Vazio ([]) para liberado/bloqueado.

Intervalos no formato HH:mm:

"intervalos": [
{ "inicio": "08:00", "fim": "12:00" },
{ "inicio": "13:00", "fim": "18:00" }
]