Developer Documentation

Build on
BizPrint

Three ways to integrate cloud printing into your product. Custom print templates, a REST API for direct control, and an MCP server for AI agents.

Print Templates

Build custom receipt and label layouts. Register templates, inject content with WP actions, and modify meta with filters.

Learn more

REST API

Full programmatic control over printers, stations, and print jobs from any language or platform.

Learn more

MCP Server

Connect AI agents to BizPrint using the Model Context Protocol. Works with Claude, Cursor, and any MCP-compatible client.

Learn more

01
Print Manager

Print Templates

Build fully custom receipt, label, and packing slip layouts for Print Manager. Register templates as a plugin add-on, inject content with WP actions, and modify item meta with filters. Available in versions 4.0.1 and above.

Registering a Custom Template

Use the zprint_loaded hook to safely register your template

Always register inside the zprint_loaded action to prevent loading errors. Call ZprintTemplates::registerTemplate() with an object implementing ZprintTemplateIndex.

The global $order variable is available in every template file. Use $order->get_meta to access custom fields, and $templateOptions to read the current location’s saved settings.

add_action('zprint_loaded', 'my_template_init');

function my_template_init() {
ZprintTemplates::registerTemplate( new MyCustomTemplate() );
}

ZprintTemplateIndex Interface

Required methods for every custom template class

getName() → string

Human-readable name shown in location settings dropdown

getSlug() → string

Unique identifier slug for this template

getPath($format) → string

Returns file path for html or plain format

getFormats() → array

Supported formats, e.g. ['html' => true, 'plain' => false]

For custom options, also implement ZprintTemplateOptions. Add renderOptions($options) to output settings HTML and processOptions($options) to handle and return the saved POST data.

WP Actions

Inject content at specific positions in the print output

add_action('Zprinttemplatescustomer-htmlafterShippingDetails', 'my_cb', 10, 1);

function my_cb( int $order_id ): void {
echo '<p>Custom content here</p>';
}


Zprint{template}-{format}afterShippingDetails
Fires after shipping details. Arg: int $order_id

Zprint{template}-{format}beforeFooter
Fires before the footer. Arg: int $order_id

Zprinttemplatesorder-{format}end
Fires at the end of the order template. Arg: int $order_id

Templates: customer, details, order. Formats: html, plain.

WP Filters

Modify order item meta before it renders in templates

add_filter('Zprinttemplatescustomer-htmlorderItemMeta', 'my_filter', 10, 1);

function my_filter( array $meta ): array {
// Add, remove, or reorder meta entries
return $meta;
}


Zprint{template}-{format}orderItemMeta
Filterable: array $meta

Zprint{template}-{format}orderItemRawMeta
Filterable: array $meta — also receives WC_Order_Item $item

Plain / Thermal Output

ZprintDocument static helpers for ESC/POS-style formatting

Document::centerLine($str)

Centers a string across the printer’s column width

Document::symbolsAlign($l, $r)

Two-column layout joined by spaces — for label/price rows

Document::line($str)

Prints a string on its own line with word-wrap

Document::emptyLine()

Inserts a blank line for spacing

Enable Print symbols for layout debug in location settings to replace alignment spaces with dots for easier column debugging.

Sample Template

A pre-wired scaffold to start from — included in Plus plan and above

Installs as a plugin add-on and immediately adds a “Fancy” option to your location’s template selector. Customize the HTML and CSS files to build your layout — all field access via $order->get_meta is available out of the box.

Do not edit templates inside the core plugin’s /templates directory. Plugin updates overwrite those changes. The custom template registration API is the supported path.

AI-Powered Template Builder

BizPrint Template Developer GPT

A custom GPT trained on BizPrint’s template system. Describe the layout you want and get working PHP — or paste in an existing template for refinement.

02
Direct Integration

REST API

Full programmatic access to the BizPrint Cloud. Manage printers and stations, send jobs, and query status from any platform or language.

API Reference

Full interactive documentation with request/response schemas, authentication details, and live examples.

bizswoop-development.github.io/bizprint-api

GitHub Repository

Source code, SDK clients, and examples. Open issues, contribute, or fork to build a custom client.

github.com/bizswoop-development/bizprint-api

Core Endpoints
GET
/printers
List all printers

GET
/printers/{id}
Get printer by ID

GET
/stations
List all print stations

POST
/print-jobs
Create a new print job

GET
/print-jobs/{id}
Get print job status

GET
/print-jobs
List all print jobs (paginated)

Authentication
Authorization: Basic base64(PUBLIC_KEY:SECRET_KEY)
Content-Type: application/json

# Base URL
https://print.bizswoop.app/api/connect-application/v1

03
AI Agent Integration

MCP Server

Connect AI assistants to BizPrint using the Model Context Protocol. The MCP Server runs locally on your machine and lets agents discover printers, trigger print jobs, and query logs — all through conversation.

GitHub Repository

Open source. Clone, configure, and connect your AI assistant to BizPrint in minutes.

github.com/bizswoop-development/bizprint-mcp-server

AI Printing Solutions

Learn how AI agents connect to your commerce print infrastructure. Use cases, architecture, and setup.

getbizprint.com/ai-printing

Available Tools
GET
get_printers
List all connected cloud printers with status and capabilities

GET
get_print_jobs
Retrieve status on active and completed print jobs

POST
print_url
Send any URL directly to a printer

POST
print_file
Print documents directly from the file system

POST
manage_printers
Enable, disable, and configure printer fleet

GET
get_logs
Access complete print activity logs

Quick Start
# Clone the repository
git clone https://github.com/bizswoop-development/bizprint-mcp-server.git

# Install dependencies
cd bizprint-mcp-server
npm install

# Configure your BizPrint Cloud connection
cp .env.example .env
# Add your BizPrint API credentials to .env

# Start the server
npm start

The MCP Server runs locally. No hosted service, no third-party dependency. Register it as a Desktop Extension in Claude to connect.