发货接口文档
一、接口名称
订单发货接口
二、接口描述
该接口用于商家对订单进行发货操作，支持自送和快递两种发货方式。发货后会更新订单状态，并调用微信小程序发货接口通知用户。
三、接口路径
http://ip:port/app/storeOrder.sendStoreOrderCart
四、请求方法
POST
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token Base token 通过登录接口获取token |
| app-id | 是 | String | 应用ID 系统dev账户分配 |
| transaction-id | 是 | String | 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间 YYYYMMDDhhmmss |
六、请求参数
6.1 请求体参数
| 参数名称 | 必填 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| orderId | 是 | String | 订单ID | ORD20230001 |
| shopId | 是 | String | 店铺ID | SHOP1001 |
| sendWay | 是 | String | 派送方式(SEFT:自送,OTHER:快递) | SEFT |
| cartId | 否 | String | 购物车ID(多个商品时使用) | CART1001 |
| userId | 否 | String | 操作人ID | USER1001 |
| solCompany | 条件必填 | String | 快递公司(当sendWay不为SEFT时必填) | 顺丰快递 |
| solNum | 条件必填 | String | 快递单号(当sendWay不为SEFT时必填) | SF123456789 |
| remark | 否 | String | 备注信息 | 请尽快送达 |
七、返回值
7.1 返回值结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | String | 返回码 0 成功 其他失败 |
| msg | String | 返回信息 |
| data | Object | 返回数据 |
八、业务逻辑说明
参数校验：
- 必填参数检查(orderId, shopId, sendWay)
- 当sendWay不为"SEFT"时，检查快递公司和快递单号
数据库操作：
- 更新购物车状态为"配送中"(STATE_SENDING)
- 保存购物车事件记录
- 更新订单状态为"待收货"(STATE_WAIT_RECIVE)
- 如果是快递方式，保存物流信息
微信通知：
- 调用微信小程序发货接口通知用户
九、示例请求
自送方式示例
{
"orderId": "ORD20230001",
"shopId": "SHOP1001",
"sendWay": "SEFT",
"userId": "USER1001"
}
快递方式示例
{
"orderId": "ORD20230002",
"shopId": "SHOP1001",
"sendWay": "OTHER",
"solCompany": "顺丰快递",
"solNum": "SF123456789",
"remark": "易碎品，请小心轻放",
"userId": "USER1001"
}
十、示例响应
成功响应
{
"code": "0",
"msg": "保存成功",
"data": null
}
失败响应
{
"code": "1",
"msg": "发货失败",
"data": null
}
十一、状态码说明
| 状态码 | 描述 |
|---|---|
| 0 | 操作成功 |
| 1 | 操作失败 |
| 1001 | 参数缺失(orderId) |
| 1002 | 参数缺失(shopId) |
| 1003 | 参数缺失(sendWay) |
| 1004 | 快递公司不能为空 |
| 1005 | 快递单号不能为空 |