v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Retorna indicadores de faturamento (receita, ticket médio e número de pedidos) da loja

Indicadores de Faturamento

get/dashboard/faturamento

Query parameters

dataInicialstring date

Data inicial dos indicadores que deverão retonar (aaaa-mm-dd)

dataFinalstring date

Data final dos indicadores que deverão retonar (aaaa-mm-dd)

dataInicialComparativostring date

Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)

dataFinalComparativostring date

Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)

Response

200

indicadorReceitainteger

indicadorPedidointeger

indicadorTicketMediointeger

indicadorReceitaComparativointeger

indicadorPedidoComparativointeger

indicadorTicketMedioComparativointeger

indicadorReceitaFormatadostring

indicadorPedidoFormatadostring

indicadorTicketMedioFormatadostring

indicadorReceitaComparativoFormatadostring

indicadorPedidoComparativoFormatadostring

indicadorTicketMedioComparativoFormatadostring

indicadorReceitaPorcentagemstring

indicadorPedidoPorcentagemstring

indicadorTicketMedioPorcentagemstring

Example response

{
  "indicadorReceitaFormatado": "string",
  "indicadorPedidoFormatado": "string",
  "indicadorTicketMedioFormatado": "string",
  "indicadorReceitaComparativoFormatado": "string",
  "indicadorPedidoComparativoFormatado": "string",
  "indicadorTicketMedioComparativoFormatado": "string",
  "indicadorReceitaPorcentagem": "string",
  "indicadorPedidoPorcentagem": "string",
  "indicadorTicketMedioPorcentagem": "string"
}