Banners

Listar los banners

GET /api/v1/ecommerce/banners

No pide token. No recibe parámetros. Devuelve los banners activos, en el orden que eligió la empresa.

curl https://<dominio-de-la-empresa>/api/v1/ecommerce/banners \
  -H "Accept: application/json"

Respuesta

{
  "data": [
    {
      "id": 4,
      "description": "Nueva temporada de ropa",
      "image_desktop": "https://miempresa.ejemplo.com/storage/uploads/logos/banner-temporada.png",
      "image_movil": "https://miempresa.ejemplo.com/storage/uploads/logos/banner-temporada-movil.png",
      "link_type": "category",
      "link_mode": "_self",
      "link_url": null,
      "link_value": "ropa",
      "bg_color": "#7c3aed"
    }
  ],
  "success": true,
  "message": "Listado de Banners mostrados de forma correcta."
}

Campo	Qué es
description	Texto del banner, o null. Sirve como texto alternativo de la imagen
image_desktop	Imagen para pantallas grandes
image_movil	Imagen para móvil
link_type	A qué lleva el banner. Ver la tabla de abajo
link_mode	Cómo se abre el enlace: _self (en la misma pestaña) o _blank (en otra). null si el banner no enlaza a nada
link_url	Dirección de destino, solo cuando link_type es url. Si no, null
link_value	El destino según link_type: el slug de una categoría o el id de un producto
bg_color	Color de fondo del banner, en #RRGGBB, o null

Qué significa cada link_type:

link_type	Adónde lleva	Qué usar
category	A una categoría	link_value es su slug: abre la categoría o filtra productos con ella
product	A un producto	link_value es su id: abre su ficha
url	A una dirección cualquiera	Abre link_url
none	A ninguna parte	El banner es solo imagen

Hoy el formulario de banners del ERP solo ofrece enlazar a una categoría, así que lo normal es recibir category. Los otros tres valores son los que admite el ERP al guardar, y pueden llegar en banners creados antes.

Cómo repartir los banners en la portada (en columnas o a ancho completo) lo dice store.banner_style en los ajustes.

Si no hay banners activos, la lista llega vacía.

Si algo sale mal

HTTP	code	Cuándo	Qué hacer
404	STORE_NOT_FOUND	La tienda no está publicada	La empresa debe publicarla desde el ERP
503	STORE_PAUSED	La tienda está pausada	Reintenta más tarde (Retry-After)
429	RATE_LIMITED	Se superó el límite	Espera lo que indica Retry-After
500	INTERNAL_ERROR	Fallo del servidor	Reporta la reference