Consumo de produtos

Quanto de cada produto foi vendido no período — só negócios ganhos, pela data de fechamento. Exige os três escopos.

GET https://app.salos.com.br/api/reports/products reports:read + products:read + deals:read

Parâmetros

Parâmetro Tipo O que faz
from AAAA-MM-DD obrigatório — primeiro dia do período
to AAAA-MM-DD obrigatório — último dia (entra no período). No máximo 366 dias depois de from
group_by product ou variant padrão product. Com variant, cada linha também traz variantId e variantSku

Resposta

{
  "data": {
    "from": "2026-07-01",
    "to": "2026-07-31",
    "groupBy": "product",
    "rows": [
      {
        "productId": "9f1e4b7a-2d5c-4f8e-8b3a-6c9d2e5f1a73",
        "productName": "Camiseta Básica",
        "variantId": null,
        "variantSku": null,
        "variantLabel": null,
        "quantity": 40,
        "revenue": 1996,
        "dealsCount": 12
      }
    ]
  }
}

⛔ Esta resposta é camelCase, ao contrário do resto da API. Conta só negócios ganhos, pela data de fechamento no calendário de Brasília. revenue é o total das linhas, já com desconto; dealsCount conta negócios distintos. Linhas da maior receita para a menor. Custo e imposto nunca saem. Como cada produto tem uma única variação, variant devolve os mesmos números — útil para casar pelo SKU. variantLabel vem sempre null.

Com "Só o dele" em Negócios ou em Relatórios, a soma é só dos negócios do responsável pela chave e dos sem responsável.