Saltar al contenido
API v1 · https://bentho.org/api
GET/api/mod/productos/{espacio}/catalog/search

Busca en el catálogo

Encuentra variantes por lo que escribe una persona: «café la loma de medio kilo» encuentra «Café molido La Loma 500 g». Busca en el nombre, el SKU y, en consultas cortas, la descripción.

  • PERMISOlee (vale cualquier clave)
  • CRÉDITOSno gasta
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Productos.
qstring, querySÍLo que se busca, en lenguaje natural.
only_activebool, querynoSolo productos activos y variantes activas. Por defecto true.
limitint, querynoCuántos resultados como mucho. Por defecto 20.

RESPUESTA 200

Una fila por variante, la que mejor encaja primero.

CAMPOTIPOQUÉ ES
results[].product_idstringEl producto.
results[].variant_idstringLa variante.
results[].sku · nombrestringEl SKU y el nombre del producto.
results[].estadostringEl estado del producto.
results[].option_valuesobjectLos valores de opción de la variante.
results[].via_descripciontrueSolo si entró por la descripción y no por el nombre o el SKU.

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Productosmódulo no habilitado para este espacio.
422Falta q (detail es una lista)—

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • No distingue tildes ni mayúsculas, entiende plurales («jabones» encuentra «Jabón») y unidades («1 litro» encuentra «1000ml», «medio kilo» no: escribe «500 g»).
  • Las palabras que no aparecen en ningún producto no tumban la búsqueda: se ignoran. Si nada encaja, la lista viene vacía.
  • Para el precio de lo encontrado, cotiza sus variant_id.