Sample Request

Sample JSON Payload

The following payload represents a real-world REMOTE print request (Order #18) for a table named "B10." It includes a mix of structured item data and raw hardware instructions for a KDS (Kitchen Display System).

Key Payload Highlights:

  • Hierarchical Modifiers: Note how the "House Burger" contains childItems for temperature (Medium), toppings (Cheddar, Bacon), and even a nested side (Mixed Green with House Dressing).
  • Hardware Instructions: The instructions array contains ESC/POS-style commands like LINE_FEED, HORIZONTAL_LINE, and FULL_CUT.
  • Visual Metadata: Items and instructions include color formatting (e.g., modifiers set to RED) to improve kitchen readability.

Example Payload

{
    "_createdAt": "2026-02-06T21:49:20.308Z",
    "_entityName": "PRINT_REQUEST",
    "_entityVersion": 2,
    "_stage": "qa",
    "_updatedAt": "2026-02-06T21:49:24.266750Z",
    "_updatedBy": "R9TX502AKPD",
    "checkId": "2501836f-5d9d-4a37-b0b9-070b2e7b0943",
    "checkName": "B10",
    "checkNumber": 18,
    "checkOwner": "Brandon W.",
    "checkOwnerEmployeeId": "d28f737f-c507-44b8-8f39-f9e09f55c256",
    "destinationPosDeviceId": "R9TX502AKPD",
    "destinationType": "KDS",
    "id": "b0c816d3-ba6b-4283-8b50-2948709d4746",
    "instructions":
    [
        {
            "color": "BLACK",
            "value": "en",
            "command": "SET_LANGUAGE"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "BOLD",
            "color": "BLACK",
            "alignment": "DISTRIBUTED",
            "value": "B10",
            "command": "TEXT"
        },
        {
            "format": "BOLD",
            "color": "BLACK",
            "alignment": "DISTRIBUTED",
            "value": "Dine In",
            "command": "TEXT"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "BOLD",
            "color": "BLACK",
            "command": "HORIZONTAL_LINE"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "DOUBLE_HEIGHT",
            "color": "BLACK",
            "alignment": "CENTER",
            "value": "No course",
            "command": "TEXT"
        },
        {
            "format": "BOLD",
            "value2": "",
            "color": "BLACK",
            "alignment": "DISTRIBUTED",
            "value": " House Burger HH",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Medium",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Cheddar",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Extra Bacon",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Swiss",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Mixed Green",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "     House Dressing",
            "command": "TEXT"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "BOLD",
            "value2": "",
            "color": "BLACK",
            "alignment": "DISTRIBUTED",
            "value": " Angry Chicken Wrap",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   SM Caesar Salad Side",
            "command": "TEXT"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "BOLD",
            "value2": "",
            "color": "BLACK",
            "alignment": "DISTRIBUTED",
            "value": " Westy Classic",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Medium Well",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   xtra sauce",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Blue Cheese Crumbles",
            "command": "TEXT"
        },
        {
            "format": "DOUBLE_WIDTH",
            "value2": "",
            "color": "RED",
            "alignment": "DISTRIBUTED",
            "value": "   Rosemary Fries",
            "command": "TEXT"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "format": "BOLD",
            "color": "BLACK",
            "command": "HORIZONTAL_LINE"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "LINE_FEED"
        },
        {
            "color": "BLACK",
            "command": "FULL_CUT"
        }
    ],
    "isForwarded": false,
    "isRefire": false,
    "isRerouted": false,
    "isRush": false,
    "isVoid": false,
    "items":
    [
        {
            "positionIds":
            [],
            "quantity": 1,
            "courseSortOrder": 0,
            "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
            "itemPreparationMinuteCount": 0,
            "isRefire": false,
            "isRush": false,
            "pricePointName": "happy hr (venue)",
            "childItems":
            [
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": -1,
                    "menuItemId": "581f775a-2cb6-4878-b6ca-67fad696d421",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 0,
                    "name": "Medium",
                    "id": "d044a99b-26d6-400e-890e-157cb6a7fc0c",
                    "checkSeatItemId": "d044a99b-26d6-400e-890e-157cb6a7fc0c",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "pricePointName": "add",
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 1,
                    "menuItemId": "478684a5-1fde-4b23-b51e-9ee0fc74fd32",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 200,
                    "pricePointId": "6d03d324-82b3-47a6-836b-90033ef5d8ee",
                    "name": "Cheddar",
                    "id": "fee9bd19-e488-4dde-bb6c-4d92b0ed569f",
                    "checkSeatItemId": "fee9bd19-e488-4dde-bb6c-4d92b0ed569f",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 1,
                    "prepModifierId": "20d21ecd-9bf7-459f-8739-fa047e769fac",
                    "menuItemId": "26a233eb-9a3f-4dba-8029-f95140ad3bd7",
                    "prepModifierName": "Extra",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 50,
                    "pricePointId": "9afb31c5-6837-4b55-913d-aa91e2d57a82",
                    "name": "Bacon",
                    "id": "b1c11924-131a-4c2c-8cfe-10360da5d943",
                    "checkSeatItemId": "b1c11924-131a-4c2c-8cfe-10360da5d943",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "pricePointName": "extra",
                    "childItems":
                    [],
                    "priority": 2,
                    "categoryPriority": 1,
                    "menuItemId": "99014ce4-8592-42d8-adc3-11c0ac8a34aa",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 50,
                    "pricePointId": "9afb31c5-6837-4b55-913d-aa91e2d57a82",
                    "name": "Swiss",
                    "id": "fb06bd36-be59-4cd1-a42d-411e33cc8df8",
                    "checkSeatItemId": "fb06bd36-be59-4cd1-a42d-411e33cc8df8",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [
                        {
                            "positionIds":
                            [],
                            "quantity": 1,
                            "courseSortOrder": 0,
                            "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                            "itemPreparationMinuteCount": 0,
                            "isRefire": false,
                            "isRush": false,
                            "pricePointName": "add",
                            "childItems":
                            [],
                            "priority": 1,
                            "menuItemId": "223bed4e-abe9-45ea-8260-8c4db9e21f39",
                            "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                            "isVoid": false,
                            "price": 0,
                            "pricePointId": "6d03d324-82b3-47a6-836b-90033ef5d8ee",
                            "name": "House Dressing",
                            "id": "0a2d397c-54b4-4655-8c7c-9058d83f0585",
                            "checkSeatItemId": "0a2d397c-54b4-4655-8c7c-9058d83f0585",
                            "status": "CREATED"
                        }
                    ],
                    "priority": 99,
                    "categoryPriority": 3,
                    "menuItemId": "720d9314-0379-4fa4-8664-d2873f432308",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 0,
                    "name": "Mixed Green",
                    "id": "4aa900ce-2137-4541-8bf1-fb9e9411e0e9",
                    "checkSeatItemId": "4aa900ce-2137-4541-8bf1-fb9e9411e0e9",
                    "status": "CREATED"
                }
            ],
            "priority": 3,
            "menuItemId": "846829cc-1489-47f5-bcd6-f7d9abc4ea10",
            "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
            "isVoid": false,
            "price": 1400,
            "pricePointId": "f3bd4d65-2782-4520-be49-061f8bfa9b39",
            "name": "House Burger",
            "id": "3c367c8a-f06a-4430-911b-cbd2c8866067",
            "checkSeatItemId": "3c367c8a-f06a-4430-911b-cbd2c8866067",
            "key": "846829cc-1489-47f5-bcd6-f7d9abc4ea10#f3bd4d65-2782-4520-be49-061f8bfa9b39#581f775a-2cb6-4878-b6ca-67fad696d421#478684a5-1fde-4b23-b51e-9ee0fc74fd32#6d03d324-82b3-47a6-836b-90033ef5d8ee#26a233eb-9a3f-4dba-8029-f95140ad3bd7#20d21ecd-9bf7-459f-8739-fa047e769fac#9afb31c5-6837-4b55-913d-aa91e2d57a82#99014ce4-8592-42d8-adc3-11c0ac8a34aa#9afb31c5-6837-4b55-913d-aa91e2d57a82#720d9314-0379-4fa4-8664-d2873f432308#223bed4e-abe9-45ea-8260-8c4db9e21f39#6d03d324-82b3-47a6-836b-90033ef5d8ee#",
            "status": "CREATED"
        },
        {
            "positionIds":
            [],
            "quantity": 1,
            "courseSortOrder": 0,
            "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
            "itemPreparationMinuteCount": 0,
            "isRefire": false,
            "isRush": false,
            "pricePointName": "",
            "childItems":
            [
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "pricePointName": "small",
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 3,
                    "menuItemId": "62c1f5cf-2a29-4012-b466-eba2455567cf",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 100,
                    "pricePointId": "98117f86-cba7-4cb8-a4d0-f99a6fee97a9",
                    "name": "Caesar Salad Side",
                    "id": "5278e645-a1fa-4c30-bc34-c801cabf156c",
                    "checkSeatItemId": "5278e645-a1fa-4c30-bc34-c801cabf156c",
                    "status": "CREATED"
                }
            ],
            "priority": 3,
            "menuItemId": "3673c4f6-4420-4868-86ad-1bb10ddafe3b",
            "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
            "isVoid": false,
            "price": 1650,
            "name": "Angry Chicken Wrap",
            "id": "e38adbf3-cff6-4962-8ef6-2a064953f296",
            "checkSeatItemId": "e38adbf3-cff6-4962-8ef6-2a064953f296",
            "key": "3673c4f6-4420-4868-86ad-1bb10ddafe3b#62c1f5cf-2a29-4012-b466-eba2455567cf#98117f86-cba7-4cb8-a4d0-f99a6fee97a9#",
            "status": "CREATED"
        },
        {
            "positionIds":
            [],
            "quantity": 1,
            "courseSortOrder": 0,
            "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
            "itemPreparationMinuteCount": 0,
            "isRefire": false,
            "isRush": false,
            "pricePointName": "",
            "childItems":
            [
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": -1,
                    "menuItemId": "31bbb2a8-25bc-4a07-bfa3-2f0a3a063819",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 0,
                    "name": "Medium Well",
                    "id": "f69c4d23-5187-4a7e-a1d7-bdc2e8aa29b1",
                    "checkSeatItemId": "f69c4d23-5187-4a7e-a1d7-bdc2e8aa29b1",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 1,
                    "menuItemId": "6b7b2198-dcb4-4a63-83ad-ac73079a50a4",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 0,
                    "name": "xtra sauce",
                    "id": "0db473ad-f7e4-4c0f-8a00-c1534b7c336d",
                    "checkSeatItemId": "0db473ad-f7e4-4c0f-8a00-c1534b7c336d",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "pricePointName": "extra",
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 1,
                    "menuItemId": "71fd931a-f6c1-4df0-ba7f-2429a374f5ae",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 50,
                    "pricePointId": "9afb31c5-6837-4b55-913d-aa91e2d57a82",
                    "name": "Blue Cheese Crumbles",
                    "id": "b1d9ce25-15cb-4ea7-bd6f-89ace1c7d542",
                    "checkSeatItemId": "b1d9ce25-15cb-4ea7-bd6f-89ace1c7d542",
                    "status": "CREATED"
                },
                {
                    "positionIds":
                    [],
                    "quantity": 1,
                    "courseSortOrder": 0,
                    "printRequestId": "b0c816d3-ba6b-4283-8b50-2948709d4746",
                    "itemPreparationMinuteCount": 0,
                    "isRefire": false,
                    "isRush": false,
                    "childItems":
                    [],
                    "priority": 1,
                    "categoryPriority": 3,
                    "menuItemId": "8ef257c2-8cee-4679-93a6-fd23e3139ee5",
                    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
                    "isVoid": false,
                    "price": 100,
                    "name": "Rosemary Fries",
                    "id": "c12347b0-46a2-4e65-a2c6-3dc41830d485",
                    "checkSeatItemId": "c12347b0-46a2-4e65-a2c6-3dc41830d485",
                    "status": "CREATED"
                }
            ],
            "priority": 3,
            "menuItemId": "70c73469-a57d-4fff-b6f7-d66647ff2975",
            "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
            "isVoid": false,
            "price": 1850,
            "name": "Westy Classic",
            "id": "9171dc89-73bd-44c7-9961-c9e03fbc634d",
            "checkSeatItemId": "9171dc89-73bd-44c7-9961-c9e03fbc634d",
            "key": "70c73469-a57d-4fff-b6f7-d66647ff2975#31bbb2a8-25bc-4a07-bfa3-2f0a3a063819#6b7b2198-dcb4-4a63-83ad-ac73079a50a4#71fd931a-f6c1-4df0-ba7f-2429a374f5ae#9afb31c5-6837-4b55-913d-aa91e2d57a82#8ef257c2-8cee-4679-93a6-fd23e3139ee5#",
            "status": "CREATED"
        }
    ],
    "kdsStatus": "CREATED",
    "orderRowAllocation": 0,
    "orderTypeId": "c8f9e8c8-392f-4671-a5a3-e9100f59fd75",
    "orderTypeName": "Dine In",
    "printSessionId": "69381df2-346b-43e1-b72f-2c6164657bac",
    "printerDeviceId": "b27209e3-8a10-42e1-95b5-66f9bd8a9f19",
    "printerDeviceType": "KDS",
    "rangByEmployeeId": "d28f737f-c507-44b8-8f39-f9e09f55c256",
    "rangFromPosDeviceName": "BW-E - Tablet",
    "seatNumber": -1,
    "shortId": "2948709d4746",
    "status": "CONSUMED",
    "tableId": "6050f9e9-64c7-4569-b08c-9ad16ecde85c",
    "type": "REMOTE",
    "venueId": "9975ce43-1167-459f-8e97-a20b89a2866b",
    "retryCount": 0
}

Field Definitions (Extended)

Based on the provided example, here are additional fields relevant to third-party integrators:

Order Metadata

  • orderTypeName: (e.g., "Dine In", "Takeout") Useful for prioritizing packaging or table service.
  • destinationType: In this case KDS, indicating the payload is intended for a screen rather than a thermal receipt printer.
  • checkOwner: The name of the server who rang in the order.

Instruction Commands (EposPrintInstruction)

When processing the instructions array, use the command field to determine the action:

  • TEXT: Print the value. Check format (BOLD, DOUBLE_HEIGHT) and alignment.
  • LINE_FEED: Move to the next line.
  • HORIZONTAL_LINE: Draw a separator across the width of the ticket.
  • FULL_CUT: Trigger the mechanical paper cutter.