Entrar

Audiencia por producto

GET https://{organization}.myguper.com/api/order/report/by-product/{dateStart}/{dateEnd}

Clientes que compraron un producto en una ventana — emparejados por patrón de nombre o por SKU — la audiencia que el constructor QON no expresa, porque no tiene ninguna columna de ítem, SKU, categoría o marca. Responde "quién compró maleta por encima de $500 este semestre", "compradores de estos SKUs", en una sola llamada en vez de paginar cientos de miles de líneas de ítem y agrupar del lado del cliente.

Empareja por productNameLike (lista de patrones, OR entre ellos, sin distinguir mayúsculas ni acentos, contains) y/o skuRefId (exacto). Al menos uno es obligatorio. Acota por precio unitario (unitPriceMin/unitPriceMax) y por piezas (minQuantity, neto de cancelación).

price es el precio unitario, neto de descuento — así que unitPriceMin/ Max filtran el unitario directo, no price/quantity. Eso separa un producto real de un regalo promocional de 1 centavo en la misma familia. value es SUM(price × cantidad neta) — lo gastado en los ítems que emparejaron, en centavos.

Por fila: pieces (cantidad neta comprada), value, lastDate y matchedPatterns — cuáles de tus patrones de productNameLike emparejó el cliente, para mostrar por qué cada uno está en la audiencia. La ventana y el lastDate están en la zona horaria de la org. Las filas se paginan (e/p); total es el tamaño de la audiencia.

Es solo el lado de order — client (id) + métricas. Nombre, correo, teléfono, última tienda y grupo de tienda viven en register; también los filtros de "excluir estas listas" y "debe tener contacto". Enriquece y filtra con las operaciones de register, y cierra el ciclo con register.audience-list.person.create (que recibe los ids de los clientes).

Emparejar por nombre hereda el desorden de la nomenclatura del POS. category/categoryRefId vienen vacíos o inconsistentes en algunas orgs (Cloe incluida), así que el nombre es la clave confiable hoy — pero arrastra grafías heredadas y patrones de referencia externa. Amplía productNameLike ante la duda, y lee matchedPatterns para ver qué atrapó de verdad.

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 Inicio de la ventana (YYYY-MM-DD), inclusivo. Cortado de order_date en la zona horaria de la org.
dateEnd * string Fin de la ventana (YYYY-MM-DD), inclusivo.

Parámetros de query

Name Type Description
productNameLike[] array Patrones de nombre de producto (contains, OR entre ellos, sin distinguir mayúsculas ni acentos). Uno por valor: productNameLike[]=a&productNameLike[]=b. Obligatorio si no hay skuRefId.
skuRefId[] array Refs externas de SKU, match exacto (OR). Uno por valor. Obligatorio si no hay productNameLike.
unitPriceMin integer Precio unitario mínimo en centavos (inclusivo), sobre el unitario con descuento (`price`). Úsalo para excluir regalos promocionales.
unitPriceMax integer Precio unitario máximo en centavos (inclusivo).
minQuantity integer Mínimo de piezas compradas, neto de cancelación. Default 1.
status string Estatus del pedido contado. Default `completed`. `all` = todo excepto cancelado.
e integer Registros por página (1-1000). Default 100.
p integer Número de página.

Respuestas

{
  "meta": {
    "unit": "cents", "timezone": "America/Mexico_City",
    "filters": {
      "productNameLike": ["EQUIPAJE VERTICAL","EQUIPAJE VIAJE","SET DE VIAJE","MALETA"],
      "skuRefId": [], "unitPriceMin": 50000, "unitPriceMax": null,
      "minQuantity": 1, "status": "completed"
    }
  },
  "rows": [
    { "client": 4134488, "pieces": 5, "value": 958795715, "lastDate": "2026-06-01",
      "matchedPatterns": ["EQUIPAJE VERTICAL","EQUIPAJE VIAJE","SET DE VIAJE"] }
  ],
  "total": 4624,
  "pagination": { "entries": 100, "currentPage": 1, "totalPages": 47, "isInitial": true, "isEnd": false }
}

Relacionados

Copied to clipboard