HC小区接口文档

查询订单购物车信息接口文档

一、接口名称

查询订单购物车信息

二、接口描述

该接口用于查询门店订单购物车信息,包括商品规格详情和封面图片等信息

三、接口路径

http://ip:port/app/storeOrder.queryStoreOrderCart

四、请求方法

GET

五、请求头

参数名称 必填 类型 描述
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 查询参数

参数名称 必填 类型 描述
shopId String 门店编号
link String 用户手机号(与personId二选一)
personId String 用户ID(与link二选一)
states String 订单状态,多个状态用逗号分隔
page Integer 页码,默认为1
row Integer 每页记录数,默认为10

七、返回值

7.1 返回值结构

参数名称 类型 描述
code String 返回码 0 成功 其他失败
msg String 返回信息
data Object 返回数据

7.2 data对象结构

参数名称 类型 描述
records Integer 总记录数
total Integer 总页数
rows List 订单购物车数据列表

7.3 StoreOrderCartDto结构

参数名称 类型 描述
cartId String 购物车ID
productId String 商品ID
specId String 规格ID
cartType String 购物车类型
coverPhoto String 商品封面图片URL
productSpecDetails List 商品规格详情列表

7.4 ProductSpecDetailDto结构

参数名称 类型 描述
specId String 规格ID
specName String 规格名称
specValue String 规格值

八、示例请求

GET http://ip:port/app/storeOrder.queryStoreOrderCart?shopId=123456&link=13800138000&page=1&row=10

九、示例响应

{
  "code": "0",
  "msg": "成功",
  "data": {
    "records": 15,
    "total": 2,
    "rows": [
      {
        "cartId": "1001",
        "productId": "P001",
        "specId": "S001",
        "cartType": "1",
        "coverPhoto": "http://domain.com/images/cover1.jpg",
        "productSpecDetails": [
          {
            "specId": "S001",
            "specName": "颜色",
            "specValue": "红色"
          },
          {
            "specId": "S001",
            "specName": "尺寸",
            "specValue": "XL"
          }
        ]
      },
      {
        "cartId": "1002",
        "productId": "P002",
        "specId": "S002",
        "cartType": "1",
        "coverPhoto": "http://domain.com/images/cover2.jpg",
        "productSpecDetails": [
          {
            "specId": "S002",
            "specName": "颜色",
            "specValue": "蓝色"
          }
        ]
      }
    ]
  }
}

十、业务逻辑说明

  1. 参数验证:验证必填参数shopId和分页参数
  2. 用户信息转换:如果传入了link(手机号),会查询对应的用户ID
  3. 状态处理:states参数会被转换为数组形式
  4. 数据查询:调用IStoreOrderCartInnerServiceSMO查询订单购物车数据
  5. 数据补充:
    • 查询商品规格详情并填充到结果中
    • 查询商品封面图片URL并填充到结果中
  6. 分页处理:计算总页数并返回分页结果

十一、注意事项

  1. link和personId参数只需传入一个即可
  2. states参数支持多个状态查询,用逗号分隔
  3. 返回的图片URL会根据配置自动拼接完整路径