Menú

La carta QR del local: categorías, platos, modificadores, precios y productos agotados.

Los platos, las categorías y los valores de modificador pueden llevar tu external_id (tu SKU), único por local. Donde una ruta tenga {item} o {value}, puedes usar nuestro id o tu external_id. Los nombres y las descripciones son mapas por idioma ({"ro": "Zeamă", "en": "Chicken soup"}); añade ?lang=en a cualquier GET para obtener textos simples en un solo idioma, con el idioma principal de la carta como alternativa.

GET/v1/menu

Permiso: menu:read

La carta completa en forma de árbol: categorías, sus platos y los grupos y valores de modificadores de cada plato. Las categorías y los platos ocultos no se incluyen, salvo que añadas ?include_hidden=true.

curl

curl "https://loyaltyfy.io/api/v1/menu?lang=en" \
  -H "Authorization: Bearer sk_test_..."

Respuesta · 200

{
  "object": "menu",
  "url": "https://loyaltyfy.io/m/your-venue",
  "published": true,
  "currency": "MDL",
  "primary_language": "ro",
  "languages": ["ru", "en"],
  "categories": [
    {
      "object": "menu_category",
      "id": "0b8e4c1d-6f0e-4b8a-9a55-3c1d2e7f9a10",
      "external_id": "CAT-COFFEE",
      "parent_id": null,
      "name": "Coffee",
      "emoji": null,
      "visible": true,
      "items": [
        {
          "object": "menu_item",
          "id": "a48343bd-9f6e-424a-b003-fe790617f4d6",
          "external_id": "1001",
          "category_id": "0b8e4c1d-6f0e-4b8a-9a55-3c1d2e7f9a10",
          "name": "Flat white",
          "description": "Double ristretto, steamed milk",
          "price": 4500,
          "old_price": null,
          "currency": "MDL",
          "available": true,
          "visible": true,
          "photo_url": "https://...",
          "options": [
            {
              "object": "option_group",
              "id": "5c2f...",
              "kind": "addon",
              "name": "Milk",
              "min_select": 0,
              "max_select": 1,
              "values": [
                {
                  "object": "option_value",
                  "id": "9e41...",
                  "external_id": "MOD-OAT",
                  "name": "Oat milk",
                  "price_delta": 800,
                  "available": true,
                  "default": false
                }
              ]
            }
          ],
          "updated_at": "2026-10-06T09:12:44.120+00:00"
        }
      ]
    }
  ]
}

GET/v1/menu/items

Permiso: menu:read

Una lista plana de platos sin modificadores, hasta 1000, en el orden de la carta. Filtros: ?external_id= para un SKU, ?available=false para los productos agotados actuales, ?lang=.

GET/v1/menu/items/{item}

Permiso: menu:read

Un plato con sus modificadores.

POST/v1/menu/items

Permiso: menu:write

Añade un plato. Con un external_id, la llamada se puede repetir sin riesgo: si ya existe un plato con ese external_id, se devuelve con 200.

categorystring, obligatorio: Id de categoría o external_id de la categoría. Un valor desconocido crea una categoría con ese nombre.
nameobject, obligatorio: Nombre por idioma, al menos uno.
priceinteger, obligatorio: En unidades mínimas.
external_idstring: Tu SKU.
descriptionobject: Por idioma.
available, visibleboolean: Por defecto, true.

Parámetro	Tipo	Descripción
category	string, obligatorio	Id de categoría o `external_id` de la categoría. Un valor desconocido crea una categoría con ese nombre.
name	object, obligatorio	Nombre por idioma, al menos uno.
price	integer, obligatorio	En unidades mínimas.
external_id	string	Tu SKU.
description	object	Por idioma.
available, visible	boolean	Por defecto, true.

curl

curl https://loyaltyfy.io/api/v1/menu/items \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "category": "CAT-SOUPS",
    "external_id": "2040",
    "name": { "ro": "Zeamă", "ru": "Зама", "en": "Chicken soup" },
    "price": 6500
  }'

PATCH/v1/menu/items/{item}

Permiso: menu:write

Cambia price, old_price (se muestra tachado), available, visible, external_id, name o description. Envía menu.updated.

curl

# the kitchen ran out: hide the "+" button in the menu
curl -X PATCH https://loyaltyfy.io/api/v1/menu/items/2040 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "available": false }'

POST/v1/menu/items/bulk

Permiso: menu:write

Hasta 500 cambios en una llamada. Cada entrada identifica un plato con item (id o external_id) y define cualquiera de price, old_price, available, visible. Las entradas que no cambian nada vuelven en unchanged y las desconocidas, en not_found. Un solo evento menu.updated por lote.

curl

curl https://loyaltyfy.io/api/v1/menu/items/bulk \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "item": "1001", "price": 4800 },
      { "item": "2040", "available": false },
      { "item": "3017", "price": 9900, "old_price": 12000 }
    ]
  }'

Respuesta · 200

{
  "object": "menu_bulk_result",
  "updated": ["1001", "2040"],
  "unchanged": [],
  "not_found": ["3017"],
  "failed": []
}

PATCH/v1/menu/option_values/{value}

Permiso: menu:write

Cambia un valor de modificador: available, price_delta, external_id.

curl

curl -X PATCH https://loyaltyfy.io/api/v1/menu/option_values/MOD-OAT \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "available": false }'