Endpoints
Listar productos
Devuelve el catálogo de productos de una sucursal, con paginación y filtros opcionales por grupo, clasificación y visibilidad en menú.
path Parameters
licenseKeyquery Parameters
pagepageSizesearchidGrupoclasificacionvisibleMenuHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar productos › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageActualizar un producto
Actualiza los datos principales de un producto existente: descripción, grupo, nombre corto, precio, impuestos, bloqueo, visibilidad en menú electrónico y si permite producto compuesto en modificador.
Es una actualización de reemplazo completo: se deben enviar todos los campos en cada solicitud (los valores omitidos no se conservan). El producto debe existir previamente — este endpoint no crea productos nuevos.
Además del cambio en sí, la operación aplica automáticamente estos efectos:
- Si el precio cambió, se registra en el historial de cambios de precio.
- Si el producto también está registrado como modificador de sí mismo, su precio se sincroniza.
- Se agrega una entrada de auditoría en la bitácora del sistema.
- Se marca el producto para sincronización con otros sistemas conectados.
No modifica grupos de modificadores, paquetes, costos, comentarios, asignaciones de estación/almacén ni configuración de monedero del producto — esa configuración, si existe, se conserva sin cambios.
path Parameters
licenseKeyidProductoHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Idempotency-KeyActualizar un producto › Request Body
idEmpresaId de la empresa dueña del producto. Debe corresponder a una empresa existente; de lo contrario la solicitud falla.
descripcionProductoidGruponombreCortovisibleMenuprecioimpuesto1impuesto2impuesto3bloqueadopermitirprodcompenmodifActualizar un producto › Responses
OK
jobIdidProductoListar estaciones
Devuelve las estaciones (mesas, áreas, terminales) configuradas en una sucursal, con paginación y búsqueda opcional.
path Parameters
licenseKeyquery Parameters
pagepageSizesearchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar estaciones › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar grupos
Devuelve los grupos (categorías de productos) configurados en una sucursal, con paginación y búsqueda opcional por id, descripción o clasificación.
path Parameters
licenseKeyquery Parameters
pagepageSizesearchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar grupos › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar turnos
Devuelve los turnos (cortes de caja) registrados en una sucursal, con paginación y búsqueda opcional. Admite filtros de fecha (inclusivos, formato ISO 8601) sobre la apertura (aperturaStart/aperturaEnd) y sobre el cierre (cierreStart/cierreEnd); cada límite es opcional y pueden combinarse. Nota: los turnos abiertos no tienen fecha de cierre, por lo que cualquier filtro sobre cierre los excluye.
path Parameters
licenseKeyquery Parameters
pagepageSizesearchaperturaStartaperturaEndcierreStartcierreEndHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar turnos › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar órdenes temporales
Devuelve las órdenes del turno actual por punto de Venta de una sucursal, con filtro opcional por folio, número de cheque o total. Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación.
path Parameters
licenseKeyquery Parameters
searchpagepageSizefacturadoHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar órdenes temporales › Responses
OK
workerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageCrear una orden (nueva cuenta)
Crea una nueva cuenta y retorna el id.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Idempotency-KeyCrear una orden (nueva cuenta) › Request Body
turnDependentmesaidMeseroestacionserieidEmpresanoPersonasCrear una orden (nueva cuenta) › Responses
Created
jobIdfolioCrear una orden cerrada (venta rápida)
Crea una nueva venta cerrada con su pago y retorna el folio generado.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Idempotency-KeyCrear una orden cerrada (venta rápida) › Request Body
turnDependentestacionserieidEmpresanoPersonasidFormaDePagoCrear una orden cerrada (venta rápida) › Responses
Created
jobIdfolionumchequeCerrar turno
Cierra un turno abierto: consolida las cuentas pagadas/canceladas en las tablas permanentes, libera mesas y marca el turno como cerrado. Requiere el idTurno exacto para evitar cerrar el turno equivocado cuando hay varios abiertos.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Idempotency-KeyCerrar turno › Request Body
idTurnoestacionidEmpresaserieCerrar turno › Responses
OK
jobIdidTurnocierremigratedChequesefectivotarjetavalescreditoAbrir turno
Abre un nuevo turno para la estación y empresa indicadas. Devuelve el idTurno asignado junto con los datos de apertura (fondo, cajero, mesero, fondo en dólares). Falla con un error si ya existe un turno abierto para esa estación/empresa; ciérralo primero con turnos_cierre.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Idempotency-KeyAbrir turno › Request Body
estacionidEmpresaidMeserocajerofondofondoDolaresAbrir turno › Responses
OK
jobIdidTurnoaperturafondocajeroidMeserofondoDolaresListar meseros
Devuelve el listado de meseros configurados en una sucursal.
path Parameters
licenseKeyquery Parameters
searchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar meseros › Responses
OK
workerIddispatchedAttotalResultsListar empresas
Devuelve las empresas registradas en el Punto de Venta de una sucursal.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar empresas › Responses
OK
workerIddispatchedAttotalResultsListar órdenes abiertas del turno actual
Devuelve todas las cuentas activas (sin cancelar) del turno operativo actual (6:00 AM – 5:59:59 AM del día siguiente).
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar órdenes abiertas del turno actual › Responses
OK
workerIddispatchedAttotalResultsListar detalles de órdenes temporales
Devuelve las líneas de productos temporales de una sucursal, con paginación y filtros opcionales por folio de orden o búsqueda por producto.
path Parameters
licenseKeyquery Parameters
pagepageSizefoliosearchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar detalles de órdenes temporales › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar órdenes cerradas
Devuelve las órdenes cerradas/históricas del Punto de Venta de una sucursal, con filtro opcional por folio, número de cheque o total. Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación. Admite filtros de fecha (inclusivos, formato ISO 8601): fechaStart/fechaEnd sobre la fecha de apertura de la orden y cierreStart/cierreEnd sobre su fecha de cierre. Además, turnoAperturaStart/turnoAperturaEnd filtran por turno: devuelven las órdenes de TODOS los turnos abiertos dentro de ese rango de fechas, sin necesidad de enviar la lista de ids. Para filtrar por una lista explícita de ids de turno (potencialmente grande), usa POST /ordenes/buscar/{licenseKey}.
path Parameters
licenseKeyquery Parameters
searchpagepageSizefacturadofechaStartfechaEndcierreStartcierreEndturnoAperturaStartturnoAperturaEndHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar órdenes cerradas › Responses
OK
workerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageBuscar órdenes cerradas por lista de turnos
Devuelve las órdenes cerradas/históricas cuyos ids de turno estén en la lista idTurnos enviada en el cuerpo (hasta 10,000 ids), con los mismos filtros opcionales de GET /ordenes/{licenseKey} (search, facturado, fechaStart/fechaEnd, cierreStart/cierreEnd) y paginación. Usa este endpoint cuando necesites filtrar por una lista explícita de turnos demasiado grande para la URL de un GET (~500 ids); si los turnos que te interesan corresponden a un rango de fechas, es más simple usar GET /ordenes/{licenseKey} con turnoAperturaStart/turnoAperturaEnd.
path Parameters
licenseKeyHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Buscar órdenes cerradas por lista de turnos › Request Body
idTurnossearchpagepageSizefacturadofechaStartfechaEndcierreStartcierreEndBuscar órdenes cerradas por lista de turnos › Responses
OK
workerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar detalles de órdenes cerradas
Devuelve las líneas de productos de órdenes cerradas/históricas de una sucursal, con paginación y filtros opcionales por folio de orden o búsqueda por producto.
path Parameters
licenseKeyquery Parameters
pagepageSizefoliosearchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar detalles de órdenes cerradas › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar órdenes del día operativo
Devuelve todas las órdenes del día operativo actual (abiertas y cerradas), juntando las órdenes según los turnos que iniciaron y cerraron dentro de la ventana. Por defecto la ventana es 06:00–05:59:59 del día siguiente; el inicio es configurable vía dayStartHour. Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación.
path Parameters
licenseKeyquery Parameters
searchpagepageSizedayStartHourfacturadoHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar órdenes del día operativo › Responses
OK
workerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageListar todas las formas de pago en una sucursal
Retorna todas las formas de pago disponibles en una sucursal específica.
path Parameters
licenseKeyquery Parameters
pagepageSizesearchHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Listar todas las formas de pago en una sucursal › Responses
OK
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPageDescargar el XML de una factura
Descarga el contenido XML (CFDI) de la factura asociada a un número de cheque, dentro de una empresa del Punto de Venta.
path Parameters
licenseKeynumChequequery Parameters
idEmpresaHeaders
X-Api-KeyAPI key secreta de tu cuenta. Se envía en cada solicitud.
Descargar el XML de una factura › Responses
OK