H5公共积分商城API文档

基础信息

基础路径: api/mall

请求方式: 全部为 POST

Content-Type: application/json

鉴权方式: 签名验证（mall.verify 中间件）

公共请求参数

所有接口请求体均需包含以下公共参数：

参数名	类型	必填	说明
ins_no	string	是	机构编号
version	string	是	版本号，固定 `1.0`
nonce	string	是	随机字符串，最大32位
sign	string	是	签名，最大64位
data	object	是	业务参数对象

签名规则

将请求参数中 data 内的字段按 key 进行字典排序

将完整参数（不含 sign）转为 JSON 字符串（不转义斜杠和中文）

sign = strtoupper(md5(ins_secret + json_string))

用户身份识别

需要用户身份的接口，data 中必须包含 ins_user_phone（用户手机号），中间件会自动通过手机号查询关联用户并注入 user_id。

公共响应格式

{
  "code": 200,
  "msg": "请求成功",
  "data": {}
}

分页响应格式

{
  "code": 200,
  "msg": "请求成功",
  "data": [],
  "pagination": {
    "total": 100,
    "per_page": 15,
    "last_page": 7,
    "current_page": 1
  }
}

1. 商品列表

路径: api/mall/commodity

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	否	用户手机号
type	int	否	类型：`3`=积分（默认） `1`=热销 `2`=推荐 `4`=秒杀 `5`=拼团
category_id	int	否	分类ID，默认 `0`
sort	int	否	排序：`0`=默认 `1`=价格正序 `2`=价格倒序 `3`=销量正序 `4`=销量倒序 `5`=积分正序 `6`=积分倒序
page	int	否	页码，默认 `1`
limit	int	否	每页条数，默认 `15`

请求示例

{
  "ins_no": "12345678",
  "version": "1.0",
  "nonce": "abc123def456",
  "sign": "A1B2C3D4E5F6...",
  "data": {
    "type": 3,
    "category_id": 0,
    "sort": 0,
    "page": 1,
    "limit": 15
  }
}

2. 商品详情

路径: api/mall/commodity_detail

方法: POST

请求参数（data）

参数名	类型	必填	说明
id	int	是	商品ID
type	int	否	类型：`1`=热销（默认） `2`=推荐 `3`=积分 `4`=秒杀 `5`=拼团
seckill_type	int	否	秒杀活动ID，默认 `0`

3. 商品分类

路径: api/mall/commodity_category

方法: POST

请求参数（data）

无业务参数，传空对象 {} 即可。

4. 钱包余额信息

路径: api/mall/wallet_info

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
id	int	否	钱包ID，不传则返回用户所有钱包

响应示例

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "user_id": 100,
      "wallet_id": 1,
      "balance": "500.00",
      "wallet_name": "积分钱包"
    }
  ]
}

5. 积分变动记录

路径: api/mall/change_log

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
id	int	是	钱包ID
page	int	否	页码，默认 `1`
limit	int	否	每页条数，默认 `15`

6. 收货地址列表

路径: api/mall/user_address_list

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号

响应示例

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "name": "张三",
      "phone": "138****1234",
      "area": "浙江省杭州市西湖区",
      "address": "XX路XX号",
      "is_default": 1
    }
  ]
}

7. 收货地址详情

路径: api/mall/user_address_info

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
id	int	是	地址ID

8. 新增/编辑/删除地址

路径: api/mall/user_address

方法: POST

说明: 通过 method 字段区分操作类型

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
method	string	否	操作类型：不传=新增 `PUT`=编辑 `DELETE`=删除
id	int	编辑/删除时必填	地址ID
name	string	新增/编辑时必填	收货人姓名
phone	string	新增/编辑时必填	收货人手机号
area	string	新增/编辑时必填	地区
address	string	新增/编辑时必填	详细地址
lat	string	否	纬度
long	string	否	经度
is_default	int	否	是否默认：`0`=否 `1`=是

请求示例（新增地址）

{
  "ins_no": "12345678",
  "version": "1.0",
  "nonce": "abc123def456",
  "sign": "A1B2C3D4E5F6...",
  "data": {
    "ins_user_phone": "13800001234",
    "name": "张三",
    "phone": "13800001234",
    "area": "浙江省杭州市西湖区",
    "address": "XX路XX号",
    "is_default": 1
  }
}

9. 设置默认地址

路径: api/mall/set_user_address_default

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
id	int	是	地址ID

10. 批量删除地址

路径: api/mall/del_user_address_more

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
ids	array	是	地址ID数组，如 `[1, 2, 3]`

11. 确认订单

路径: api/mall/confirm

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
commodity	array	是	商品列表

commodity 数组元素

参数名	类型	必填	说明
commodity_id	int	是	商品ID
commodity_item_id	int	是	规格ID
commodity_count	int	是	数量

12. 提交订单

路径: api/mall/submit

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
order_type	int	是	订单类型：`1`=普通 `2`=积分 `3`=预售 `4`=秒杀 `5`=拼团
pay_method	int	是	支付方式
user_address_id	int	是	收货地址ID（order_type 1-5时必填）
coupon_id	int	否	优惠券ID
is_shopping_cart	int	否	是否购物车下单：`0`=否 `1`=是
source_id	array	否	购物车ID数组
commodity	array	是	商品列表
remark	string	否	备注

响应示例

