Referencia de la API · v9
Documentación de la API
Todos los endpoints exponen POST /api/{modulo}/{accion} y devuelven JSON.
Primeros pasos
Lo esencial para hacer tu primera llamada a la API.
Explora por módulo
Cada módulo agrupa los endpoints de un mismo recurso.
Acceso y sesiones
/api/auth/*
1
Alérgenos del menú
/api/allergens/*
6
Anticipos de clientes
/api/customer-advances/*
8
Anulación de órdenes
/api/pos-cancellation/*
4
Atributos de comensales
/api/guest-attributes/*
7
Bodegas de almacenamiento
/api/storage-locations/*
5
Buzón de reportes
/api/feedback/*
1
Cajas registradoras
/api/cash-registers/*
5
Canales de entrega
/api/fulfillments/*
7
Canales de venta
/api/channels/*
1
Categorías de insumo
/api/inventory-item-categories/*
4
Categorías de producto
/api/product-categories/*
6
Catálogo del punto de venta
/api/pos-catalog/*
6
Cierre de caja
/api/cash-closures/*
13
Cobro de órdenes
/api/pos-payment/*
12
Compras de insumos
/api/purchases/*
3
Configuración del negocio
/api/settings/*
2
Contactos del negocio
/api/parties/*
15
Control de inventario
/api/inventory/*
12
Cuentas bancarias
/api/bank-accounts/*
5
Cuentas de caja fuerte
/api/safe-accounts/*
5
Denominaciones de efectivo
/api/currency-denominations/*
7
Descuentos y cortesías
/api/pos-discounts/*
5
Disponibilidad por canal
/api/fulfillment-config/*
4
Entidades legales
/api/legal-entities/*
8
Estaciones de cocina
/api/kitchen-stations/*
7
Facturación de ventas
/api/invoicing/*
16
Gastos del negocio
/api/expenses/*
10
Gift cards
/api/gift-cards/*
7
Grupos de comensales
/api/guest-groups/*
7
Grupos de modificadores
/api/modifier-groups/*
7
Habitaciones del negocio
/api/rooms/*
7
Horarios del negocio
/api/schedules/*
5
Impresoras del negocio
/api/printers/*
8
Insumos de inventario
/api/inventory-items/*
7
Mensajes de clientes
/api/comments/*
4
Menú digital
/api/digital-menu/*
28
Menús del restaurante
/api/menus/*
14
Mesas del salón
/api/tables/*
8
Modificadores de productos
/api/modifiers/*
10
Motivos de anulación
/api/cancellation-reasons/*
6
Motivos de descuento
/api/discount-reasons/*
6
Municipios disponibles
/api/municipalities/*
1
Métodos de pago
/api/payment-methods/*
8
Ocasiones de comensales
/api/guest-occasions/*
7
Operación de caja
/api/cashier/*
12
Pagos a domiciliarios
/api/courier-settlements/*
2
Pagos en línea
/api/payments/*
8
Pantalla de cocina
/api/kds/*
4
Perfil del negocio
/api/business-profile/*
9
Precios de producto
/api/product-prices/*
5
Productos del menú
/api/products/*
33
Proveedores de facturación
/api/electronic-providers/*
9
Recetas de producción
/api/production/*
2
Recetas de productos
/api/recipes/*
7
Reglas de impuestos
/api/tax-rules/*
5
Reportes del negocio
/api/reports/*
5
Reservas de clientes
/api/reservations/*
11
Saldos a favor
/api/favor-balances/*
7
Salón y mesas
/api/pos-zone/*
21
Secuencias de facturación
/api/invoice-sequences/*
8
Sub-recetas reutilizables
/api/sub-recipes/*
7
Tiempos de servicio
/api/courses/*
7
Toma de pedidos
/api/pos-order/*
53
Trabajos de impresión
/api/print-jobs/*
7
Tus restaurantes
/api/tenants/*
1
Unidades de medida
/api/units/*
8
Zonas de entrega
/api/delivery-zones/*
6
Zonas del salón
/api/zones/*
6
Áreas de reserva
/api/reservation-areas/*
7