retail-cosmos / trx-mall-upload-sales-data-api
这是一个Laravel包,提供通过API上传销售数据到TRX商城的功能
v1.0.7
2024-04-29 12:58 UTC
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.8
- illuminate/contracts: ^10.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- larastan/larastan: ^2.0.1
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.8
- orchestra/testbench: ^8.8
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
README
TRX商城上传销售数据API是一个Laravel包,用于通过API上传销售数据到TRX商城。
安装
- 通过composer安装包
composer require retail-cosmos/trx-mall-upload-sales-data-api
- 发布配置文件
php artisan vendor:publish --tag="trx-mall-upload-sales-data-api-config"
- 阅读配置文件选项并相应地设置
.env
变量。
使用
- 您需要在Laravel应用程序中添加代码以与包共享销售数据。需要添加相同的服务类。我们提供了一个命令来生成类的选项
php artisan vendor:publish --tag="trx-mall-upload-sales-data-api-service"
-
在
app/Services/TrxMallUploadSalesDataApiService.php
中添加了一个新类。它包含一些方法来根据需求返回商店和销售数据。您可以通过更改代码使这些方法动态。您可以通过检查此存根文件进行未来参考。 -
在您的Laravel项目中添加一个调度器,每天午夜调用命令
trx:send-sales
。它发送每个商店前一天的销售数据。
$schedule->command('trx:send-sales')->daily();
注意
- 默认情况下,销售命令发送每个商店前一天的销售数据。如果您想发送特定日期/商店的销售数据,您可以将以下选项传递给命令
--date
- 发送特定日期销售数据的Y-m-d(2024-12-31)格式。--store_identifier
- 仅发送特定商店的销售数据。请查看存根文件以获取商店标识符。
示例
php artisan trx:send-sales --date=2024-11-31 --store_identifier=store1
- 如果您已设置相应的.env变量,此包在成功/失败尝试将销售数据发送到TRX后发送通知电子邮件。如果您想自定义通知电子邮件,可以运行以下命令
php artisan vendor:publish --tag="trx-mall-upload-sales-data-api-view"
- 该包根据
.env
文件中的TRX_MALL_DATE_OF_FIRST_SALES_UPLOAD
计算销售数据的'批ID'。它找到TRX_MALL_DATE_OF_FIRST_SALES_UPLOAD
指定的日期与您尝试发送销售数据的日期之间的差异,并将其加一。例如,如果TRX_MALL_DATE_OF_FIRST_SALES_UPLOAD
设置为2024-01-10
,并且您尝试发送2024-01-20
的销售数据,则批ID将为'11'。
测试
composer test
变更日志
请参阅CHANGELOG以获取有关最近更改的更多信息。
贡献
请参阅CONTRIBUTING以获取详细信息。
安全漏洞
请参阅我们的安全策略以了解如何报告安全漏洞。
致谢
许可证
MIT许可。更多信息请参阅许可文件。