PHPackages                             inpostapi/inpost-vonhalsky-api-sdk-php - 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. [HTTP & Networking](/categories/http)
4. /
5. inpostapi/inpost-vonhalsky-api-sdk-php

ActiveLibrary[HTTP & Networking](/categories/http)

inpostapi/inpost-vonhalsky-api-sdk-php
======================================

OpenAPI SDK for InPost API endpoints: categories, offers, orders, attachments, invoices, events, shipping methods.

1.0.0(1mo ago)081↑33.3%1unlicensePHPPHP ^7.3 || ^8.0

Since Jul 17Pushed 1mo agoCompare

[ Source](https://github.com/InPost-VonHalsky/InPost-vonHalsky-api-sdk-php)[ Packagist](https://packagist.org/packages/inpostapi/inpost-vonhalsky-api-sdk-php)[ Docs](https://github.com/InPost-VonHalsky/InPost-vonHalsky-api-sdk-php)[ RSS](/packages/inpostapi-inpost-vonhalsky-api-sdk-php/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (1)

OpenAPIClient-php
=================

[](#openapiclient-php)

Welcome to the Inpost VonHalsky API documentation. This API serves as a powerful intermediary between merchants and Inpost VonHalsky shopping platform, enabling seamless integration and management of e-commerce operations.

API is specifically designed to be used by integration platforms, which are next used by sellers. Within API you will be able to create Offer and publish it on Inpost VonHalsky Platform.

Authentication
--------------

[](#authentication)

Access to API operations is restricted only for known integrators. For gathering access token please refer to agreement policy manager.

Key features
------------

[](#key-features)

### Category Management

[](#category-management)

- List all available Categories within platform.
- Retrieve detailed information about specific Category and its Attributes.

### Offer Management

[](#offer-management)

- Create (match) product Offers to showcase within platform.
- Update existing Offers to reflect changes in pricing or stock availability.
- Close or reopen Offers that are no longer available or relevant.

### Order Management

[](#order-management)

- List all Orders received through platform.
- Retrieve detailed information about individual Order.
- Pass invoices or shipments information to Offer.

References
----------

[](#references)

Please also read our Integration Guidelines which is separate document, it describes common scenarios using this API.

This library is built based on the API documentation available at .

Support
-------

[](#support)

In case of any problems or questions regarding this SDK or the API, please contact us at .

Related projects
----------------

[](#related-projects)

The Inpost VonHalsky Magento 2 module uses this SDK for communication with the API. It is available at .

Versioning and maintenance policy
---------------------------------

[](#versioning-and-maintenance-policy)

Each API operation (endpoint) is versioned with specific `/v` path prefix, for e.g.: `/v1/categories`, which increases only on breaking changes.

To familiarize yourself with the maintenance policy and details of the versioning rules, go to the API Portal, Versioning and Maintenance section.

For more information, please visit .

Installation & Usage
------------------------

[](#installation--usage)

### Requirements

[](#requirements)

PHP 8.1 and later.

### Composer

[](#composer)

Install the bindings via [Composer](https://getcomposer.org/):

```
composer require inpostapi/inpost-vonhalsky-api-sdk-php

```

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```