1. Cloud Printing
  2. Models

Cloud Printing

Models

A print station represents a computer or device running the PackageX Print Station application, which manages one or more physical printers.

object "print_station"
The type identifier for this model.

id string
Unique identifier for the print station, prefixed with prnt_stn_

name string
Unique station name within the organization and location. Maximum 191 characters.

display_name string
Human-readable display name for the station. Maximum 191 characters.

status string
Current status of the station. Can be online or offline.

location_id string
ID of the location where this station is installed.

location object
Details about the location where this station is installed.

Show Details
location.id string
Unique identifier for the location
location.name string
Name of the location
location.code string
Location code

device_token string
Pushy device token used for sending push notifications to the print station app.

allow_all_users boolean
When true, all users with access to the location can use this station. When false, only users in allowed_users can use it.

allowed_users object[]
List of user profile IDs that are allowed to use this station when allow_all_users is false.

configuration object
Station-level configuration options.

Show Details
configuration.pooling_enabled boolean
When enabled, printers of the same model are treated as a single queue

printers Printer[]
Array of printers connected to this station.

created_at DateTime
Time when this station was created.

updated_at DateTime
Time when this station was last updated.

created_by string
ID of the user or API key that created this station.

updated_by string
ID of the user or API key that last updated this station.

Printer Model

A printer represents a physical printer connected to a print station.

id string
Unique identifier for the printer (UUID format).

name string
Unique printer name within the station.

model string
Printer model name (e.g., "HP LaserJet Pro M404dn").

status string
Current printer status. Can be online, offline, busy, or error.

configuration object
Printer configuration settings.

Show Details
configuration.dpi string
Dots per inch resolution
configuration.speed string
Print speed
configuration.color_print boolean
Whether the printer supports color printing
configuration.double_sided boolean
Whether the printer supports duplex (double-sided) printing
configuration.spooling boolean
Whether spooling is enabled
configuration.port integer
Printer port number (default: 9100)
configuration.priority integer
Printer priority for job routing (lower = higher priority)
configuration.type string
Printer type: laser, inkjet, thermal, dot_matrix, or unknown
configuration.orientation_limited_to string
If set, limits printer to portrait or landscape only

page_size object
Supported paper sizes for this printer.

Show Details
page_size.legal boolean
US Legal (8.5" x 14")
page_size.tabloid boolean
US Tabloid (11" x 17")
page_size.letter boolean
US Letter (8.5" x 11")
page_size.a0 boolean
ISO A0 (841 x 1189 mm)
page_size.a1 boolean
ISO A1 (594 x 841 mm)
page_size.a2 boolean
ISO A2 (420 x 594 mm)
page_size.a3 boolean
ISO A3 (297 x 420 mm)
page_size.a4 boolean
ISO A4 (210 x 297 mm)
page_size.a5 boolean
ISO A5 (148 x 210 mm)
page_size.a6 boolean
ISO A6 (105 x 148 mm)
page_size.label_1x2 boolean
1" x 2" label
page_size.label_2x2 boolean
2" x 2" label
page_size.label_2x4 boolean
2" x 4" label
page_size.label_3x3 boolean
3" x 3" label
page_size.label_4x6 boolean
4" x 6" label

created_at DateTime
Time when this printer was created.

updated_at DateTime
Time when this printer was last updated.

deleted_at DateTime
Time when this printer was soft-deleted, or null if active.

A print job represents a document queued for printing.

object "print_job"
The type identifier for this model.

id string
Unique identifier for the print job, prefixed with prnt_job_

organization_id string
The ID of the organization that owns this print job.

resource object
Details about the linked resource (shipment, fulfillment, item, or asset).

Show Details
resource.id string
ID of the linked resource
resource.name string
Document type identifier for the linked resource

file object
Details about the file to be printed.

Show Details
file.name string
Name of the file
file.url string
URL to the document to be printed (stored in PackageX cloud storage)

station object
Summary of the print station handling this job.

Show Details
station.id string
Print station ID
station.name string
Station name
station.display_name string
Station display name

printer object
Summary of the printer handling this job.

Show Details
printer.name string
Printer name
printer.model string
Printer model

options object
Print configuration options.

Show Details
options.scaling number
Scale factor for the document
options.total_pages integer
Total pages in the document
options.copies integer
Number of copies to print
options.color_print boolean
Whether to print in color
options.double_sided boolean
Whether to use duplex printing
options.print_all_pages boolean
Whether to print all pages
options.pages_to_print string[]
Specific pages or ranges to print
options.orientation string
Page orientation: portrait or landscape
options.reverse_order boolean
Whether to print pages in reverse order
options.paper_size string
Selected paper size

status string
Current job status. See Print Job Statuses for details.

reason string
Reason for failure when status is failed. Null otherwise.

updated_by_details object
Details about the user who last updated this job.

Show Details
updated_by_details.id string
User ID
updated_by_details.name string
User name

created_by_details object
Details about the user who created this job.

Show Details
created_by_details.id string
User ID
created_by_details.name string
User name

updated_by string
ID of the user or API key that last updated this job.

created_by string
ID of the user or API key that created this job.

checksum string
A unique hash for this print job used for data integrity verification.

created_at DateTime
Time when this job was created.

updated_at DateTime
Time when this job was last updated.

Status Description
queued Job is waiting to be processed by the print station
processing Print station is actively printing the document
completed Job finished successfully
failed Job failed (check reason field for details)
canceled Job was canceled by user before printing
aborted Job was aborted by system (e.g., printer was removed)

Status Transitions

        queued → processing → completed
                   → failed
       → canceled
       → aborted (system action)

Paper Size Values

When specifying paper size in API requests, use these values:

Value Description
page_size_legal US Legal (8.5" x 14")
page_size_tabloid US Tabloid (11" x 17")
page_size_letter US Letter (8.5" x 11")
page_size_a0 ISO A0 (841 x 1189 mm)
page_size_a1 ISO A1 (594 x 841 mm)
page_size_a2 ISO A2 (420 x 594 mm)
page_size_a3 ISO A3 (297 x 420 mm)
page_size_a4 ISO A4 (210 x 297 mm)
page_size_a5 ISO A5 (148 x 210 mm)
page_size_a6 ISO A6 (105 x 148 mm)
page_size_label_1x2 1" x 2" label
page_size_label_2x2 2" x 2" label
page_size_label_2x4 2" x 4" label
page_size_label_3x3 3" x 3" label
page_size_label_4x6 4" x 6" label
Previous <- Cloud Printing Overview
Next Print Stations ->