Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.49 KB

README.md

File metadata and controls

69 lines (47 loc) · 2.49 KB
Raw

Laravel Parcel2GO API

** At the moment you can only quote, not book- as I haven't implemented anything else yet. **

Why?

  • Created for my own personal use, wanted something simple to use for quoting parcels.
  • You get around 46 quotes for your one, with all various courier / freight companies- great for customers.

How do I get/use it?

Composer require the package into your laravel project.

composer require jackbayliss/laravel-parcel2goapi

Note: If you're using Laravel >= 5.5, you can skip the registration of the service provider, as they are registered automatically. So no need to add it into your providers array.

Then in your config folder, go into your app.php and add the below to the providers array.

jackbayliss\Parcel2GoApi\Parcel2GoAPIServiceProvider::class,

I would then recommend setting your client_id,client_secret and from_address which can be found in vendor->jackbayliss->Config->config.php

Bare in mind your from address is the country you are sending from, default it is set to the UK (GBR), so France would be FRA, Italy ITA etc.

once these have been set you can then use the API.

If you don't have the above, set up an account here, then create your API credentials by going here.

Once you've set your client_id,client_secret and from_address you're ready to use- simply do the below.

$parcel = [array("Value" =>150 ,"Weight" =>2, "Length" =>9, "Width" => 8, "Height" => 1)];
$api = new \jackbayliss\Parcel2GoApi\Parcel2GoAPI();
$api->SetToCountry("GBR")->SetParcels($parcel)->GetQuote();

If you want to add more than one parcel, you can just do the below

$parcels = [
array("Value" =>150 ,"Weight" =>2, "Length" =>9, "Width" => 8, "Height" => 1)
array("Value" =>250 ,"Weight" =>1, "Length" =>3, "Width" => 2, "Height" => 3)
];
$api = new \jackbayliss\Parcel2GoApi\Parcel2GoAPI();
$api->SetToCountry("GBR")->SetParcels($parcels)->GetQuote();

Once you've done the above, you can access the quotes given to you by simply doing

$api->quotes

Or just add it onto the GetQuote method like the below..

$api->SetToCountry("GBR")->SetParcels($parcels)->GetQuote()->quotes

Authors

  • Jack Bayliss - Initial work

License

This project is licensed under the MIT License - see the LICENSE file for details

That's all folks 👍