Obter o mapa de calor de pedidos por horário
/api/crm/v2/orders_over_timev2ordersOverTime.defaultRetorna um mapa de calor de pedidos: horas do dia por dias da semana, dias do calendário ou meses. Até dois períodos podem ser retornados por solicitação para comparar semana a semana ou mês a mês. Os pedidos são agregados por hora em UTC, e apenas as horas não vazias são retornadas. A conversão para o fuso horário do usuário, a agregação por linhas e as células vazias são tratadas no lado do cliente.
Autorização
api-token + language + role
Parâmetros de consulta
Exemplo: 25/04/2024
Exemplo: 26/04/2024
Segundo período; vazio se não houver com o que comparar
Exemplo: 25/03/2024
Exemplo: 26/03/2024
Linhas da grade: dias da semana, dias do calendário ou meses. Afeta apenas a exibição e nunca a agregação.
Valores:weekdaydaymonth
Status do pedido: em trânsito, concluído, em montagem, na cozinha, não processado, pronto para envio, aguardando envio para a cozinha, aguardando refação, cancelado, confirmado, preparado
Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked
Exemplo: confirmed
Plataforma de pedido
Valores:androidapifbiosvksite
Método de entrega: courier ou retirada
Valores:courierpickup
Status do pagamento: não pago, pendente, pago
Valores:not_paidwaitingpaid
Respostas
OK
Valores:successerror
Exemplo: success
Exemplo: 2026-08-01 00:00:00
Exemplo: date
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 2026-08-31 23:59:59
Exemplo: date
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Exemplo: 25/08/2026
Exemplo: 2026-08-01 00:00:00
Exemplo: date
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 2026-08-31 23:59:59
Exemplo: date
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Períodos prontos para filtro de datas sem valor padrão: default é sempre igual a null.
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Exemplo: select
Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.
Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Exemplo: today
Exemplo: 25/08/2026
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.
Valores:force_shownvalue_required
Exemplo: value_required
Valores:ab
Exemplo: a
Exemplo: 25/04/2024
Exemplo: 26/04/2024
Período predefinido correspondente aos limites; null se o período for personalizado
Exemplo: week
Exemplo: 47
Exemplo: 52640
Exemplo: 1120
Pedidos agrupados por hora; apenas horas não vazias. Converta o horário para o fuso horário do usuário, depois determine a linha e a coluna pelo resultado e preencha as lacunas com zeros.
Hora à qual os pedidos se referem, em UTC
Exemplo: 2024-04-25 14:00:00
Exemplo: 47
Exemplo: 52640