Printer

Working with printers in Menuflow

The printer API calls are specific to Kitchen printers that are pre-registered to a location using the Terminal calls The following API calls allow your applications to retrieve details of the available printers and the ability to send a print job to a specific printer and get the print job status.

---

Get Printers

Call to retrieve the full details of available printers.

Get Printers

GET https://api.menuflow.dev/go/printer/{location_id}

curl --location 'https://api.menuflow.dev/go/printer/{location_id}' --header 'x-api-key: YOUR-API-KEY'

Path Parameters

Name	Type	Description
location_id*	integer	Location_id where the printers are registered.

200: OK Printers found successfully

{
    "status": 200,
    "location_id": 1220,
    "records": 1,
    "result": [
        {
            "printer_id": 5,
            "printer_name": "Test Printer - London",
            "serial_number": "N42122CC00232",
            "model": "Sunmi NT310",
            "description": "Cloud POS printer",
            "status": "ONLINE",
            "last_seen": "2023-11-15 18:13:00",
            "date_added": "2023-11-15 13:05:30"
        }
    ]
}

404: Not Found No printers available at this location

Print Order

Call to send

Print Order

POST https://api.menuflow.dev/go/printer/{serial_no}

curl --request POST --location 'https://api.menuflow.dev/go/printer/{order_id}' --header 'x-api-key: YOUR-API-KEY'

--data '{ "location_id":1220,"serial_no": "VB129038210" }'

Path Parameters

Name	Type	Description
serial_no*	sting	serial_no of the printer that should print the order sent as JSON
order_id*	integer	order_id of the order to print
location_id*	integer	location_id of where the order should be printed sent as JSON

201: Created print job recieved successfully

{
    "status": 201,
    "order_no": 9000001,
    "created": 1
}

403: Forbidden print job failed

Print Job Status

API call to get the status of a specific print job.

Status

GET https://api.menuflow.dev/go/printer/{printjob_id}/printjob

url --location 'https://api.menuflow.dev/go/printer/{printjob_id/printjob}/printjob' --header 'x-api-key: YOUR-API-KEY'

Query Parameters

Name	Type	Description
printjob_id	integer	printjob_id that you wish to get the print status.

200: OK request successful

{
    "status": 200,
    "order_no": 9000001,
    "records": 1,
    "result": [
        {
            "printjob_id": 9000001,
            "location_id": 1220,
            "order_id": 1,
            "printer": "N42122CC00713",
            "status": "pending",
            "recieved_at": "2023-11-15 18:17:38",
            "printed_at": ""
        }
    ]
}

404: Not Found unable to retrieve the print job status