codeboxr / ecourier-courier

孟加拉国 ecourier 服务 API 包

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

This package is auto-updated.

Last update: 2024-09-14 11:13:47 UTC


README

Ecourier 包裹服务 php/laravel 包

这是一个用于 Ecourier BD 快递系统的 Laravel/PHP 包。此包可以在 Laravel 或 Laravel/PHP 项目中使用。您可以使用此包进行无头/REST 实现,以及 blade 或常规模式开发。我们在此项目工作期间创建了此包,并希望将其发布,以便帮助所有人。此包可作为常规 php composer 包 提供。

特性

  1. 获取 Ecourier 交付/存储城市列表
  2. 获取 Ecourier 交付/存储 thana/upzilla 列表
  3. 获取 Ecourier 交付/存储邮编列表
  4. 获取 Ecourier 交付/存储邮编区域列表
  5. 获取 Ecourier 交付/存储分支机构列表
  6. 获取 Ecurier 交付包裹列表
  7. 创建包裹
  8. 包裹跟踪

要求

  • PHP >=7.4
  • Laravel >= 6

安装

composer require codeboxr/ecourier-courier

vendor publish (config)

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

发布配置文件后,设置您的凭证。您可以在配置目录中的 ecourier.php 文件中查看此信息。

"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", "")

设置 .env 配置

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

用法

1. 获取 Ecourier 交付城市列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

2. 获取 Ecourier 交付 thana/upzilla 列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

3. 获取 Ecourier 交付邮编列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

4. 获取 Ecourier 交付邮编区域列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

5. 获取 Ecourier 分支机构列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

6. 交付包裹列表

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

7. 创建包裹

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. 包裹跟踪

use Codeboxr\EcourierCourier\Facade\Ecourier;

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

贡献

欢迎为 Ecourier 包贡献。在提交您的拉取请求之前,请注意以下指南。

  • 遵循 PSR-4 编码标准。
  • 首先阅读 Ecourier API 文档

许可

Ecourier 包根据 MIT 许可 许可。

版权 2022 Codeboxr