codeboxr/ecourier-courier

Bangladeshi ecourier service api package

v1.0.1 2022-10-14 06:51 UTC

This package is auto-updated.

Last update: 2022-11-14 06:57:49 UTC


README

68747470733a2f2f65636f75726965722e636f6d2e62642f77702d636f6e74656e742f7468656d65732f65636f75726965722d322e302f696d616765732f6c6f676f2e737667

Ecourier parcel service php/laravel package

68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636f6465626f78722f65636f75726965722d636f7572696572 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f73746172732f636f6465626f78722f65636f75726965722d636f7572696572

This is a Laravel/PHP package for Ecourier BD Courier System. This package can be used in laravel or without laravel/php projects. You can use this package for headless/rest implementation as well as blade or regular mode development. We created this package while working for a project and thought to made it release for all so that it helps. This package is available as regular php composer package.

Features

  1. Fetch Ecourier delivery/store city list
  2. Fetch Ecourier delivery/store thana/upzilla list
  3. Fetch Ecourier delivery/store postcode list
  4. Fetch Ecourier delivery/store postcode area list
  5. Fetch Ecourier delivery/store branch list
  6. Fetch Ecurier delivery package lsit
  7. Create parcel
  8. Parcel tracking

Requirements

  • PHP >=7.4
  • Laravel >= 6

Installation

composer require codeboxr/ecourier-courier

vendor publish (config)

php artisan vendor:publish --provider="Codeboxr\\EcourierCourier\\EcourierServiceProvider"

After publish config file setup your credential. you can see this in your config directory ecourier.php file

"sandbox"    => env("ECOURIER_SANDBOX", false), // for sandbox mode use true
"app_key"    => env("ECOURIER_API_KEY", ""),
"app_secret" => env("ECOURIER_API_SECRET", ""),
"user_id"    => env("ECOURIER_USER_ID", "")

Set .env configuration

ECOURIER_SANDBOX=true // for production mode use false
ECOURIER_API_KEY=""
ECOURIER_API_SECRET=""
ECOURIER_USER_ID=""

Usage

1. Get ecourier delivery city list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::area()->city();

2. Get ecourier delivery thana/upzilla list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::area()->thana($cityName);

3. Get ecourier delivery postcode list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::area()->postcode($cityName,$thanaName);

4. Get ecourier delivery postcode area list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::area()->areaList($postcode);

5. Get ecourier branch list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::area()->branch();

6. Delivery package list

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::order()->packageList();

7. Create Parcel

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::order()->create([
    "ep_name"              => "", // eCommerce Partner (EP) Name
    "pick_contact_person"  => "", // Contact Person of provided ep
    "pick_district"        => "", // Pickup district name
    "pick_thana"           => "", // Pickup thana name
    "pick_hub"             => "", // Pickup branch id 
    "pick_union"           => "", // Pickup union 
    "pick_address"         => "", // Pickup address
    "pick_mobile"          => "", // Pickup person contact number
    "recipient_name"       => "", // Parcel receiver’s name
    "recipient_mobile"     => "", // Parcel receiver’s mobile number
    "recipient_district"   => "", // Parcel receiver’s district name
    "recipient_city"       => "", // Parcel receiver’s city name
    "recipient_area"       => "", // Parcel receiver’s area name
    "recipient_thana"      => "", // Parcel receiver’s thana name
    "recipient_union"      => "", // Parcel receiver’s union name
    "package_code"         => "", // Package code find in package API
    "recipient_address"    => "", // Parcel receiver’s full address
    "parcel_detail"        => "", // Parcel product or documents details
    "number_of_item"       => "", // Total quantity
    "product_price"        => "", // Receive amount from parcel receiver’s
    "payment_method"       => "", // Cash On Delivery – COD,Point of Sale – POS, Mobile Payment – MPAY, Card Payment – CCRD
    "ep_id"                => "", // Invoice Id 
    "actual_product_price" => "" // Parcel product actual price
]);

8. Parcel tracking

use Codeboxr\EcourierCourier\Facade\Ecourier;

return Ecourier::order()->tracking($trackingId); //$trackingId find when create parcel they give you ID

Contributing

Contributions to the Ecourier package are welcome. Please note the following guidelines before submitting your pull request.

  • Follow PSR-4 coding standards.
  • Read Ecourier API documentations first

License

Ecourier package is licensed under the MIT License.

Copyright 2022 Codeboxr