Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeboxrcodehub/ecourier-courier
Ecourier parcel service php/laravel package
https://github.com/codeboxrcodehub/ecourier-courier
api ecourier ecourier-package ecourier-parcel-tracker laravel-ecourier laravel-package
Last synced: 2 days ago
JSON representation
Ecourier parcel service php/laravel package
- Host: GitHub
- URL: https://github.com/codeboxrcodehub/ecourier-courier
- Owner: codeboxrcodehub
- License: mit
- Created: 2022-08-24T06:33:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-14T06:53:22.000Z (over 2 years ago)
- Last Synced: 2024-02-23T10:56:27.656Z (11 months ago)
- Topics: api, ecourier, ecourier-package, ecourier-parcel-tracker, laravel-ecourier, laravel-package
- Language: PHP
- Homepage: https://codeboxr.com
- Size: 33.2 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ecourier parcel service php/laravel package
This is a Laravel/PHP package for [Ecourier](https://ecourier.com.bd/) 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](https://packagist.org/packages/codeboxr/ecourier-courier).
## Features
1. [Fetch Ecourier delivery/store city list](https://github.com/codeboxrcodehub/ecourier-courier#1-get-ecourier-delivery-city-list)
2. [Fetch Ecourier delivery/store thana/upzilla list](https://github.com/codeboxrcodehub/ecourier-courier#2-get-ecourier-delivery-thanaupzilla-list)
3. [Fetch Ecourier delivery/store postcode list](https://github.com/codeboxrcodehub/ecourier-courier#3-get-ecourier-delivery-postcode-list)
4. [Fetch Ecourier delivery/store postcode area list](https://github.com/codeboxrcodehub/ecourier-courier#4-get-ecourier-delivery-postcode-area-list)
5. [Fetch Ecourier delivery/store branch list](https://github.com/codeboxrcodehub/ecourier-courier#5-get-ecourier-branch-list)
6. [Fetch Ecurier delivery package lsit](https://github.com/codeboxrcodehub/ecourier-courier#6-delivery-package-list)
7. [Create parcel](https://github.com/codeboxrcodehub/ecourier-courier#7-create-parcel)
8. [Parcel tracking](https://github.com/codeboxrcodehub/ecourier-courier#8-parcel-tracking)
## Requirements
- PHP >=7.4
- Laravel >= 6
## Installation
```bash
composer require codeboxr/ecourier-courier
```
### vendor publish (config)
```bash
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](http://www.php-fig.org/psr/psr-4/) coding standards.
- Read Ecourier API documentations first
## License
Ecourier package is licensed under the [MIT License](http://opensource.org/licenses/MIT).
Copyright 2022 [Codeboxr](https://codeboxr.com)