{
  "code": 200,
  "msg": "添加成功",
  "data": {
    "id": 1001,
    "order_no": "YP20260101120000XXXXXX",
    "price": "99.00",
    "status": 0
  },
  "order_id": 0
}

13. 订单支付

路径: api/mall/pay

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
order_id	int	是	订单ID

14. 可用积分钱包

路径: api/mall/integral_wallet

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号

15. 协议列表

路径: api/mall/agreement

方法: POST

请求参数（data）

无业务参数，传空对象 {} 即可。

16. 提现问题列表

路径: api/mall/withdraw_question_list

方法: POST

请求参数（data）

无业务参数，传空对象 {} 即可。

17. 验证支付密码

路径: api/mall/check_pay_password

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
pay_password	string	是	支付密码

18. 提现方式列表

路径: api/mall/withdraw_type_list

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号

19. 获取用户月累计提现金额

路径: api/mall/month_withdraw_amount

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
type	int	是	提现方式：`1`=微信 `2`=支付宝
amount	string	是	提现金额
wallet_type	int	是	钱包类型：`2`=赟余额 `3`=货款

响应示例

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "month_price": "1000.00",
    "is_sign": false
  }
}

20. 同意纳税协议

路径: api/mall/agree_tax_protocol

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
type	int	是	提现方式：`1`=微信 `2`=支付宝

21. 赟余额申请提现

路径: api/mall/yun_balances_apply

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
amount	string	是	提现金额

22. 赟余额提现规则

路径: api/mall/config_yun_balance_rule

方法: POST

请求参数（data）

无业务参数，传空对象 {} 即可。

响应示例

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "service_charge": 10,
    "other": "1",
    "charge_from": 2,
    "day_min": 1,
    "day_top": 100000,
    "day_times": 5
  }
}

23. 订单列表

路径: api/mall/order/list

方法: POST

请求参数（data）

参数名	类型	必填	说明
ins_user_phone	string	是	用户手机号
category	int	否	订单状态：`-1`=全部（默认） `0`=待付款 `1`=待发货 `2`=待收货 `3`=已完成
is_return	string	否	是否退款：`1`=是
page	int	否	页码，默认 `1`
limit	int	否	每页条数，默认 `15`

响应示例

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "sub_order_no": "SUB20260101XXXXXX",
      "commodity_name": "商品名称",
      "commodity_cover": "https://xxx.com/cover.jpg",
      "count": 1,
      "pay_price": "99.00",
      "status": 1,
      "status_text": "待发货",
      "return_status": 0,
      "return_status_text": "无退款",
      "order_type": 1
    }
  ],
  "pagination": {
    "total": 50,
    "per_page": 15,
    "last_page": 4,
    "current_page": 1
  }
}

H5公共积分商城API文档说明

H5公共积分商城API文档#

基础信息#

公共请求参数#

签名规则#

用户身份识别#

公共响应格式#

分页响应格式#

1. 商品列表#

请求参数（data）#

请求示例#

2. 商品详情#

请求参数（data）#

3. 商品分类#

请求参数（data）#

4. 钱包余额信息#

请求参数（data）#

响应示例#

5. 积分变动记录#

请求参数（data）#

6. 收货地址列表#

请求参数（data）#

响应示例#

7. 收货地址详情#

请求参数（data）#

8. 新增/编辑/删除地址#

请求参数（data）#

请求示例（新增地址）#

9. 设置默认地址#

请求参数（data）#

10. 批量删除地址#

请求参数（data）#

11. 确认订单#

请求参数（data）#

commodity 数组元素#

12. 提交订单#

请求参数（data）#

响应示例#

13. 订单支付#

请求参数（data）#

14. 可用积分钱包#

请求参数（data）#

15. 协议列表#

请求参数（data）#

16. 提现问题列表#

请求参数（data）#

17. 验证支付密码#

请求参数（data）#

18. 提现方式列表#

请求参数（data）#

19. 获取用户月累计提现金额#

请求参数（data）#

响应示例#

20. 同意纳税协议#

请求参数（data）#

21. 赟余额申请提现#

请求参数（data）#

22. 赟余额提现规则#

请求参数（data）#

响应示例#

23. 订单列表#

请求参数（data）#

响应示例#

H5公共积分商城API文档

基础信息

公共请求参数

签名规则

用户身份识别

公共响应格式

分页响应格式

1. 商品列表

请求参数（data）

请求示例

2. 商品详情

请求参数（data）

3. 商品分类

请求参数（data）

4. 钱包余额信息

请求参数（data）

响应示例

5. 积分变动记录

请求参数（data）

6. 收货地址列表

请求参数（data）

响应示例

7. 收货地址详情

请求参数（data）

8. 新增/编辑/删除地址

请求参数（data）

请求示例（新增地址）

9. 设置默认地址

请求参数（data）

10. 批量删除地址

请求参数（data）

11. 确认订单

请求参数（data）

commodity 数组元素

12. 提交订单

请求参数（data）

响应示例

13. 订单支付

请求参数（data）

14. 可用积分钱包

请求参数（data）

15. 协议列表

请求参数（data）

16. 提现问题列表

请求参数（data）

17. 验证支付密码

请求参数（data）

18. 提现方式列表

请求参数（data）

19. 获取用户月累计提现金额

请求参数（data）

响应示例

20. 同意纳税协议

请求参数（data）

21. 赟余额申请提现

请求参数（data）

22. 赟余额提现规则

请求参数（data）

响应示例

23. 订单列表

请求参数（data）

响应示例