Obtener menú
POST /api/menus/get-menu
Descripción
Datos completos de un menú del restaurante.
Detalles
Devuelve toda la información base del menú, incluyendo su estado activo y de disponibilidad. Falla si el menú no existe o fue eliminado.
Permisos requeridos
catalog.module
Request
| Nombre | Tipo | Requerido | Reglas |
|---|---|---|---|
| menuId | int | Sí |
min_value:1
|
Respuesta
Campos que devuelve dentro de data. Nada fuera de esta lista sale en la respuesta.
| Campo | Tipo | Descripción |
|---|---|---|
| menu | object | Datos del menú |
| menu.menuId | int | Identificador del menú |
| menu.name | string | Nombre del menú |
| menu.description | string Admite vacío | Descripción del menú |
| menu.isActive | bool | Si el menú está activo |
| menu.schedule | object Admite vacío | Horario en que se muestra el menú; vacío si se muestra siempre |
| menu.schedule.dateStart | string Admite vacío | Primer día en que rige el horario (AAAA-MM-DD); vacío si no tiene inicio |
| menu.schedule.dateEnd | string Admite vacío | Último día en que rige el horario (AAAA-MM-DD); vacío si no tiene fin |
| menu.schedule.periods | array | Turnos por día de la semana; varios turnos el mismo día forman una jornada partida |
| menu.schedule.periods[].dayOfWeek | int | Día de la semana: 1 lunes a 7 domingo |
| menu.schedule.periods[].isAllDay | bool | Si el turno cubre el día completo |
| menu.schedule.periods[].timeStart | string Admite vacío | Hora de inicio (HH:MM:SS); vacío si cubre el día completo |
| menu.schedule.periods[].timeEnd | string Admite vacío | Hora de fin (HH:MM:SS); menor que el inicio si cruza la medianoche |
| menu.schedule.exceptions | array | Fechas que se salen de los turnos normales, como festivos o vacaciones |
| menu.schedule.exceptions[].name | string | Motivo de la excepción |
| menu.schedule.exceptions[].dateStart | string | Primer día de la excepción (AAAA-MM-DD) |
| menu.schedule.exceptions[].dateEnd | string | Último día de la excepción (AAAA-MM-DD) |
| menu.schedule.exceptions[].isClosed | bool | Si en esas fechas no aplica; si no, aplica con el horario especial |
| menu.schedule.exceptions[].timeStart | string Admite vacío | Hora de inicio del horario especial |
| menu.schedule.exceptions[].timeEnd | string Admite vacío | Hora de fin del horario especial |
Ejemplo de request
curl -X POST https://restofy.pro/api/menus/get-menu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <accessToken>" \
-d '{
"menuId": 1
}'
Los valores son demo: reemplázalos por datos reales del negocio.