answear/inpost-pickup-point-bundle

API Client for Inpost.

3.1.0 2024-10-01 09:03 UTC

Requires

• php: ^8.2
• ext-json: *
• guzzlehttp/guzzle: ^6.0|^7.0
• phpstan/phpstan-deprecation-rules: ^1.2
• symfony/http-kernel: ^6.1|^7.0
• symfony/property-info: ^6.1|^7.0
• symfony/serializer: ^6.1|^7.0
• symfony/serializer-pack: ^1.0
• webmozart/assert: ^1.11

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.64
• phpro/grumphp: ^2.8
• phpstan/phpstan: ^1.12
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^10.5
• roave/security-advisories: dev-master
• symfony/phpunit-bridge: 6.2.*|^7.0

MIT

README

Inpost integration for Symfony Documentation of the API can be found here: https://docs.inpost24.com/display/PL/Dokumentacja+API+SHIPX

Instalation

• install with Composer

composer require answear/inpost-pickup-point-bundle

Answear\InpostBundle\AnswearInpostBundle::class => ['all' => true],
should be added automatically to your config/bundles.php file by Symfony Flex.

Usage

Find parcel machines

use Answear\InpostBundle\Command\FindPoints;
use Answear\InpostBundle\Request\FindPointsRequestBuilder;

$findPointsRequest = (new FindPointsRequestBuilder())->build();

/** @var FindPoints $findPointsCommand */
$findOfficeResponse = $findPointsCommand->findPoints($findPointsRequest);

FindPointsRequestBuilder

This class allows you to quickly search for specific parcel machines

• Example: search parcel machine with given name

use Answear\InpostBundle\Request\FindPointsRequestBuilder;

$findPointsRequest = (new FindPointsRequestBuilder())
                        ->setName('AK1001')
                        ->build();

Available methods

• setName (string)
• setNames (array)
• setType (PointType)
• setTypes (PointType[])
• setFunction (PointFunctionsType)
• setFunctions (PointFunctionsType[])
• setPartnerId (integer)
• setPartnersId (array)
• setIsNext (boolean)
• setPaymentAvailable (boolean)
• setPostCode (string)
• setPostCodes (array)
• setCity (string)
• setCities (array)
• setProvince (string)
• setVirtual (integer)
• setVirtuals (array)
• setUpdatedFrom (DateTimeInterface)
• setUpdatedTo (DateTimeInterface)
• setPage (integer)
• setPerPage (integer)