W Restaurant API
integer · int32string | nullstring | nullstring | nullstring · uuidinteger · int32string · date-timeinteger · int32number · doublenumber · doublenumber · doublenumber · doublebooleanstring | nullstring | nullstring | nullinteger · int32string | nullbooleanstring | nullstring | nullstring | nullstring | nullstring | nullinteger · int32
Schemas
CloseShiftRequest
idTurnoestacionidEmpresaserieCloseShiftResponse
jobIdidTurnocierremigratedChequesefectivotarjetavalescreditoCreateClosedOrderRequest
turnDependentestacionserieidEmpresanoPersonasarray | null
idFormaDePagoCreateOrderRequest
turnDependentmesaidMeseroestacionserieidEmpresanoPersonasarray | null
CreatePrinterRequest
Cuerpo para registrar una nueva impresora en un punto de venta del usuario.
licenseKeyLicense key (16 caracteres) del punto de venta al que pertenece la impresora.
printerIpDirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").
widthMmAncho del papel en milímetros (típicamente 58 u 80).
displayNameNombre visible de la impresora (p. ej. "Cocina", "Barra").
sourceOrigen opcional de la impresora cuando se importa de un sistema externo.
sourceIdIdentificador de la impresora en el sistema de origen, si aplica.
EmpresaDto
idEmpresanombrerazonSocialdireccionsucursalrfccurptelefonogirocontactofaxemailfechaCompradistribuidornumeroFacturanumeroDeControlcontrasenaControlidHardwarelicenciaPrincipallicenciaMonederoElectronicolicenciaMonitorProduccionlicenciaSrMovillicenciaManttoVentaslicenciaPagoEnLinealicenciaHuellaDigitallicenciaBillarfranquiciawebciudadestadopaisciudadSucursalestadoSucursalpasswordEmpresaEmpresasResponse
workerIddispatchedAttotalResultsarray | null
GrupoDto
idGrupodescripcionclasificacionprioridadcolorcolorLetraprioridadImpresioncambiaColorCuentacolorCuentacolorLetraCuentasolicitaAutorizacionimagenMenuElectronicoextMenuporcentajePropinaimagenMenuidEtiquetaworkspaceIdalcoholserviceCodeGruposModificadorDto
idProductoidGruposModificadoresdescripcionprioridadforzarCapturamaximoModificadoresincluidosGruposQueryResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
ImpuestosDto
nombreImpuesto1impuesto1nombreImpuesto2impuesto2nombreImpuesto3impuesto3MeseroDto
idMeseroInternoidMeseronombrecontrasenatipofotografiavisibleidEmpresatipoAccesocapturaRestringidaMesasperfilmonitorMeseroColorFondomonitorMeseroColorLetraaccesoIndicadorMesasturnoAbiertocomisionautorizaProductosMenuQrworkspaceIdMeserosResponse
workerIddispatchedAttotalResultsarray | null
ModificadorDto
idProductoidModificadorprecionombreidGruposModificadoresModifiersPrint
idModifierId interno del modificador.
nameNombre del modificador impreso en el ticket.
pricePrecio del modificador. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.
OpenOrderDto
folioserieFolionumchequefechacierremesanoPersonasidMeseropagadocanceladoimpresoimpresionesdescuentorazonCanceladoordenfacturadoidTurnousuarioCancelocomentarioDescuentousuarioPagototalArticulossubtotalsubtotalSinImpuestostotaltotalConPropinaefectivotarjetavalesotrospropinatotalSinDescuentototalAlimentostotalBebidastotalOtrostotalDescuentostotalCortesiastotalCortesiaAlimentosnombreMeseroOpenOrdersResponse
workerIddispatchedAttotalResultsarray | null
OpenShiftRequest
estacionidEmpresaidMeserocajerofondofondoDolaresOpenShiftResponse
jobIdidTurnoaperturafondocajeroidMeserofondoDolaresOrderDetailDto
folioDetmovimientocomandacantidadidProductodescuentoprecioprecioSinImpuestoscomentariotiempomitadhoramodificadoridEstacionusuarioDescuentocomentarioDescuentoidTipoDescuentoidProductoCompuestoproductoCompuestoPrincipalprecioCatalogomarcaridMeseroProductoidCortesianumeroTarjetafolioProduccionnivelsistemaEnviopromoVolumenOrderDetailsQueryResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
OrderDtoWithItemsAndPayments
folioserieFolionumchequefechacierremesanoPersonasidMeseropagadocanceladoimpresoimpresionesdescuentorazonCanceladoordenfacturadoidTurnousuarioCancelocomentarioDescuentousuarioPagototalArticulossubtotalsubtotalSinImpuestostotaltotalConPropinaefectivotarjetavalesotrospropinatotalSinDescuentototalAlimentostotalBebidastotalOtrostotalDescuentostotalCortesiastotalCortesiaAlimentosarray | null
array | null
OrderPaymentMethodsDto
folioidFormaDePagodescripcionimportepropinatipoDeCambioOrdersResponse
workerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
PartialProductDto
idProductodescripcionProductoidGrupomovimientocantidaddescripcionGrupoclasificacionmodificadorproductoCompuestoPrincipalnombreCortoimagenvisibleMenuidProdServSatcomentarioprecioprecioSinImpuestosimpuesto1impuesto2impuesto3descuentobloqueadopermitirprodcompenmodifPaymentMethodDto
idFormaDePagodescripciontipotipoDeCambiosolicitaReferenciaprioridadBotoncuentaContableImportecuentaContableComisioncuentaContableIvaComisioncomisionvisibleaceptaPropinasubtipoprefijo1prefijo2codigoDePrefijoconsultacodigoDePrefijoacumredgeneraPuntosformatoImpresionidFPagoFiscalpagoEnLineatipoTarjetanoFacturablecomisionReporte1comisionReporte2tipoTarjetaBancariaidTipoDescuentoidFormaPagoSatserviceCodeleerBrazaletecargoHabitacionEgvisibleKioscoautocapturarsumaTotalequivalenciabloqueaImportePaymentMethodsResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
PrintGroupRequest
printerIdId de la impresora destino (obtenido de GET /print/{licenseKey}/printers).
jobTypeQué se imprime. Envíe "receipt" para el recibo del cliente o "order" para la comanda de preparación (cocina/barra).
Enum values:
receipt
order
titleTítulo del ticket — se imprime como la línea de destino (p. ej. "COCINA").
array | null · required
Artículos a imprimir en este ticket.
qrDataQR del ticket si se requiere. Reservado para la futura plantilla de recibo.
PrintGroupResult
printerIdId de la impresora a la que apuntó este grupo.
jobIdId de auditoría del trabajo de impresión creado, si se creó alguno.
statusEstado del resultado: "Completed" o "Failed".
errorDetalle de la falla cuando el grupo no se imprimió.
PrintLineRequest
idProductId interno del producto.
nameNombre del producto impreso en el ticket.
quantityCantidad solicitada.
array | null · required
Modificadores del producto, impresos como líneas "+ {nombre}".
pricePrecio unitario. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.
notesNota libre para esta línea, impresa como "nota: {notas}".
PrintOrderRequest
Solicitud de impresión enviada desde el kiosko. Cada elemento de "groups" apunta a una impresora
por su id y se renderiza y despacha de forma independiente. Las reimpresiones marcan "isReprint"
y reenvían los mismos datos de líneas.
orderFolioFolio de la orden mostrado en el ticket (p. ej. "169").
isReprintIndica si el ticket ya había sido impreso anteriormente.
array | null · required
Un grupo de impresión por cada impresora destino.
priceTotal de la orden. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.
paymentMethodMétodo de pago. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.
businessNameNombre del negocio impreso como encabezado del ticket.
businessSubtitleSegunda línea opcional del encabezado, debajo del nombre del negocio (p. ej. marca o sucursal).
PrintOrderResponse
Resultado de despachar una orden — una entrada por grupo de impresión, con resultados independientes.
orderRefarray | null
PrinterAssignmentDto
Impresora a la que el kiosko puede apuntar por su id en una solicitud de impresión.
idprinterIpdisplayNamewidthMmsourcePrinterDto
Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.
idworkerIdlicenseKeyprinterIpdisplayNamewidthMmsourcesourceIdcreatedAtupdatedAtProblemDetails
typetitlestatusdetailinstanceNo data returned
ProductDto
idProductodescripcionProductoidGrupodescripcionGrupoclasificacionnombreCortoimagenvisibleMenuidProdServSatprecioprecioSinImpuestosimpuesto1impuesto2impuesto3bloqueadopermitirprodcompenmodifarray | null
array | null
array | null
ProductsQueryResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
SearchOrdersRequest
idTurnossearchpagepageSizefacturadofechaStartfechaEndcierreStartcierreEndStationDto
idEstaciondescripcionserieipimpresoraChequesimpresoraNotascajaComanderodirectorioRespaldorutaTemporalStationsQueryResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
TurnoDto
idTurnoInternoidTurnofondoaperturacierreidEstacioncajeroefectivotarjetavalescreditoprocesadoWebidEmpresaenviadoACentralfechaEnviadousuarioEnvioofflineenviadoAfcorteEnviadoeliminarTemporalesEnCierreidMeserofondoDolaresprocesadoTurnosQueryResponse
jobIdworkerIddispatchedAtpagepageSizetotalResultstotalPageshasNextPagearray | null
UpdatePrinterRequest
Cuerpo para actualizar la configuración de una impresora existente.
printerIpDirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").
widthMmAncho del papel en milímetros (típicamente 58 u 80).
displayNameNombre visible de la impresora (p. ej. "Cocina", "Barra").
sourceOrigen opcional de la impresora cuando se importa de un sistema externo.
sourceIdIdentificador de la impresora en el sistema de origen, si aplica.
UpdateProductRequest
idEmpresaId de la empresa dueña del producto. Debe corresponder a una empresa existente; de lo contrario la solicitud falla.
descripcionProductoidGruponombreCortovisibleMenuprecioimpuesto1impuesto2impuesto3bloqueadopermitirprodcompenmodif