README

An Australia Post driver for ParcelTrap

Install

Via Composer

composer require parceltrap/driver-auspost

Usage

Add the following to the drivers section of your config/parceltrap.php file:

'auspost' => [
    'api_key' => env('PARCELTRAP_AUSPOST_API_KEY'),
    'password' => env('PARCELTRAP_AUSPOST_PASSWORD'),
    'account_number' => env('PARCELTRAP_AUSPOST_ACCOUNT_NUMBER'),
],

use ParcelTrap\ParcelTrap;

/** @var ParcelTrap $parcelTrap */
$auspost = $parcelTrap->driver('auspost');

$details = $auspost->find('ABC123');
echo $details->status->description(); // Not Found, Delivered, etc

Configure the relevant environment variables in your .env file.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

We encourage people to come forward with fixes and general improvements. If you fork this repo to provide a fix, please open an issue or PR with reference to your changes. This driver was built off of the documentation provided by AusPost without any real testing, due to being unable to acquire sandbox/test access.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.

parceltrap / driver-auspost

Maintainers

Details