Obter estatísticas dos canais de vendas
/api/crm/v2/sales_channelsv2salesChannels.defaultRetorna a receita, o número de pedidos e o ticket médio para cada canal de vendas. Em uma única solicitação, podem ser retornados até dois períodos para comparar mês a mês. Os totais do período já estão calculados, e para gráficos são retornadas apenas as horas não vazias em UTC. Converta-as para o fuso horário do usuário e agregue por dias ou meses. Apenas pedidos concluídos são incluídos na receita.
Autorização
api-token + language + role
Parâmetros de consulta
Exemplo: 01/08/2026
Exemplo: 31/08/2026
Segundo período; vazio se não houver com o que comparar
Exemplo: 01/07/2026
Exemplo: 31/07/2026
Método de entrega: courier ou retirada
Valores:courierpickup
Status do pagamento: não pago, pendente, pago
Valores:not_paidwaitingpaid
Retorna uma tabela resumida do período A no formato CSV em vez de JSON
Valores:yes
Exemplo: yes
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
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
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
Botão de download da seleção: ao clicar, envie download=yes
Exemplo: Download
Exemplo: button_download_csv
Um elemento por período; o segundo — somente se um período de comparação for especificado
a — período principal, b — período de comparação
Valores:ab
Exemplo: a
Exemplo: 01/08/2026
Exemplo: 31/08/2026
Totais do período por todos os canais
Exemplo: 4120
Exemplo: 3894
Exemplo: 94.51
Exemplo: 4361280
Exemplo: 1120
Um elemento para cada canal com pedidos, em ordem fixa. Não há elemento "todos os canais": para isso existe total.
Plataforma de pedido
Valores:androidapifbiosvksite
Exemplo: 1810
Percentual de pedidos no período
Exemplo: 43.93
Exemplo: 1702
Exemplo: 94.03
Exemplo: 1855180
Participação na receita do período em porcentagem
Exemplo: 42.54
Receita dividida pelo número de pedidos concluídos
Exemplo: 1090
Comparação do canal com o mesmo canal no período B. null se o período B não for especificado.
Exemplo: -120400
null, se o canal não teve receita no período B: não há crescimento percentual a partir de zero
Exemplo: -6.09
Pedidos agrupados por horas; apenas horas não vazias. Converta o horário para o fuso horário do usuário e, em seguida, agrupe as horas em pontos do gráfico: gráfico linear — por dias ou meses, gráfico de barras — por meses do calendário. Some count, completed_count e revenue; não faça média dos valores médios.
Hora à qual os pedidos se referem, em UTC
Exemplo: 2026-08-01 09:00:00
Exemplo: 12
Exemplo: 11
Exemplo: 12100