README

An independent PHP 8.1+ SDK for the InPost Von Halsky API. It provides typed request objects, immutable response models, OAuth 2.0 helpers, PSR-18 HTTP integration, and resource clients for organizations, catalogue data, offers, attachments, orders, returns, refunds, and claims.

This is not an official InPost product and is not affiliated with or endorsed by InPost. InPost and Von Halsky are trademarks of their respective owners.

Status

The SDK implements 41 current operations across organizations, categories, offers, attachments, orders, returns, and claims. It intentionally excludes two deprecated upstream operations. The first tagged release is 1.0.0, locked to production API 1.6.9. Publication on Packagist is still pending.

Requirements

• PHP 8.1 or newer;
• Composer 2;
• the JSON extension.

Install

Install 1.0.0 from a GitHub tag, or from Packagist after that listing exists:

composer require dev-lancer/von-halsky-php-sdk

Until Packagist is available, require the VCS repository or clone this repository. See Installation and first client.

First API call

For an existing access token, create a client with the default secure Symfony transport and list the organizations available to that token:

<?php

declare(strict_types=1);

use DateTimeImmutable;
use DevLancer\VonHalsky\Auth\AccessToken;
use DevLancer\VonHalsky\Auth\StaticTokenProvider;
use DevLancer\VonHalsky\Environment\Environment;
use DevLancer\VonHalsky\VonHalskyClient;

$client = VonHalskyClient::create(
    new StaticTokenProvider(new AccessToken('access-token', new DateTimeImmutable('+5 minutes'))),
    Environment::stage(),
);

$organizations = $client->organizations()->list()->data;

For production integrations, obtain and rotate tokens with the OAuth guide; never hard-code or log real credentials.

Documentation

Choose the documentation language: English or Polish. Both versions offer focused reading paths for a first integration, OAuth, catalogue and offers, order and post-sale processing, and production reliability.

• Guides explain how the SDK fits into an application.
• Operation reference documents every public resource method.
• Production checklist summarizes the application responsibilities that the SDK deliberately leaves to you.
• Runnable examples demonstrate selected workflows without credentials.

License

The SDK source code is available under the MIT License.