Entrar

Productos más vendidos

GET https://{organization}.myguper.com/api/order/report/products/{dateStart}/{dateEnd}

La respuesta a "qué se vendió más", "top productos por ingreso", "unidades por SKU", en una sola llamada — en vez de paginar los ítems y agrupar del lado del cliente. Ordena los ítems vendidos (order_item) por producto, SKU, categoría o marca, en el mismo recorte que el reporte de ventas (org, ventana en la zona horaria de la org, tienda, status).

Por fila: units (cantidad vendida), unitsCanceled, revenue, orders (cuántos pedidos lo incluyeron) y lines. Las filas son el top N por ingreso (limit, default 50); el total cubre todos los ítems del período, no solo el top.

Desglósalo por tienda o por tiempo en una sola llamada. groupBy acepta una lista separada por comas: el 1er token es la dimensión del ítem (product/sku/category/brand) y puedes sumar store y/o un grano de tiempo (day/week/month) — ej. groupBy=product,store, sku,week, product,store,month. Con desglose, el limit toma los top ítems de todo el período y cada fila es una celda (ítem × tienda × período) — tienes el detalle por tienda o semanal sin una llamada por tienda. La fila lleva storeId, day (YYYY-MM-DD), week (YYYY-Www, ISO) o month (YYYY-MM) según el caso; una celda sin ventas no se emite.

revenue es ingreso de LÍNEA — SUM(price × quantity), con price = valor unitario del ítem (neto del descuento del ítem). No es el total del pedido y no coincide con el ingreso del reporte de ventas: descuentos y ajustes de nivel-pedido no bajan al price del ítem, así que la suma de las líneas corre más alta (≈+20% medido). Usa este para ranking de producto; usa el order.report.sales para facturación. Valores en centavos.

category y brand vienen de ingesta parcial y están dispersos hoy (pocos % en algunas orgs). El endpoint ya está listo para ellos y se va llenando conforme la ingesta mejore — lee el meta.coverage (fracción de ítems e ingreso que tienen categoría/marca) para que un desglose que cubre 5% del período no se lea como el total. Las filas con id null son los ítems sin el campo. order_item no guarda el nombre de categoría/marca, solo el id y el refId externo.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parámetros de ruta

Name Type Description
dateStart * string Start of the period (YYYY-MM-DD), inclusive. The day is cut from order_date in the org timezone.
dateEnd * string End of the period (YYYY-MM-DD), inclusive.

Parámetros de query

Name Type Description
groupBy string Comma list: 1st token = item dimension (`product`/`sku`/`category`/`brand`, default `product`); optional extra tokens break it down by `store` and/or one time grain (`day`/`week`/`month`). E.g. `product,store`, `sku,week`, `product,store,month`. `product`/`sku` work today; `category`/`brand` are sparse (see `meta.coverage`). At most one time grain per call.
store integer Restrict to a single store id.
status string Order status. Default: all except canceled.
limit integer How many top rows by revenue (1-500). Default 50. The `total` always covers everything.

Respuestas

{
  "meta": {
    "unit": "cents", "timezone": "Etc/GMT+6",
    "groupBy": "product", "breakdown": [], "limit": 50,
    "filters": { "store": null, "status": "all except canceled (default)" },
    "coverage": {
      "category": { "items": 0.049, "revenue": 0.065 },
      "brand":    { "items": 0.049, "revenue": 0.061 }
    }
  },
  "rows": [
    { "productId": 0, "productName": "I-2 BILLETERA CLOE P25 564 ROSA /FLAP GR",
      "units": 256, "unitsCanceled": 0, "revenue": 122482432, "orders": 115, "lines": 121 }
  ],
  "total": { "units": 60663, "unitsCanceled": 0, "revenue": 6124205576, "orders": 24815, "lines": 56403 }
}

Relacionados

Copied to clipboard