Skip to content
CakePHP 2.0 plugin Maxoptra Delivery Scheduling
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Lib
LICENSE
README.md

README.md

Maxoptra CakePHP 2.x Plugin

CakePHP 2.x Plugin to schedule deliveries and collections with Maxoptra via their REST API Version 2.

Installation

If you want to use this repository as a submodule...

git submodule add https://github.com/MadCapsule/cakephp-maxoptra.git app/Plugin/Maxoptra

If not, copy the Lib folder from this repository to app/Plugin/Maxoptra so that you end up with app/Plugin/Maxoptra/Lib etc.

If you do not already have all Plugins loaded, make sure you load this Plugin from your Config/bootstrap.php file as below.

CakePlugin::load('Maxoptra'); 

You can load all Plugins instead, with the following.

CakePlugin::loadAll(); 

Requirements

  • CakePHP 2.x
  • Maxoptra Account with API access

Usage

$account = 'XXXXXXXXXXXXXXXXXXX'; // Maxoptra Account Id
$username = 'XXXXXXXXXXXXXXXXXXX'; // Maxoptra Username
$password = 'XXXXXXXXXXXXXXXXXXX'; // Maxoptra Password

$this->Maxoptra = new Maxoptra($account, $username, $password);

$post_data = array(
	'orderReference' => 'MCM1234', 					// Your order reference
	'areaOfControl' => 'Manchester', 				// Area of Control in Maxoptra for this order
	'date' => '28/03/2014',						// dd/mm/yyyy
	'client' => array(
			'name' => 'Mad Capsule Media',			// Receipitent Company or Person name
			'contactPerson' => 'Bill Withers',		// Receipitent Person fullname
			'contactNumber' => '01171231234'		// Receipitent contact telephone number
			),
	'location' => array(
			'name' => 'Bill Withers',			// Receipitent name at location
			'address' => '123 Surrey Street BS2 9TE'	// Receipitent address, without country
			),
	'dropWindows' => array(
			'dropWindow' => array(
					'start' => '05/08/2014 08:00', // Drop window start
					'end' => '05/08/2014 15:00'    // Drop window end
					)
			),
	'priority' => 2, 						// Order priority
	'durationDrop' => '00:10',	 				// Drop duration MM:SS
	'capacity' => '100', 						// Shipment weight - optional
	'volume' => '200', 						// Shipment volume - optional
	'collection' => true, 						// Collection or Delivery true/false
	'additionalInstructions' => 'Beware of the dog!'		// Instructions to driver
	);

$this->Maxoptra->delivery($post_data);
You can’t perform that action at this time.