Impresoras

Listar mis impresoras

GET

https://api.wrestaurantapi.com

/api/v1/me/printers

Devuelve las impresoras del usuario. Filtra por licenseKey para limitar a un solo punto de venta.

Listar mis impresoras › query Parameters

licenseKey

string

Listar mis impresoras › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Listar mis impresoras › Responses

PrinterDto[]

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

Registrar una impresora

POST

https://api.wrestaurantapi.com

/api/v1/me/printers

Registra una nueva impresora en uno de los puntos de venta del usuario.

Registrar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Registrar una impresora › Request Body

Cuerpo para registrar una nueva impresora en un punto de venta del usuario.

CreatePrinterRequest

licenseKey

string | null · required

License key (16 caracteres) del punto de venta al que pertenece la impresora.

printerIp

string | null · required

Dirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").

widthMm

integer · int32 · required

Ancho del papel en milímetros (típicamente 58 u 80).

displayName

string | null

Nombre visible de la impresora (p. ej. "Cocina", "Barra").

source

string | null

Origen opcional de la impresora cuando se importa de un sistema externo.

sourceId

string | null

Identificador de la impresora en el sistema de origen, si aplica.

Registrar una impresora › Responses

Created

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

POST/api/v1/me/printers

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.createPrinter({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "licenseKey": "DS5D2368HCME4O9X",
  "printerIp": "192.168.1.50",
  "displayName": "Cocina",
  "widthMm": 80,
  "source": "windows",
  "sourceId": "POS-01"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workerId": "00000000-0000-0000-0000-000000000000",
  "licenseKey": "licenseKey",
  "printerIp": "printerIp",
  "displayName": "displayName",
  "widthMm": 0,
  "source": "source",
  "sourceId": "sourceId",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Obtener una impresora

GET

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Devuelve una impresora del usuario por su id.

Obtener una impresora › path Parameters

id

string · uuid · required

Obtener una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Obtener una impresora › Responses

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

Actualizar una impresora

PUT

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Actualiza la configuración de una impresora existente del usuario.

Actualizar una impresora › path Parameters

id

string · uuid · required

Actualizar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Actualizar una impresora › Request Body

Cuerpo para actualizar la configuración de una impresora existente.

UpdatePrinterRequest

printerIp

string | null · required

Dirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").

widthMm

integer · int32 · required

Ancho del papel en milímetros (típicamente 58 u 80).

displayName

string | null

Nombre visible de la impresora (p. ej. "Cocina", "Barra").

source

string | null

Origen opcional de la impresora cuando se importa de un sistema externo.

sourceId

string | null

Identificador de la impresora en el sistema de origen, si aplica.

Actualizar una impresora › Responses

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

PUT/api/v1/me/printers/{id}

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.updatePrinter({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "printerIp": "192.168.1.51",
  "displayName": "Cocina (caliente)",
  "widthMm": 80,
  "source": "windows",
  "sourceId": "POS-01"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workerId": "00000000-0000-0000-0000-000000000000",
  "licenseKey": "licenseKey",
  "printerIp": "printerIp",
  "displayName": "displayName",
  "widthMm": 0,
  "source": "source",
  "sourceId": "sourceId",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Eliminar una impresora

DELETE

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Elimina de forma permanente una impresora del usuario.

Eliminar una impresora › path Parameters

id

string · uuid · required

Eliminar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Eliminar una impresora › Responses

No Content

No data returned

Imprimir una orden

POST

https://api.wrestaurantapi.com

/api/v1/print/{licenseKey}

Renderiza tickets ESC/POS y los envía a las impresoras de la sucursal. Cada grupo apunta a una impresora por su id (printerId). Marca isReprint=true para reimpresiones.

Imprimir una orden › path Parameters

licenseKey

string · required

Imprimir una orden › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Imprimir una orden › Request Body

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.

PrintOrderRequest

orderFolio

string | null · required

Folio de la orden mostrado en el ticket (p. ej. "169").

isReprint

boolean · required

Indica si el ticket ya había sido impreso anteriormente.

array | null · required

Un grupo de impresión por cada impresora destino.

price

number | null · double

Total de la orden. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.

paymentMethod

string | null

Método de pago. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.

businessName

string | null

Nombre del negocio impreso como encabezado del ticket.

businessSubtitle

string | null

Segunda línea opcional del encabezado, debajo del nombre del negocio (p. ej. marca o sucursal).

Imprimir una orden › Responses

Resultado de despachar una orden — una entrada por grupo de impresión, con resultados independientes.

PrintOrderResponse

orderRef

string | null

array | null

POST/api/v1/print/{licenseKey}

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.printOrder({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "orderFolio": "169",
  "isReprint": false,
  "price": 128.5,
  "paymentMethod": "CARD",
  "businessName": "Mi Restaurante",
  "businessSubtitle": "Sucursal Centro",
  "groups": [
    {
      "printerId": "00000000-b12a-405f-905d-dbf424c20000",
      "jobType": "order",
      "title": "COCINA",
      "items": [
        {
          "idProduct": "01052",
          "name": "Hamburguesa doble carne",
          "quantity": 2,
          "price": 89,
          "modifiers": [
            {
              "idModifier": "50110",
              "name": "Sin cebolla",
              "price": 0
            }
          ],
          "notes": "Sin pepinillos"
        }
      ],
      "qrData": null
    }
  ]
}

json

Example Responses

{
  "orderRef": "orderRef",
  "results": [
    {
      "printerId": "printerId",
      "jobId": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "error": "error"
    }
  ]
}

json

application/json

Listar impresoras de la sucursal

GET

https://api.wrestaurantapi.com

/api/v1/print/{licenseKey}/printers

Devuelve las impresoras configuradas para la sucursal (id, IP, nombre, ancho), para que el kiosko elija el printerId al imprimir.

Listar impresoras de la sucursal › path Parameters

licenseKey

string · required

Listar impresoras de la sucursal › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Listar impresoras de la sucursal › Responses

PrinterAssignmentsResponse

workerId

string · uuid

array | null

Endpoints

W Restaurant API

Impresoras

Listar mis impresoras

GET

https://api.wrestaurantapi.com

/api/v1/me/printers

Devuelve las impresoras del usuario. Filtra por licenseKey para limitar a un solo punto de venta.

Listar mis impresoras › query Parameters

licenseKey

string

Listar mis impresoras › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Listar mis impresoras › Responses

PrinterDto[]

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

Registrar una impresora

POST

https://api.wrestaurantapi.com

/api/v1/me/printers

Registra una nueva impresora en uno de los puntos de venta del usuario.

Registrar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Registrar una impresora › Request Body

Cuerpo para registrar una nueva impresora en un punto de venta del usuario.

CreatePrinterRequest

licenseKey

string | null · required

License key (16 caracteres) del punto de venta al que pertenece la impresora.

printerIp

string | null · required

Dirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").

widthMm

integer · int32 · required

Ancho del papel en milímetros (típicamente 58 u 80).

displayName

string | null

Nombre visible de la impresora (p. ej. "Cocina", "Barra").

source

string | null

Origen opcional de la impresora cuando se importa de un sistema externo.

sourceId

string | null

Identificador de la impresora en el sistema de origen, si aplica.

Registrar una impresora › Responses

Created

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

POST/api/v1/me/printers

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.createPrinter({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "licenseKey": "DS5D2368HCME4O9X",
  "printerIp": "192.168.1.50",
  "displayName": "Cocina",
  "widthMm": 80,
  "source": "windows",
  "sourceId": "POS-01"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workerId": "00000000-0000-0000-0000-000000000000",
  "licenseKey": "licenseKey",
  "printerIp": "printerIp",
  "displayName": "displayName",
  "widthMm": 0,
  "source": "source",
  "sourceId": "sourceId",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Obtener una impresora

GET

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Devuelve una impresora del usuario por su id.

Obtener una impresora › path Parameters

id

string · uuid · required

Obtener una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Obtener una impresora › Responses

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

Actualizar una impresora

PUT

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Actualiza la configuración de una impresora existente del usuario.

Actualizar una impresora › path Parameters

id

string · uuid · required

Actualizar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Actualizar una impresora › Request Body

Cuerpo para actualizar la configuración de una impresora existente.

UpdatePrinterRequest

printerIp

string | null · required

Dirección IP de la impresora en la red local de la sucursal (p. ej. "192.168.1.50").

widthMm

integer · int32 · required

Ancho del papel en milímetros (típicamente 58 u 80).

displayName

string | null

Nombre visible de la impresora (p. ej. "Cocina", "Barra").

source

string | null

Origen opcional de la impresora cuando se importa de un sistema externo.

sourceId

string | null

Identificador de la impresora en el sistema de origen, si aplica.

Actualizar una impresora › Responses

Impresora que pertenece a un cliente, vinculada a uno de sus puntos de venta.

PrinterDto

id

string · uuid

workerId

string · uuid

licenseKey

string | null

printerIp

string | null

displayName

string | null

widthMm

integer · int32

source

string | null

sourceId

string | null

createdAt

string · date-time

updatedAt

string · date-time

PUT/api/v1/me/printers/{id}

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.updatePrinter({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "printerIp": "192.168.1.51",
  "displayName": "Cocina (caliente)",
  "widthMm": 80,
  "source": "windows",
  "sourceId": "POS-01"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workerId": "00000000-0000-0000-0000-000000000000",
  "licenseKey": "licenseKey",
  "printerIp": "printerIp",
  "displayName": "displayName",
  "widthMm": 0,
  "source": "source",
  "sourceId": "sourceId",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Eliminar una impresora

DELETE

https://api.wrestaurantapi.com

/api/v1/me/printers/{id}

Elimina de forma permanente una impresora del usuario.

Eliminar una impresora › path Parameters

id

string · uuid · required

Eliminar una impresora › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Eliminar una impresora › Responses

No Content

No data returned

Imprimir una orden

POST

https://api.wrestaurantapi.com

/api/v1/print/{licenseKey}

Renderiza tickets ESC/POS y los envía a las impresoras de la sucursal. Cada grupo apunta a una impresora por su id (printerId). Marca isReprint=true para reimpresiones.

Imprimir una orden › path Parameters

licenseKey

string · required

Imprimir una orden › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Imprimir una orden › Request Body

PrintOrderRequest

orderFolio

string | null · required

Folio de la orden mostrado en el ticket (p. ej. "169").

isReprint

boolean · required

Indica si el ticket ya había sido impreso anteriormente.

array | null · required

Un grupo de impresión por cada impresora destino.

price

number | null · double

Total de la orden. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.

paymentMethod

string | null

Método de pago. Se guarda para futuras plantillas de recibo; no se imprime en la comanda.

businessName

string | null

Nombre del negocio impreso como encabezado del ticket.

businessSubtitle

string | null

Segunda línea opcional del encabezado, debajo del nombre del negocio (p. ej. marca o sucursal).

Imprimir una orden › Responses

Resultado de despachar una orden — una entrada por grupo de impresión, con resultados independientes.

PrintOrderResponse

orderRef

string | null

array | null

POST/api/v1/print/{licenseKey}

import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: undefined!, // wrst_live_...
});

const response = await client.endpoints.printOrder({
  licenseKey: "DS5D2368HCME4O9X",
});
console.log(response);

Example Request Body

{
  "orderFolio": "169",
  "isReprint": false,
  "price": 128.5,
  "paymentMethod": "CARD",
  "businessName": "Mi Restaurante",
  "businessSubtitle": "Sucursal Centro",
  "groups": [
    {
      "printerId": "00000000-b12a-405f-905d-dbf424c20000",
      "jobType": "order",
      "title": "COCINA",
      "items": [
        {
          "idProduct": "01052",
          "name": "Hamburguesa doble carne",
          "quantity": 2,
          "price": 89,
          "modifiers": [
            {
              "idModifier": "50110",
              "name": "Sin cebolla",
              "price": 0
            }
          ],
          "notes": "Sin pepinillos"
        }
      ],
      "qrData": null
    }
  ]
}

json

Example Responses

{
  "orderRef": "orderRef",
  "results": [
    {
      "printerId": "printerId",
      "jobId": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "error": "error"
    }
  ]
}

json

application/json

Listar impresoras de la sucursal

GET

https://api.wrestaurantapi.com

/api/v1/print/{licenseKey}/printers

Devuelve las impresoras configuradas para la sucursal (id, IP, nombre, ancho), para que el kiosko elija el printerId al imprimir.

Listar impresoras de la sucursal › path Parameters

licenseKey

string · required

Listar impresoras de la sucursal › Headers

X-Api-Key

string · required

API key secreta de tu cuenta. Se envía en cada solicitud.

Listar impresoras de la sucursal › Responses

PrinterAssignmentsResponse

workerId

string · uuid

array | null

Endpoints