查询店铺订单地址接口文档
一、接口名称
查询店铺订单地址
二、接口描述
根据 店铺ID（shopId） 和 订单ID（orderId） 查询店铺订单的收货地址信息，支持分页查询。
三、接口路径
http://{ip}:{port}/app/storeOrder.queryStoreOrderAddress
四、请求方法
GET
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token（Base token，通过登录接口获取） |
| app-id | 是 | String | 应用ID（系统dev账户分配） |
| transaction-id | 是 | String | 请求流水号（不能重复，格式：1000000000+YYYYMMDDhhmmss+6位序列） |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间（YYYYMMDDhhmmss） |
六、请求参数
6.1 查询参数（Query Parameters）
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| shopId | 是 | String | 店铺ID |
| orderId | 是 | String | 订单ID |
| page | 否 | Integer | 当前页码（默认1） |
| row | 否 | Integer | 每页记录数（默认10） |
七、返回值
7.1 响应格式
JSON
7.2 状态码
- 200：请求成功
- 400：参数校验失败（如缺少必填参数）
- 500：服务器内部错误
7.3 响应数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | String | 返回码（0 表示成功，非 0 表示失败） |
| msg | String | 返回信息 |
| data | Object | 返回数据 |
| data.total | Integer | 总记录数 |
| data.records | List<StoreOrderAddressDto> | 订单地址列表 |
StoreOrderAddressDto 结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| shopId | String | 店铺ID |
| orderId | String | 订单ID |
| addressId | String | 地址ID |
| consignee | String | 收货人姓名 |
| phone | String | 收货人电话 |
| address | String | 详细地址 |
| province | String | 省份 |
| city | String | 城市 |
| district | String | 区/县 |
| street | String | 街道 |
| postCode | String | 邮政编码 |
八、示例请求
请求示例（GET）
GET /app/storeOrder.queryStoreOrderAddress?shopId=123456&orderId=789012&page=1&row=10
请求头示例
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
app-id: mall-app-001
transaction-id: 100000000020231015143456000001
sign: 1a2b3c4d5e6f7g8h9i0j
req-time: 20231015143456
九、示例响应
成功响应（200）
{
"code": "0",
"msg": "成功",
"data": {
"total": 1,
"records": [
{
"shopId": "123456",
"orderId": "789012",
"addressId": "addr001",
"consignee": "张三",
"phone": "13800138000",
"address": "北京市海淀区中关村大街1号",
"province": "北京市",
"city": "北京市",
"district": "海淀区",
"street": "中关村大街",
"postCode": "100080"
}
]
}
}
失败响应（400 - 参数缺失）
{
"code": "400",
"msg": "未包含商铺ID",
"data": null
}
十、业务逻辑说明
- 参数校验：检查
shopId和orderId是否为空。 - 分页查询：调用
IStoreOrderAddressInnerServiceSMO查询订单地址列表及总数。 - 返回结果：封装分页数据（当前页、总页数、记录列表）。
十一、数据库操作
- 查询
store_order_address表，按shopId和orderId筛选数据。 - 使用
page和row进行分页计算。
这样符合 RESTful API 规范，并提供了完整的请求、响应示例及业务逻辑说明。