Cloud Printing

Cloud Printing Overview

The Cloud Printing APIs enable remote printing capabilities through PackageX. You can manage print stations, configure printers, and send print jobs to physical printers at your locations.

Creating and printing documents is a streamlined process. First, you'll set up a print station at a location with one or more printers. Then, you can create print jobs that are automatically routed to the most suitable printer based on paper size, capabilities, and queue length.

After a print job is created, it will transition through multiple statuses as the print station processes the job. You can use webhooks to listen for status updates or poll the API for the current status.

# Object IDs

To make development easier, all cloud printing object IDs are prefixed for easy identification:

• Print Station IDs are prefixed with prnt_stn_
• Print Job IDs are prefixed with prnt_job_

# Prerequisites

Before using the Cloud Printing API:

1. Enable Cloud Printing at your location via the PackageX Dashboard or API
2. Install Print Station App - The PackageX Electron app on a computer connected to printers
3. Register the Station - The app provides a Pushy device token for push notifications

# Architecture

        Your App → PackageX API → Push Notification → Print Station App → Physical Printer

      

When you create a print job:

1. The API selects the best printer based on document requirements
2. A push notification is sent to the print station app
3. The print station downloads the document and sends it to the printer
4. Status updates are sent back to the API

# Supported Document Formats

• PDF documents (recommended)
• Images (PNG, JPEG, etc.)

Documents can be provided as:

• Direct URL to the file
• Base64 encoded data with data URI prefix

# Paper Sizes

The API supports standard paper sizes and label formats: