Download the PHP package mvdnbrk/myparcel-php-api without Composer
On this page you can find all versions of the php package mvdnbrk/myparcel-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package myparcel-php-api
MyParcel API client for PHP
MyParcel makes sending packages easy.
Requirements
To use the MyParcel API client, the following things are required:
- Get a free MyParcel account
- Generate your API Key
- Now you're ready to use the MyParcel API client
Installation
You can install the package via composer:
Getting started
Initialize the MyParcel client and set your API key:
Create a parcel
Create a shipment
You have created your first shipment!
Retrieve a label
A label can be retrieved by using $shipment->id
. This will return a label in A6 format as a string.
Or you may pass the Shipment
instance directly to this method:
The label format is A6 by default, you may change this by calling the setFormatA4
method:
Setting delivery options for a parcel
You can set delivery options for a parcel by passing in the options directly when you create a parcel:
Or you may use a method like signature
, onlyRecipient
, returnToSender
, ageCheck
and labelDescription
.
You may call any of these methods after constructing the parcel:
Mailbox package
This package type is only available for shipments in the Netherlands that fit in a standard mailbox.
Send a parcel to a service point
You may send a parcel to a PostNL service point where a customer can pick up the parcel:
Retrieve service points
This will return a collection of ServicePoint
objects:
Get a shipment
You can get a shipment by id
or your own reference.
Track a shipment
You can get detailed track and trace information for a shipment.
Usage with Laravel
You may incorporate this package in your Laravel application by using this package.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Mark van den Broek
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of myparcel-php-api with dependencies
ext-json Version *
composer/ca-bundle Version ^1.2
guzzlehttp/guzzle Version ^6.4 || ^7.1
illuminate/collections Version ^8.0