codeboxr/redx-courier

孟加拉国 Redx 快递服务 API 包

v1.0.2 2024-05-28 05:55 UTC

This package is auto-updated.

Last update: 2024-09-28 06:41:22 UTC


README

Redx Courier 孟加拉国

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

功能

  1. 获取 Redx 配送区域列表
  2. 创建新店铺
  3. 店铺列表
  4. 店铺详情
  5. 创建新包裹
  6. 包裹详情
  7. 包裹追踪

要求

  • PHP >=7.2
  • Laravel >= 6

安装

composer require codeboxr/redx-courier

vendor publish (配置)

php artisan vendor:publish --provider="Codeboxr\RedxCourier\RedxCourierServiceProvider"

发布配置文件后,设置您的凭据。您可以在配置目录下的 redx.php 文件中看到它。

 "sandbox"      => env("REDX_SANDBOX", false),
 "access_token" => env("REDX_ACCESS_TOKEN", ""),

设置 .env 配置

REDX_SANDBOX=true // for production mode use false
REDX_ACCESS_TOKEN=""

使用方法

1. 获取 redx 配送区域列表

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::area()->list();

2. 创建新店铺

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::store()
                        ->create([
                           "name"    => "", //store name
                           "phone"   => "", //store contact person 
                           "area_id" => "",
                           "address" => "",
                        ]);

3. 获取店铺列表

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::store()->list();

4. 店铺详情

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::store()->storeDetails($storeId);

5. 创建新包裹

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::order()
                        ->create([
                            "customer_name"          => "", 
                            "customer_phone"         => "",
                            "delivery_area"          => "", // delivery area name
                            "delivery_area_id"       => "", // area id
                            "customer_address"       => "", 
                            "merchant_invoice_id"    => "",
                            "cash_collection_amount" => "",
                            "parcel_weight"          => "", //parcel weight in gram
                            "instruction"            => "",
                            "value"                  => "", //compensation amount
                            "pickup_store_id"        => "", // store id
                            "parcel_details_json"    => ""
                        ]);

6. 获取订单详情

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::order()->orderDetails($trackingId); // After successfully create order they given a tracking_id

7. 订单追踪

use Codeboxr\RedxCourier\Facade\RedxCourier

return RedxCourier::order()->tracking($trackingId); // After successfully create order they given a tracking_id

贡献

欢迎为 Redx 包做出贡献。在提交 pull request 之前,请注意以下指南。

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

许可证

Redx 包根据 MIT 许可证 许可。

版权所有 2022 Codeboxr