205 lines
5.1 KiB
Markdown
205 lines
5.1 KiB
Markdown
|
# API Map
|
||
|
|
|
||
|
|
> 本文件列出项目所有 API 端点，帮助 AI 快速了解接口结构
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 认证 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| POST | `/api/auth/login` | 用户登录 |
|
||
|
|
| POST | `/api/auth/logout` | 用户登出 |
|
||
|
|
| GET | `/api/auth/me` | 获取当前用户 |
|
||
|
|
| POST | `/api/auth/refresh` | 刷新 Token |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 用户 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/users` | 获取用户列表 |
|
||
|
|
| GET | `/api/users/:id` | 获取用户详情 |
|
||
|
|
| POST | `/api/users` | 创建用户 |
|
||
|
|
| PUT | `/api/users/:id` | 更新用户 |
|
||
|
|
| DELETE | `/api/users/:id` | 删除用户 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 商品 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/products` | 获取商品列表 |
|
||
|
|
| GET | `/api/products/:id` | 获取商品详情 |
|
||
|
|
| POST | `/api/products` | 创建商品 |
|
||
|
|
| PUT | `/api/products/:id` | 更新商品 |
|
||
|
|
| DELETE | `/api/products/:id` | 删除商品 |
|
||
|
|
| POST | `/api/products/publish` | 发布商品到平台 |
|
||
|
|
| GET | `/api/products/published` | 获取已发布商品列表 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 订单 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/orders` | 获取订单列表 |
|
||
|
|
| GET | `/api/orders/:id` | 获取订单详情 |
|
||
|
|
| PUT | `/api/orders/:id/status` | 更新订单状态 |
|
||
|
|
| POST | `/api/orders/sync` | 同步订单 |
|
||
|
|
| GET | `/api/orders/profit` | 订单利润分析 |
|
||
|
|
| POST | `/api/orders` | 创建内部订单 |
|
||
|
|
| POST | `/api/orders/:id/pay` | 处理订单支付 |
|
||
|
|
| POST | `/api/orders/:id/cancel` | 取消订单 |
|
||
|
|
| GET | `/api/orders/stats` | 获取订单统计 |
|
||
|
|
| GET | `/api/orders/stats/detailed` | 获取详细订单统计 |
|
||
|
|
|
||
|
|
## 退款 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| POST | `/api/refunds` | 申请退款 |
|
||
|
|
| PUT | `/api/refunds/:id/approve` | 审批退款 |
|
||
|
|
| GET | `/api/refunds` | 获取退款列表 |
|
||
|
|
| GET | `/api/refunds/:id` | 获取退款详情 |
|
||
|
|
|
||
|
|
## 售后 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| POST | `/api/after-sales` | 申请售后 |
|
||
|
|
| PUT | `/api/after-sales/:id/process` | 处理售后申请 |
|
||
|
|
| GET | `/api/after-sales` | 获取售后列表 |
|
||
|
|
| GET | `/api/after-sales/:id` | 获取售后详情 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 库存 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/inventory` | 获取库存列表 |
|
||
|
|
| GET | `/api/inventory/:skuId` | 获取 SKU 库存 |
|
||
|
|
| PUT | `/api/inventory/:skuId` | 更新库存 |
|
||
|
|
| POST | `/api/inventory/adjust` | 库存调整 |
|
||
|
|
| GET | `/api/inventory/aging` | 库存老化分析 |
|
||
|
|
| GET | `/api/inventory/forecast` | 库存预测 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 财务 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/finance/reconciliation` | 财务对账 |
|
||
|
|
| GET | `/api/finance/reconciliation/:id` | 对账详情 |
|
||
|
|
| POST | `/api/finance/reconciliation/sync` | 同步对账数据 |
|
||
|
|
| GET | `/api/finance/currency` | 多币种对账 |
|
||
|
|
| GET | `/api/finance/platform-fees` | 平台费用监控 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 支付 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| POST | `/api/payments` | 创建支付订单 |
|
||
|
|
| GET | `/api/payments/:id` | 获取支付详情 |
|
||
|
|
| GET | `/api/payments/:id/status` | 获取支付状态 |
|
||
|
|
| POST | `/api/payments/callback` | 处理支付回调 |
|
||
|
|
| POST | `/api/payments/:id/refund` | 申请退款 |
|
||
|
|
| GET | `/api/payments/reconciliation` | 支付对账 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 供应商 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/suppliers` | 获取供应商列表 |
|
||
|
|
| GET | `/api/suppliers/:id` | 获取供应商详情 |
|
||
|
|
| POST | `/api/suppliers` | 创建供应商 |
|
||
|
|
| PUT | `/api/suppliers/:id` | 更新供应商 |
|
||
|
|
| GET | `/api/suppliers/:id/capacity` | 供应商产能监控 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 物流 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/logistics/carriers` | 获取物流商列表 |
|
||
|
|
| GET | `/api/logistics/tracking/:orderId` | 物流追踪 |
|
||
|
|
| POST | `/api/logistics/ship` | 创建发货 |
|
||
|
|
| GET | `/api/logistics/health` | 物流健康状态 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 采集 API (Extension)
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| POST | `/api/collect/start` | 开始采集 |
|
||
|
|
| GET | `/api/collect/status/:taskId` | 采集状态 |
|
||
|
|
| POST | `/api/collect/batch` | 批量采集 |
|
||
|
|
| GET | `/api/collect/products` | 获取采集商品 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 客户 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/customers` | 获取客户列表 |
|
||
|
|
| GET | `/api/customers/:id` | 客户详情 |
|
||
|
|
| PUT | `/api/customers/:id` | 更新客户 |
|
||
|
|
| GET | `/api/customers/:id/orders` | 客户订单 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 建议 API
|
||
|
|
|
||
|
|
| 方法 | 端点 | 说明 |
|
||
|
|
|------|------|------|
|
||
|
|
| GET | `/api/advices` | 获取建议列表 |
|
||
|
|
| GET | `/api/advices/:id` | 建议详情 |
|
||
|
|
| PUT | `/api/advices/:id/status` | 更新建议状态 |
|
||
|
|
| POST | `/api/advices/:id/execute` | 执行建议 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 通用响应格式
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
// 成功响应
|
||
|
|
{
|
||
|
|
"success": true,
|
||
|
|
"data": { ... }
|
||
|
|
}
|
||
|
|
|
||
|
|
// 错误响应
|
||
|
|
{
|
||
|
|
"success": false,
|
||
|
|
"error": "错误信息"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 状态码
|
||
|
|
|
||
|
|
| 状态码 | 说明 |
|
||
|
|
|--------|------|
|
||
|
|
| 200 | 成功 |
|
||
|
|
| 400 | 请求参数错误 |
|
||
|
|
| 401 | 未授权 |
|
||
|
|
| 403 | 禁止访问 |
|
||
|
|
| 404 | 资源不存在 |
|
||
|
|
| 500 | 服务器错误 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
*本文件帮助 AI 快速了解 API 接口结构*
|