codeboxr / pathao-courier
孟加拉国 Pathao 快递服务 API 包
1.0.3
2023-09-20 12:47 UTC
Requires
- php: ^7.2|^7.3|^8.0|^8.1
- guzzlehttp/guzzle: ^7.0.1
- illuminate/support: ~6|~7|~8
README
Pathao Courier 孟加拉国
这是一个用于 Pathao BD 快递系统的 Laravel/PHP 包。此包可以在 laravel 或无 laravel/php 项目中使用。您可以用于无头/rest 实现以及 blade 或常规模式开发。我们在工作于一个项目时创建了此包,并认为将其发布以供所有人使用,以便它能有所帮助。此包作为常规 php composer 包 提供。
特性
要求
- PHP >=7.4
- Laravel >= 6
安装
composer require codeboxr/pathao-courier
vendor publish (config)
php artisan vendor:publish --provider="Codeboxr\PathaoCourier\PathaoCourierServiceProvider"
发布配置文件后,设置您的凭据。您可以在配置目录的 pathao.php 文件中看到此操作。
"sandbox" => env("PATHAO_SANDBOX", false), // for sandbox mode use true
"client_id" => env("PATHAO_CLIENT_ID", ""),
"client_secret" => env("PATHAO_CLIENT_SECRET", ""),
"username" => env("PATHAO_USERNAME", ""),
"password" => env("PATHAO_PASSWORD", "")
设置 .env 配置
PATHAO_SANDBOX=true // for production mode use false
PATHAO_CLIENT_ID=""
PATHAO_CLIENT_SECRET=""
PATHAO_USERNAME=""
PATHAO_PASSWORD=""
使用方法
1. 获取 Pathao 交货城市列表
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::area()->city();
2. 获取 Pathao 区域列表
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::area()->zone($cityId); // City ID
3. 获取 Pathao 交货区域列表
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::area()->area($zoneId); // Zone ID
4. 创建新商店
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::store()
->create([
"name" => "", // Store Name
"contact_name" => "", // Store contact person name
"contact_number" => "", // Contact person number
"address" => "", // Store address
"secondary_contact" => "", // Contact person secondary number not mandatory
"city_id" => "", // Find in city method
"zone_id" => "", // Find in zone method
"area_id" => "", // Find in Area method
]);
5. 获取商店列表
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::store()->list();
6. 创建新包裹
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::order()
->create([
"store_id" => "", // Find in store list,
"merchant_order_id" => "", // Unique order id
"recipient_name" => "", // Customer name
"recipient_phone" => "", // Customer phone
"recipient_address" => "", // Customer address
"recipient_city" => "", // Find in city method
"recipient_zone" => "", // Find in zone method
"recipient_area" => "", // Find in Area method
"delivery_type" => "", // 48 for normal delivery or 12 for on demand delivery
"item_type" => "", // 1 for document,
2 for parcel
"special_instruction" => "",
"item_quantity" => "", // item quantity
"item_weight" => "", // parcel weight
"amount_to_collect" => "", // amount to collect
"item_description" => "" // product details
]);
7. 获取订单详情
use Codeboxr\PathaoCourier\Facade\PathaoCourier
return PathaoCourier::order()->orderDetails($consignmentId); // After successfully create order they given a consignment_id
贡献
欢迎为 Pathao 包做出贡献。在提交拉取请求之前,请注意以下指导原则。
- 遵循 PSR-4 编码标准。
- 首先阅读 Pathao API 文档
许可证
Pathao 包采用 MIT 许可证。
版权所有 2022 Codeboxr