README

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

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

Key features

Category Management

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

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

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

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 https://inpsa-api-portal.inpost-group.com/.

Support

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

Related projects

The Inpost VonHalsky Magento 2 module uses this SDK for communication with the API. It is available at https://github.com/InPost-VonHalsky/InPost-vonHalsky-Magento.

Versioning and maintenance policy

Each API operation (endpoint) is versioned with specific /v<version> 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 https://inpsa-api-portal.inpost-group.com/.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Install the bindings via Composer:

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

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: bearerAuth
$config = InpostApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new InpostApi\Api\CategoriesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$category_id = d8ec11ce-12ba-4fb7-be9a-249e679f4e67; // string | Category ID identifier as path param.
$accept_language = en; // string | A two-letter code of the user's preferred language compliant with ISO 639.

try {
    $result = $apiInstance->getCategoriesAttributesByCategoryIdV1($category_id, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoriesApi->getCategoriesAttributesByCategoryIdV1: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://stage-api.inpost-group.com/inpsa

Class	Method	HTTP request	Description
CategoriesApi	getCategoriesAttributesByCategoryIdV1	GET /v1/categories/{categoryId}/attributes	Get Category Attributes
CategoriesApi	getCategoriesByIdV1	GET /v1/categories/{categoryId}	Get Category details
CategoriesApi	getCategoriesV1	GET /v1/categories	Browse Category tree
OfferAttachmentsApi	deleteOffersAttachmentsByOfferIdAndAttachmentIdV1	DELETE /v1/organizations/{organizationId}/offers/{offerId}/attachments/{attachmentId}	Delete Offer Attachment
OfferAttachmentsApi	getOffersAttachmentsByOfferIdAndAttachmentIdV1	GET /v1/organizations/{organizationId}/offers/{offerId}/attachments/{attachmentId}	Download Offer Attachment
OfferAttachmentsApi	getOffersAttachmentsByOfferIdV1	GET /v1/organizations/{organizationId}/offers/{offerId}/attachments	Get Offer Attachments
OfferAttachmentsApi	postOffersAttachmentsByOfferIdV1	POST /v1/organizations/{organizationId}/offers/{offerId}/attachments	Create Attachment for Offer
OffersApi	getOffersByIdV1	GET /v1/organizations/{organizationId}/offers/{offerId}	Get Offer details
OffersApi	getOffersCommandsByIdV1	GET /v1/organizations/{organizationId}/offers/commands/{commandId}	Offers Command Status
OffersApi	getOffersDepositTypesV1	GET /v1/offers/deposit-types	List Deposit Types
OffersApi	getOffersEventsV1	GET /v1/organizations/{organizationId}/offers/events	List of Offers Events
OffersApi	getOffersHintV1	GET /v1/organizations/{organizationId}/offers/hint	Hint product info, gpsr info and category
OffersApi	getOffersV1	GET /v1/organizations/{organizationId}/offers	List Offers
OffersApi	patchOffersByIdV1	PATCH /v1/organizations/{organizationId}/offers/{offerId}	Partially update Offer
OffersApi	postBatchOffersV1	POST /v1/organizations/{organizationId}/offers/batch	Batch Offer creation
OffersApi	postOffersCloseByOfferIdV1	POST /v1/organizations/{organizationId}/offers/{offerId}/close	Close Offer
OffersApi	postOffersReopenByOfferIdV1	POST /v1/organizations/{organizationId}/offers/{offerId}/reopen	Reopen Offer
OffersApi	postOffersV1	POST /v1/organizations/{organizationId}/offers	Create new Offer
OrdersApi	acceptReturnV1	POST /v1/organizations/{organizationId}/returns/{returnId}/accept	Accept Return
OrdersApi	getClaimByIdV1	GET /v1/organizations/{organizationId}/orders/{orderId}/claims/{claimId}	Get single claim details
OrdersApi	getClaimsForOrganizationV1	GET /v1/organizations/{organizationId}/claims	Get list of organization claims
OrdersApi	getOrdersByIdV1	GET /v1/organizations/{organizationId}/orders/{orderId}	Get Order details
OrdersApi	getOrdersClaimTypesDictionaryV1	GET /v1/orders/claim-types	Get claim types dictionary
OrdersApi	getOrdersCommandsByIdV1	GET /v1/organizations/{organizationId}/orders/commands/{commandId}	Orders Command Status
OrdersApi	getOrdersDeliveryMethodsV1	GET /v1/orders/delivery-methods	List Delivery Methods
OrdersApi	getOrdersEventsV1	GET /v1/organizations/{organizationId}/orders/events	List Orders Events
OrdersApi	getOrdersV1	GET /v1/organizations/{organizationId}/orders	List Orders
OrdersApi	getReturnByIdV1	GET /v1/organizations/{organizationId}/returns/{returnId}	Get single return details
OrdersApi	getReturnsByOrderIdV1	GET /v1/organizations/{organizationId}/orders/{orderId}/returns	Get returns for specific order
OrdersApi	getReturnsForOrganizationV1	GET /v1/organizations/{organizationId}/returns	Get all returns for organization
OrdersApi	partialRefundClaimV1	POST /v1/organizations/{organizationId}/orders/{orderId}/claims/{claimId}/partial-refund	Resolve claim with partial refund
OrdersApi	postOrdersAcceptByIdV1	POST /v1/organizations/{organizationId}/orders/{orderId}/accept	Accept Order
OrdersApi	postOrdersRefundByOrderIdV1	POST /v1/organizations/{organizationId}/orders/{orderId}/refund	Refund Order payment
OrdersApi	postOrdersRefuseByIdV1	POST /v1/organizations/{organizationId}/orders/{orderId}/refuse	Refuse Order
OrdersApi	refundClaimV1	POST /v1/organizations/{organizationId}/orders/{orderId}/claims/{claimId}/refund	Resolve claim with full refund
OrdersApi	rejectClaimV1	POST /v1/organizations/{organizationId}/orders/{orderId}/claims/{claimId}/reject	Reject claim
OrdersApi	rejectReturnV1	POST /v1/organizations/{organizationId}/returns/{returnId}/reject	Reject Return

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

Marcin Bach — mbach.sii@inpost.pl

inpostapi / inpost-vonhalsky-api-sdk-php

Maintainers

Package info

Statistics

Security