PHPackages onestopmobile/printnode-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [File & Storage](/categories/file-storage) 4. / 5. onestopmobile/printnode-sdk ActiveLibrary[File & Storage](/categories/file-storage) onestopmobile/printnode-sdk =========================== PrintNode integration for PHP and Laravel to send print jobs, shipping labels, PDFs, and ZPL to remote printers. 0.2.0(2mo ago)09MITPHPPHP ^8.5CI passing Since Mar 20Pushed 2mo agoCompare [ Source](https://github.com/onestopmobile/printnode-sdk)[ Packagist](https://packagist.org/packages/onestopmobile/printnode-sdk)[ Docs](https://github.com/onestopmobile/printnode-sdk)[ RSS](/packages/onestopmobile-printnode-sdk/feed)WikiDiscussions master Synced 2w ago READMEChangelogDependencies (22)Versions (6)Used By (0) One Stop Mobile PrintNode SDK ============================= [](#one-stop-mobile-printnode-sdk) [![Tests](https://github.com/onestopmobile/printnode-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/onestopmobile/printnode-sdk/actions/workflows/ci.yml)[![Coverage](https://camo.githubusercontent.com/c58ed9c16f210594705b34cbac25e514997125f280c1466ff652edbe751f9c26/68747470733a2f2f636f6465636f762e696f2f67682f6f6e6573746f706d6f62696c652f7072696e746e6f64652d73646b2f67726170682f62616467652e737667)](https://codecov.io/gh/onestopmobile/printnode-sdk)[![Latest Version on Packagist](https://camo.githubusercontent.com/34232b5d7c448fb0c330e41aec801a8cc6226d3e14f67d0b46e01b49815b1831/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f6e6573746f706d6f62696c652f7072696e746e6f64652d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/onestopmobile/printnode-sdk)[![Total Downloads](https://camo.githubusercontent.com/2fccd4e8b986b5170bd4547d3bfd8ff5b4a5d353ea8793adc63449def40636cc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f6e6573746f706d6f62696c652f7072696e746e6f64652d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/onestopmobile/printnode-sdk)[![License](https://camo.githubusercontent.com/35e0325cc16f86ee7cf591fdbb6d0a604ac10b0716095925453a7f101f9631ac/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6f6e6573746f706d6f62696c652f7072696e746e6f64652d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/onestopmobile/printnode-sdk) A PHP 8.5+ SDK for PrintNode with typed API access and an optional Laravel print layer. ``` composer require onestopmobile/printnode-sdk ``` Use it when you want: - typed access to the PrintNode API - a framework-agnostic core for any PHP application - a higher-level Laravel printing API for common PDF and ZPL flows - target-based printer resolution through your own application logic - optional non-production print guards - optional PSR-3 and Laravel log-channel support for print activity Choose Your Entry Point ----------------------- [](#choose-your-entry-point) - Use the core SDK if you want typed access to PrintNode resources from any PHP app or framework. - Use the Laravel layer if you want short application code like `DispatchPrint::printer(...)->pdfUrl(...)` or `DispatchPrint::to(...)->zpl(...)`. Installation ------------ [](#installation) Minimum requirement: `PHP 8.5`. If you are working on this repository itself instead of consuming the package, use: ``` composer install ``` Recommended `.env` setup: ``` PRINTNODE_API_KEY= PRINTNODE_API_BASE_URL=https://api.printnode.com PRINTNODE_HTTP_USER_AGENT=onestopmobile-printnode-sdk PRINTNODE_HTTP_CONNECT_TIMEOUT_SECONDS=10 PRINTNODE_HTTP_REQUEST_TIMEOUT_SECONDS=30 PRINTNODE_HTTP_RETRY_ATTEMPTS=1 PRINTNODE_HTTP_RETRY_INTERVAL_SECONDS=0 PRINTNODE_HTTP_USE_EXPONENTIAL_BACKOFF=false PRINTNODE_DEFAULT_CHILD_ACCOUNT_LOOKUP_FIELD= PRINTNODE_DEFAULT_CHILD_ACCOUNT_LOOKUP_VALUE= PRINTNODE_PRINT_DEFAULT_TITLE="Backoffice print job" PRINTNODE_PRINT_DEFAULT_SOURCE="One Stop Mobile - Backoffice" PRINTNODE_PRINT_IDEMPOTENCY_KEY_PREFIX= PRINTNODE_PRINT_GUARD_ENABLED=true PRINTNODE_PRINT_ALLOWED_ENVIRONMENTS=production PRINTNODE_PRINT_ACTION_OUTSIDE_ALLOWED_ENVIRONMENTS=skip PRINTNODE_PRINT_LOGGING_ENABLED=true PRINTNODE_PRINT_LOG_CHANNEL=print-node PRINTNODE_PRINT_LOG_SKIPPED_JOBS=true PRINTNODE_PRINT_LOG_SUCCESSFUL_JOBS=false PRINTNODE_PRINT_LOG_FAILED_JOBS=true PRINTNODE_PRINT_LOG_INCLUDE_CONTENT_HASH=false PRINTNODE_PRINT_LOG_INCLUDE_CONTENT_LENGTH=true ``` Supported API Areas ------------------- [](#supported-api-areas) - `whoami` - `computers` - `printers` - `printjobs` - `scales` HTTP endpoints - `webhooks` - `account` - `downloads` - `misc` endpoints like `ping` and `noop` SDK Endpoint Matrix ------------------- [](#sdk-endpoint-matrix) API areaSDK entry pointPublic methods`whoami``whoAmI()`, `whoAmIResource()``get()``computers``computers()``all()`, `get()`, `delete()``printers``printers()``all()``printjobs``printJobs()``all()`, `get()`, `create()`, `delete()`, `states()`, `byPrinters()`, `deleteByPrinters()``downloads``downloads()``all()`, `get()`, `latest()`, `update()``scales``scales()``listConnected()`, `all()`, `byDeviceName()`, `get()`, `test()``webhooks``webhooks()``all()`, `create()`, `update()`, `delete()``account``account()``create()`, `update()`, `delete()`, `controllable()`, `getState()`, `setState()`, `getTag()`, `setTag()`, `deleteTag()`, `getApiKey()`, `createApiKey()`, `deleteApiKey()`, `clientKey()``misc``misc()``ping()`, `noop()`Full low-level SDK reference: [docs/sdk-reference.md](docs/sdk-reference.md). Typed API Usage --------------- [](#typed-api-usage) ``` use OneStopMobile\PrintNodeSdk\Enums\PrintContentType; use OneStopMobile\PrintNodeSdk\Payloads\CreatePrintJobPayload; use OneStopMobile\PrintNodeSdk\PrintNodeConfig; use OneStopMobile\PrintNodeSdk\PrintNodeSdk; $sdk = new PrintNodeSdk(new PrintNodeConfig( apiKey: getenv('PRINTNODE_API_KEY') ?: '', )); $whoAmI = $sdk->whoAmI(); $email = $whoAmI->email; $computers = $sdk->computers()->all(); $printers = $sdk->printers()->all(); $printJobId = $sdk->printJobs()->create( new CreatePrintJobPayload( printerId: 123, title: 'Shipping label', contentType: PrintContentType::PdfUri, content: 'https://example.com/label.pdf', ), idempotencyKey: 'label-123', ); ``` Typed child-account creation ---------------------------- [](#typed-child-account-creation) ``` use OneStopMobile\PrintNodeSdk\Payloads\CreateChildAccountPayload; $childAccount = $sdk->account()->create( new CreateChildAccountPayload( email: 'child@example.com', password: 'secret-password', creatorRef: 'customer-123', apiKeys: ['production'], tags: [ 'customer_id' => '123', ], ), ); ``` Child-account impersonation --------------------------- [](#child-account-impersonation) ``` use OneStopMobile\PrintNodeSdk\Values\ChildAccountContext; $childAccount = ChildAccountContext::byEmail('warehouse@example.com'); $tags = $sdk->account()->getTag('team', $childAccount); ``` Laravel integration ------------------- [](#laravel-integration) The package ships with `OneStopMobile\PrintNodeSdk\Laravel\PrintNodeServiceProvider` and a publishable config file: Supported Laravel integration target: `12.x` and `13.x`. ``` php artisan vendor:publish --tag=printnode-config ``` Laravel uses the same recommended env names shown above. For array- and class-based options like `allowed_environments`, `resolver`, and `default_options`, use the published `config/printnode.php` file. High-level printing API ----------------------- [](#high-level-printing-api) The package also ships with a Laravel-friendly print abstraction for short application code. Direct printing to a known PrintNode printer id: ``` use OneStopMobile\PrintNodeSdk\Laravel\Facades\DispatchPrint; $result = DispatchPrint::printer(123)->pdfUrl( 'https://example.com/packing-slip.pdf', title: 'Pakbon 1001', ); ``` This is the fastest path when your application already knows the external PrintNode printer id. Printing raw content: ``` $result = DispatchPrint::printer(123) ->source('warehouse') ->option('copies', 2) ->raw('^XA^FO50,50^FDHello^FS^XZ', title: 'Label 1001'); ``` Or use the semantic ZPL helper: ``` $result = DispatchPrint::printer(123) ->source('warehouse') ->zpl('^XA^FO50,50^FDHello^FS^XZ', title: 'Label 1001'); ``` Using dependency injection instead of the facade: ``` use OneStopMobile\PrintNodeSdk\Printing\PrintManager; public function __invoke(PrintManager $print): void { $print->printer(123)->pdfUrl( 'https://example.com/packing-slip.pdf', title: 'Pakbon 1001', ); } ``` If you prefer to avoid a long list of named arguments when customizing the print layer, configure it through `PrintManagerConfig`: ``` use OneStopMobile\PrintNodeSdk\Printing\PrintManagerConfig; $print = $sdk->printingWithConfig(new PrintManagerConfig( defaultSource: 'warehouse', logFailures: true, logSuccess: false, )); ``` Target-based printing --------------------- [](#target-based-printing) If your application does not store raw PrintNode printer ids everywhere, you can resolve arbitrary app targets through a user-defined resolver. ``` $result = DispatchPrint::to($order->printer_reference) ->pdfUrl('https://example.com/packing-slip.pdf', title: 'Pakbon 1001'); ``` The package itself does not assume anything about databases, Eloquent models or your own printer storage. You provide that behavior by binding `OneStopMobile\PrintNodeSdk\Contracts\ResolvesPrintTarget`. `to(...)` is the Laravel-facing name for this flow. See `docs/laravel-printing.md` for the full resolver example and integration guide. Laravel print safety and logging -------------------------------- [](#laravel-print-safety-and-logging) The Laravel integration can optionally protect physical printers outside selected environments and can log print activity through an existing Laravel log channel. The published config defaults are intentionally safe: - In `local` and `develop`, print jobs are skipped before they reach PrintNode and a skipped-job log entry is written. - In `production`, the same defaults allow jobs to be sent to PrintNode. - The default preferred log channel is `print-node`. If that channel is not configured in Laravel, the package falls back to the app logger. Published `printnode.php` config supports: ``` 'default_child_account' => [ 'by' => 'email', 'value' => 'warehouse@example.com', ], 'printing' => [ 'policy' => [ 'enabled' => true, 'allowed_environments' => ['production'], 'action_outside_allowed_environments' => 'skip', ], 'logging' => [ 'enabled' => true, 'channel' => 'stack', 'log_skipped' => true, 'log_success' => false, 'log_failures' => true, 'include_content_hash' => false, 'include_content_length' => true, ], ], ``` When logging is enabled, the package logs metadata such as printer id, title, content type, request id and payload length. Payload hashes are optional and disabled by default. Raw ZPL/PDF content is not logged by default. Error handling -------------- [](#error-handling) Failed API responses are mapped to SDK exceptions: - `AuthenticationException` - `AuthorizationException` - `ValidationException` - `ResourceNotFoundException` - `ConflictException` - `RateLimitException` - `ApiErrorException` - `PrintDispatchBlockedException` - `InvalidIdentifierSetException` - `UnresolvablePrintTargetException` - `IncompletePrintJobException` `RateLimitException` also exposes the raw `Retry-After` header when the API provides one. Development scripts ------------------- [](#development-scripts) ``` composer test:unit composer analyse composer test:lint composer check ``` Live GET smoke test ------------------- [](#live-get-smoke-test) You can run a non-destructive live smoke test through the SDK itself with an API key argument: ``` composer smoke:get -- your-printnode-api-key composer smoke:get -- your-printnode-api-key --extended ``` Default GET suite: - `ping` - `whoami` - `computers` - `printers` - `printjobs` with `limit=5` - `printjob states` with `limit=5` - `download clients` Extended GET suite: - `account state` - `controllable accounts` - `webhooks` - `connected scales` ### Health Score 37 — LowBetter than 81% of packages Maintenance86 Actively maintained with recent releases Popularity5 Limited adoption so far Community6 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~5 days Total 5 Last Release 74d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/838f66b0576c86a0c0559fbbaa8b34f8ca2b82daa000e8c41d2689f83d2ae8a4?d=identicon)[DirkHoffman](/maintainers/DirkHoffman) --- Top Contributors [![DirkHoffman](https://avatars.githubusercontent.com/u/17901335?v=4)](https://github.com/DirkHoffman "DirkHoffman (5 commits)") --- Tags phplaravelzplPrintNodeLabel-Printingcloud-printingprint-jobsshipping-labelspdf-printing ### Code Quality TestsPest Static AnalysisPHPStan, Rector Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/onestopmobile-printnode-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/onestopmobile-printnode-sdk/health.svg)](https://phpackages.com/packages/onestopmobile-printnode-sdk) ``` ### Alternatives [madnest/madzipper Easier zip file handling for Laravel applications. 1382.4M8](/packages/madnest-madzipper)[sopamo/laravel-filepond Laravel backend module for filepond uploads 216293.6k3](/packages/sopamo-laravel-filepond)[soarecostin/file-vault 191196.2k](/packages/soarecostin-file-vault) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)