Produtos mais vendidos
A resposta para "o que mais vendeu", "top produtos por receita", "unidades por
SKU", numa única chamada — em vez de paginar os itens e agrupar no cliente.
Ranqueia os itens vendidos (order_item) por produto, SKU, categoria ou marca,
no mesmo recorte do relatório de vendas (org, janela no fuso da org, loja,
status).
Por linha: units (quantidade vendida), unitsCanceled, revenue, orders
(quantos pedidos incluíram) e lines. As linhas são o top N por receita
(limit, default 50); o total cobre todos os itens do período, não só o top.
Quebre por loja ou por tempo numa chamada só. O groupBy aceita lista por
vírgula: o 1º token é a dimensão do item (product/sku/category/brand) e
você pode somar store e/ou um grão de tempo (day/week/month) — ex.
groupBy=product,store, sku,week, product,store,month. Com quebra, o limit
pega os top itens do período inteiro e cada linha é uma célula
(item × loja × período) — você tem o detalhe por loja ou por semana sem uma
chamada por loja. A linha carrega storeId, day (YYYY-MM-DD), week (YYYY-Www,
ISO) ou month (YYYY-MM) conforme o caso; célula sem venda não vira linha.
revenue é receita de LINHA — SUM(price × quantity), com price = valor
unitário do item (líquido do desconto do item). Não é o total do pedido e
não bate com a receita do relatório de vendas: descontos e ajustes de
nível-pedido não descem pro price do item, então a soma das linhas roda mais alta
(≈+20% medido). Use este para ranking de produto; use o order.report.sales
para faturamento. Valores em centavos.
category e brand vêm de ingestão parcial e estão esparsos hoje (poucos %
em algumas orgs). O endpoint já está pronto pra eles e vai enchendo conforme a
ingestão melhorar — leia o meta.coverage (fração de itens e receita que têm
categoria/marca) pra uma quebra que cobre 5% do período não ser lida como o total.
Linhas com id null são os itens sem o campo. O order_item não guarda o nome
de categoria/marca, só o id e o refId externo.
Try-it values populated from environment ACME (Demo)
Autenticação
Token
Send your user token in the x-guper-authorization header.