IPrintRequest (Main Payload)
The root object containing metadata about the check, the destination printer, and the visual styling of the ticket.
| Field | Type | Description |
|---|---|---|
venueId | string | Required. The ID of the physical location. |
checkId | string | Required. Unique identifier for the financial check. |
checkNumber | number | Required. The human-readable number assigned to the check. |
printSessionId | string | Required. Unique ID for the current batch of items being sent. |
items | Array | Required. A list of IPrintRequestItem objects (see below). |
status | string | Current status of the job (e.g., PENDING, PRINTED). |
isForwarded | boolean | Indicates if this request was rerouted from another device. |
backgroundColor | string | Hex code for UI/KDS background styling. |
textColor | string | Hex code for UI/KDS text styling. |
printerDeviceId | string | The ID of the target hardware printer. |
instructions | Array | Specific hardware instructions (cut, beep, logo). |
Implementation Details
1. Recursive Modifiers
Items utilize the childItems array to represent a tree structure. For example, a "Burger" item would contain childItems for "Add Cheese" or "No Onions."
2. Status Handling
The status and kdsStatus fields use the PRINT_JOB_STATUS enum. Integrators should specifically watch for VOID statuses to trigger cancellation logic in downstream systems.
3. Visual Styling
The backgroundColor and textColor fields are provided for integrations with Kitchen Display Systems (KDS) or digital screens to ensure brand consistency or to highlight specific order types (e.g., Delivery vs. Dine-In).