Download the PHP package inpostapi/inpost-vonhalsky-api-sdk-php without Composer

On this page you can find all versions of the php package inpostapi/inpost-vonhalsky-api-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of inpostapi/inpost-vonhalsky-api-sdk-php

Informations about the package inpost-vonhalsky-api-sdk-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

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

Key features

Category Management

Offer Management

Order Management

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 [email protected].

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:

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

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

Tests

To run the tests, use:

Author

Marcin Bach — [email protected]

All versions of inpost-vonhalsky-api-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^5.3 || ^7.3
guzzlehttp/psr7 Version ^1.0 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package inpostapi/inpost-vonhalsky-api-sdk-php contains the following files

Loading the files please wait ...