Printers

Create a custom print job with Star Micronics Markdown.

This endpoint allows sending raw Star Micronics Markdown content directly to a printer. Use this for custom receipt formats, promotional prints, or testing.

Star Micronics Markdown Reference:

• [C] - Center alignment
• [L] - Left alignment
• [R] - Right alignment
• [D:1] to [D:4] - Font size (1 is normal, 4 is largest)
• [CUT] - Cut paper
• --- - Horizontal line

Example:

Code
[C][D:2]Welcome to Karma!
[C][D:1]---
[L]Your custom content here
[CUT]

Print an order confirmation slip on the kiosk's printer.

Guest-facing endpoint fired by the storefront confirmation page. Resolves the purchase's kitchen dispatch and prints an order confirmation (order number + QR code) to the specified printer group.

Flow:

1. Resolves purchaseIntentId → kitchen dispatch ID via the purchase's order.
2. Validates the printer group belongs to the location.
3. Sends an order_confirmation print job to the group.

Auto-print an order receipt on a kiosk's attached printer.

Fired by the storefront on the confirmation page when the kiosk's QR code has a printer UUID configured. The storefront only knows the purchaseIntentId; this endpoint resolves the underlying purchase plus the printer's group and issues a targeted print job so only the kiosk's printer produces the receipt.

Flow:

1. Resolves purchase.id from the given purchaseIntentId (scoped to the location).
2. Resolves the printer's group (scoped to the location) so the wrong kiosk can't be targeted.
3. Publishes a purchase_receipt print job with targetPrinterId set so only that physical printer picks it up.
4. Returns the correlation ID for tracking.

Reprint a kitchen ticket for an existing order.

This endpoint reprints kitchen tickets for a kitchen dispatch (order). Items are automatically routed to the correct printer groups based on printer group item configuration.

Important: Unlike the original print, this is a reprint operation that bypasses idempotency checks. Each call will create new print jobs.

Flow:

1. Fetches kitchen dispatch with items, events, and comments
2. Fetches printer groups for the location
3. Routes items to correct printer groups based on printer_group_items configuration
4. Sends print jobs for each printer group with relevant items

Create an order confirmation print job.

This endpoint prints an order confirmation slip for a kitchen dispatch (order). Used by POS when "print order confirmation" is enabled.

Order Confirmation Contents:

• Order number (daily ordinal)
• Order date/time
• QR code for order tracking
• Table name (if applicable)

Flow:

1. Validates printer group belongs to location
2. Fetches kitchen dispatch data
3. Sends print job to printer service via Pub/Sub

Create a pre-check (pro forma bill) print job for a table.

This endpoint prints a pre-check showing all items on a table's tab with totals and a payment QR code. Used when guests want to see their bill before paying.

Flow:

1. Validates printer group belongs to location
2. Fetches tab with all items, prices, and table info
3. Generates QR code URL for payment
4. Sends complete data to printer service via Pub/Sub

Create a purchase receipt print job.

This endpoint fetches the purchase data from the database and sends a complete print job to the printer service via Pub/Sub. The printer service will render the receipt using the appropriate template.

Flow:

1. Validates printer group belongs to location
2. Fetches purchase data with line items, VAT breakdown, and location info
3. Sends complete data to printer service via Pub/Sub
4. Returns correlation ID for tracking

Create a refund receipt print job.

This endpoint prints a refund receipt for a completed purchase refund. Used from the merchant dashboard when staff want to print a physical refund receipt.

Flow:

1. Validates printer group belongs to location
2. Sends refund receipt print job to printer service via Pub/Sub
3. Printer service fetches refund data and renders the receipt
4. Returns correlation ID for tracking

Print a receipt on the Adyen terminal.

Called from the POS receipt dialog after payment completes. The actual printing is fire-and-forget — this returns 202 immediately.

Flow:

1. Proxies request to payment-service
2. Payment-service fetches receipt data and sends print command to terminal
3. Returns 202 Accepted immediately

Create a test print job.

This endpoint sends a test page to the specified printer group. Use this to verify printer connectivity and configuration.

Test Page Contents:

• Service name and timestamp
• Custom message (if provided)
• Printer configuration info

Get printer dashboard with summary stats and recent activity

List all printer groups (prep groups) for a location with their printers

Create a new printer group (prep group)

Get a printer group by ID with its printers and CloudPRNT URLs

Update a printer group (prep group) name

Delete a printer group (prep group) and all its printers

List events for a printer group

List print jobs for a printer group

Get a single print job by ID with its events timeline

Add a printer to an existing printer group

List all printers for a location with CloudPRNT URLs

Create a new printer (optionally assign to a printer group)

Get a single printer by ID

Update a printer (e.g. reassign to a different printer group)

Delete a printer

List events for a single printer (online, offline, created, deleted)

Set which printer groups a printer belongs to (replaces all memberships)

Remove a printer from a specific printer group

Fired when a printer flow changes. printer-service subscribes to invalidate its in-memory cache.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Fired when a printer flow is removed.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.