独立站接入接口 API 文档
基本信息
- URL:
http://localhost:8788 - 线上环境:
http://47.90.217.242:8788 - 请求文档可参考:
http://47.90.217.242:8788/doc.html#/-v3-api-docs/%E5%85%AC%E5%85%B1%E6%8E%A5%E5%8F%A3/autosales - 接口路径:
/common/autosales - 请求方法:
POST - 接口摘要: 自动创建一条售后申请记录。
- 请求 DTO:
SalesDto
请求参数
请求头 (Headers)
| 名称 | 值 | 必填 | 说明 |
|---|---|---|---|
Content-Type | application/json | 是 | 指定请求体为 JSON 格式 |
请求体 (Body)
请求体为一个 JSON 对象,对应 SalesDto 数据传输对象。
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 申请人姓名 |
email | string | 是 | 电子邮箱 |
mobile | string | 否 | 手机号 |
orderId | string | 是 | 订单号 |
rating | integer | 是 | 评分(1-5星) |
feedback | string | 否 | 售后意见 |
userId | string | 是 | 店铺id,默认传 1,1 为admin店铺用户 |
响应
成功响应 (HTTP 200)
当售后申请成功创建时,返回以下 JSON 响应:
json
{
"code": 200,
"message": "成功",
"data": null
}错误响应
接口可能返回以下错误情况:
| HTTP 状态码 | code | message | 说明 |
|---|---|---|---|
| 200 | 40001 | 申请人姓名不能为空 | 请求体中 name 字段为空或未提供。 |
| 200 | 40002 | 电子邮箱不能为空 | 请求体中 email 字段为空或未提供。 |
| 200 | 40003 | 订单号不能为空 | 请求体中 orderId 字段为空或未提供。 |
| 200 | 50001 | 订单号已经存在,无需重复写入 | 提交的 orderId 在系统中已存在。 |
| 200 | 50002 | 自动创建售后申请失败 | 系统在保存售后申请记录时发生内部错误。 |
| 200 | 50002 | 自动创建售后申请失败: <具体异常信息> | 系统在处理请求时捕获到异常。 |
注意: 本接口遵循项目的统一响应格式
Result,所有响应(包括错误)的 HTTP 状态码均为200,具体的业务状态通过响应体中的code字段来区分。
请求示例
bash
curl -X 'POST' \
'http://localhost:8788/common/autosales' \
-H 'Content-Type: application/json' \
-d '{
"name": "张三",
"email": "zhangsan@example.com",
"mobile": "13800138000",
"orderId": "ORDER_123456",
"rating": 4,
"feedback": "商品质量很好,但物流稍慢。"
}'响应示例
成功
json
{
"code": 200,
"message": "成功",
"data": null
}订单号重复
json
{
"code": 50001,
"message": "订单号已经存在,无需重复写入",
"data": null
}