Restofy Docs
Alérgenos POST

Listar alérgenos

POST /api/allergens/list-allergens

Descripción

Lista paginada del catálogo de alérgenos del menú.

Detalles

Devuelve los alérgenos del catálogo con su nombre e ícono. Soporta búsqueda libre por nombre y ordenamiento. Incluye los alérgenos pausados para permitir activarlos.

Permisos requeridos

catalog.module

Request

Nombre Tipo Requerido Reglas
search string No
max:100

Paginación

defaultLimit 50
maxLimit 100
allowedSorts name
defaultSort name
defaultDir asc
withTotal true

Ejemplo de request

curl -X POST https://app.restofy.co/api/allergens/list-allergens \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>"

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-07-15T13:20:48Z
HTTP 200

Request

{
    "limit": 200
}

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "allergens": [
            {
                "allergenId": 15,
                "name": "Allergen cobertura 6a5788a6dbda3",
                "iconFontAwesome": "fa-solid fa-flask",
                "isActive": 0,
                "isAvailable": 1
            },
            {
                "allergenId": 13,
                "name": "Altramuces",
                "iconFontAwesome": "fa-solid fa-spa",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 9,
                "name": "Apio",
                "iconFontAwesome": "fa-solid fa-carrot",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 5,
                "name": "Cacahuetes",
                "iconFontAwesome": "fa-solid fa-seedling",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 2,
                "name": "Crustáceos",
                "iconFontAwesome": "fa-solid fa-shrimp",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 8,
                "name": "Frutos secos",
                "iconFontAwesome": "fa-solid fa-tree",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 1,
                "name": "Gluten",
                "iconFontAwesome": "fa-solid fa-wheat-awn",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 3,
                "name": "Huevos",
                "iconFontAwesome": "fa-solid fa-egg",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 7,
                "name": "Leche",
                "iconFontAwesome": "fa-solid fa-cow",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 14,
                "name": "Moluscos",
                "iconFontAwesome": "fa-solid fa-water",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 10,
                "name": "Mostaza",
                "iconFontAwesome": "fa-solid fa-jar",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 4,
                "name": "Pescado",
                "iconFontAwesome": "fa-solid fa-fish",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 11,
                "name": "Sésamo",
                "iconFontAwesome": "fa-solid fa-circle-dot",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 6,
                "name": "Soja",
                "iconFontAwesome": "fa-solid fa-leaf",
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "allergenId": 12,
                "name": "Sulfitos",
                "iconFontAwesome": "fa-solid fa-wine-bottle",
                "isActive": 1,
                "isAvailable": 1
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 100,
            "total": 15,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        }
    }
}