answear/inpost-pickup-point-bundle

API Client for Inpost.

Installs: 11 396

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Type:symfony-bundle

3.1.0 2024-10-01 09:03 UTC

This package is auto-updated.

Last update: 2024-11-21 16:09:16 UTC


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)