查询店铺订单接口文档
一、接口名称
查询店铺订单
二、接口描述
该接口用于查询店铺订单信息，支持分页查询，并可筛选不同订单状态。返回结果包含订单基本信息及关联的商品信息。
三、接口路径
http://{ip}:{port}/app/storeOrder.queryStoreOrder
四、请求方法
GET
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token，通过登录接口获取 |
| app-id | 是 | String | 应用ID，由系统分配 |
| transaction-id | 是 | String | 请求流水号，格式：1000000000+YYYYMMDDhhmmss+6位序列 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间，格式：YYYYMMDDhhmmss |
六、请求参数
6.1 查询参数
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
| page | 否 | Integer | 当前页码（默认1） | 1 |
| row | 否 | Integer | 每页记录数（默认10） | 10 |
| states | 否 | String | 订单状态（多个状态用逗号分隔） | "1000,2000" |
| orderId | 否 | String | 订单ID | "123456" |
| storeId | 否 | String | 店铺ID | "1001" |
| userId | 否 | String | 用户ID | "2001" |
七、返回值
7.1 响应格式
JSON
7.2 响应状态码
- 200：请求成功
- 400：参数错误
- 500：服务器内部错误
7.3 响应数据结构
| 字段 | 类型 | 描述 |
|---|---|---|
| code | Integer | 返回码（0=成功，非0=失败） |
| msg | String | 返回信息 |
| data | Object | 返回数据 |
| data.total | Integer | 总记录数 |
| data.records | Integer | 当前页记录数 |
| data.list | List<StoreOrderDto> | 订单列表 |
StoreOrderDto 结构
| 字段 | 类型 | 描述 |
|---|---|---|
| orderId | String | 订单ID |
| storeId | String | 店铺ID |
| userId | String | 用户ID |
| state | String | 订单状态 |
| cartType | String | 购物车类型 |
| storeOrderCartDtos | List<StoreOrderCartDto> | 订单商品列表 |
StoreOrderCartDto 结构
| 字段 | 类型 | 描述 |
|---|---|---|
| cartId | String | 购物车ID |
| orderId | String | 订单ID |
| productId | String | 商品ID |
| quantity | Integer | 商品数量 |
| price | BigDecimal | 商品单价 |
八、示例请求
GET /app/storeOrder.queryStoreOrder?page=1&row=10&states=1000,2000&storeId=1001
Headers:
Authorization: Bearer xxxxxx
app-id: mall-app
transaction-id: 100000000020231001123456000001
sign: xxxxxx
req-time: 20231001123456
九、示例响应
{
"code": 0,
"msg": "成功",
"data": {
"total": 5,
"records": 2,
"list": [
{
"orderId": "123456",
"storeId": "1001",
"userId": "2001",
"state": "1000",
"cartType": "normal",
"storeOrderCartDtos": [
{
"cartId": "cart001",
"orderId": "123456",
"productId": "p1001",
"quantity": 2,
"price": 99.99
}
]
}
]
}
}
十、业务逻辑说明
- 分页查询：支持按页码和每页记录数查询订单。
- 状态筛选：可传入
states参数（如"1000,2000"）筛选不同状态的订单。 - 关联商品查询：返回的订单数据包含关联的商品信息（
storeOrderCartDtos）。 - 数据转换：请求参数自动转换为
StoreOrderDto对象进行查询。
十一、数据库操作
- 查询订单：调用
IStoreOrderInnerServiceSMO.queryStoreOrders获取订单列表。 - 查询订单商品：调用
IStoreOrderCartInnerServiceSMO.queryStoreOrderCarts获取订单关联的商品信息。
该文档符合 RESTful API 规范，适用于前端或第三方系统调用。