cognito/auspost_pac

Australia Post PAC API

Maintainers

Details

github.com/joshbmarshall/auspost_pac

Source

Issues

Installs: 276

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.0 2021-07-30 07:41 UTC

Requires

  • php: >=7.2

MIT 2c66dadd891a62dfdbc1226c50ceccc3ce5e6a9a

  • Josh Marshall <josh.woop@jmarshall.com.au>

This package is auto-updated.

Last update: 2024-04-29 04:53:39 UTC

README

Interact with the AusPost PAC API

Installation

Installation is very easy with composer:

composer require cognito/auspost_pac

Setup

Create a developer account at Australia Post at https://developers.auspost.com.au/apis/pacpcs-registration

Usage

<?php
	$auspost = new \Cognito\AuspostPAC\AuspostPAC('Your API Key');

	// Get list of Parcel Sizes
	$parcelSizes = $auspost->getParcelSizes();

	// Get a quote for delivery options using known weight and box dimensions
	$quotes = $auspost->startQuote()
		->setFromPostcode(4500)
		->setToPostcode(4127)
		->setParcelDimensions(10, 8, 22)
		->setParcelWeight(2.3)
		->getServices();

	// Get a quote for delivery options using known weight and approximate box dimensions from cubic weight
	$quotes = $auspost->startQuote()
		->setFromPostcode(4500)
		->setToPostcode(4127)
		->setParcelWeight(2.3)
		->setParcelCubicWeight(4)
		->getServices();

	// Get a quote for delivery options using cubic weight
	$quotes = $auspost->startQuote()
		->setFromPostcode(4500)
		->setToPostcode(4127)
		->setParcelCubicWeight(4)
		->getServices();

	// Get a total price for a delivery of a certain type
	$price = $auspost->startQuote()
		->setFromPostcode(4500)
		->setToPostcode(4127)
		->setParcelCubicWeight(4)
		->getTotalPrice('AUS_PARCEL_REGULAR');