kodano / module-promotions
管理促销活动的 Magento 2 模块。
1.0.1
2024-09-06 14:29 UTC
Requires
- php: >=8.1
- magento/framework: *
README
概述
为 Magento 2 提供促销管理和相关组功能。该模块允许您通过 REST API 与促销和促销组交互,提供列出、添加和删除数据的操作。API 响应以 JSON 格式返回,并集成到 Magento 的默认 Swagger 用于 API 文档和测试。
功能
- 管理促销活动:创建、列出和删除促销活动。
- 管理促销组:创建、列出和删除促销组。
- 关联:将多个促销活动链接到多个组。
- REST API:通过 RESTful 端点访问和管理促销活动和促销组。
- Swagger 集成:通过 Magento 的默认 Swagger 文档测试和交互 API。
安装
1. 通过 app/code
目录安装
-
克隆仓库
git clone https://github.com/AlexTs556/magento2-promotions.git
-
将模块复制到您的 Magento 安装中
cp -R magento2-promotions/ <Magento_Root>/app/code/Kodano/Promotions/
-
启用模块
php bin/magento setup:upgrade php bin/magento setup:di:compile
2. 通过 Composer 安装
-
将仓库添加到您的
composer.json
composer require kodano/module-promotions
-
启用模块
php bin/magento setup:upgrade php bin/magento setup:di:compile
用法
安装完成后,您可以通过 Magento 的 Swagger UI 访问促销 API。可用的 API 端点是
- 列出促销活动:
GET /V1/promotions
- 添加促销活动:
POST /V1/promotions
- 删除促销活动:
DELETE /V1/promotions/:promotionId
- 列出促销组:
GET /V1/promotion-groups
- 添加促销组:
POST /V1/promotion-groups
- 删除促销组:
DELETE /V1/promotion-groups/:groupId
您可以使用 Swagger UI 测试和交互这些端点,Swagger UI 可在您的 Magento 管理面板的 /swagger
中访问。
API 文档
API 文档通过 Magento 的默认 Swagger 界面提供。导航到您的 Magento 管理面板中的 /swagger
以查看和测试可用的端点。
支持
如果您遇到任何问题或需要支持,请在此GitHub 仓库中创建一个问题。