Print Queue API

Manage print jobs — automatically queue receipts for printing and track their status

Base URL

https://{tenant}.logzi.com/api/printer_queue/

Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. The print queue contains jobs waiting for a printer device — each job identifies one copy of one receipt.

GET /api/printer_queue/get

Retrieve a single print queue item by ID.

Query parameters

ParameterTypeRequiredDescription
idintPrint queue item ID

Example request

GET /api/printer_queue/get?id=5
X-API-KEY: {your_api_key}
GET /api/printer_queue/list

Retrieve a paginated list of the print queue.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object

Example request

GET /api/printer_queue/list?list_offset=0
X-API-KEY: {your_api_key}
POST /api/printer_queue/save

Queue or update a print job. Use data[id] = 0 for a new job.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new job, >0 = update
printer_device_idintTarget printer device ID
receipt_idintID of the receipt to print
receipt_type_idintReceipt type
receipt_sourcestringPrint source (e.g. pdf, pos-thermal)
is_printedint1 = already printed

Example request

POST /api/printer_queue/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "printer_device_id": 1,
    "receipt_id": 150,
    "receipt_type_id": 2,
    "receipt_source": "pos-thermal",
    "is_printed": 0
  }
}
POST /api/printer_queue/delete

Remove a print job from the queue.

POST fields — data object

FieldTypeRequiredDescription
idintID of the queue item to delete

Example request

POST /api/printer_queue/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 5 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!