README.md

Expedy Print API — Documentation

Welcome. This documentation covers the Expedy Print API v2, the HTTP surface you use to push print jobs to Expedy cloud thermal receipt printers or to Raspberry Pi gateways driving third-party USB printers.

displays and medias are out of scope here. They will be documented in separate repositories.

Reading order

1. Concepts → Printers vs. devices — the single most important page. It explains which resource to use and when.
2. Concepts → Printer compatibility — short, honest list of what's known to work today.
3. Getting started → Authentication — how the Authorization header is built.
4. Getting started → Quickstart — send your first print job in ~10 lines of Node.
5. Concepts → Delivery and idempotency — what a 200 response actually guarantees, and how to avoid double prints.
6. Getting started → Errors — status codes and the ExpedyApiError shape.

API reference

printers — Expedy cloud thermal receipt printer

• POST /printers/{printer_uid}/print — Create a print job ← flagship
• GET /printers/all — List printers

devices — Raspberry Pi gateway

• GET /devices/all — List devices
• GET /devices/{device_uid} — Get a device
• System: ping · update · reboot · shutdown
• USB printers: conf · scan · scan/read · {usb_port}/print
• Wi-Fi: conf · add · {wifi_id}/del · update

Building a receipt payload

Everything below gets embedded inside the printer_msg string you POST to /printers/{printer_uid}/print (or usb_msg when printing via a USB-attached ESC/POS printer).

Receipt layout

• Text layout tags
• Images and logos
• QR code
• EAN-13 barcode
• PDF
• Asian characters (Chinese / Japanese / Korean) — printer_han
• Remove the "Printed using Expedy.io" footer

Device actions

• Open the cash drawer — <PULSE/>
• Autocut — <CUT/>

Parameter tags (printer provisioning)

• Wi-Fi — <SETWIFI>
• Audible beep — <UNSETBEEP/>
• NTP clock — <SETSNTP>
• APN mobile data — <SETAPN>
• Keep-alive — <SETKEEPALIVE>

Samples

• Generic receipt
• Generic notification

Business-specific samples (restaurant, photo booth, promo QR, etc.) live in separate repositories.

Integrations

Not building a custom integration? docs/integrations.md indexes the no-code / e-commerce / delivery platforms that connect to Expedy PRINT without writing any code (Zapier, Make, n8n, Shopify, WooCommerce, Uber Eats, and more).

For AI agents

AGENTS.md at the repository root is a condensed reference meant to be read by coding agents (Claude Code, Cursor, Copilot…) — the two resources, the auth format, the printer_han pitfall, and where to find the rest.