---
title: api1
description: 文本抽取：知识库/02-商城交易私域场景/ECshopex开源资料/api1
updated: 2026-11-04
tags: [原始文档, 抽取, 知识库]
source: 知识库/02-商城交易私域场景/ECshopex开源资料/api1
source_type: txt
source_hash: 0fd589ddf2ce
extracted_at: 2026-11-04
quality: ok
---

---
source: 知识库/02-商城交易私域场景/ECshopex开源资料/api1.html
type: html
size_kb: 2835
category: 02-商城交易私域场景
quality: ok
---

商城前端调用接口【1.0】
IconCreated with Sketch.
YAPI 接口文档
YApi
公共分类
获取提现方式列表
获取支付配置信息列表
获取汇付版本状态
卡券包
当前用户获取等级卡券包
得到的卡券包中卡券信息
未读已领卡券列表
确认已读已领卡券列表
领取卡券包
Adapay
新建分销员认证信息
更新分销员认证信息
获取分销员认证信息
腾讯广告
腾讯广告保留click_id
获取腾讯广告数据上报所需参数
企业
获取单个微信门店详情
企业微信，小程序登录
商城站点信息 - 获取
批量获取文章点赞数量和点赞状态
文章关注
文章关注总数量
文章列表
文章点赞
文章点赞总数
文章点赞验证
文章详情
商城协议 - 获取
获取启用物流公司列表
获取启用物流公司列表
获取商城配置信息
获取微信门店列表
获取文章栏目列表
获取文章的所有省份列表
获取最近门店
获取评价状态
获取配置外部链接
获取非自提无店铺开关状态
获取默认货币配置
售后
创建售后单
售后关闭
售后提醒内容获取
售后消费者回寄
获取售后单列表
获取售后单详情
获取售后原因列表
获取售后商品价格
获取退款单
社区活动
创建社区数据[此接口暂时不可用]
获取定位最近的社区
获取活动列表【该接口暂不可用】
获取活动商品的销量
获取活动商品详情及活动详情
获取活动详情及活动商品列表
获取社区列表
获取社区团长详情
储值
储值兑换积分
充值
充值-新
充值总金额
获取储值协议
获取充值列表
获取充值面额规则
系统
上传图片
上传图片至OSS
获取上传图片token
获取地址
统计
统计浏览人数
汇付天下
保存汇付取现银行卡
分销员入驻
获取汇付取现银行卡
获取汇付取现银行卡多条
获取经销商入驻信息
解绑删除汇付取现银行卡
IM
获取一洽配置
获取店铺美洽配置
获取美洽配置
评论
创建评论
获取评论列表
会员
地址详情
H5刷新Token
会员地址列表
会员心愿单收藏数量
会员收藏商品列表
会员收藏商品数量
会员收藏店铺列表
会员收藏店铺数量
会员收藏心愿单列表
会员收藏心愿单详情
会员绑定
保存商品浏览记录
修改会员信息
修改会员信息（不使用通用的验证规则）
修改发票信息
修改密码
修改收货地址
创建会员
删除发票
删除地址
删除收藏商品
删除收藏店铺
删除收藏心愿单
发票详情
商品缺货通知订阅
地区列表(废弃)
会员发票列表
是否收藏店铺
更新会员手机号
添加发票信息
添加心愿单商品
添加收藏商品
添加收藏店铺
添加收货地址
用户登陆
绑定导购
获取POS会员基础信息
获取会员优惠券、积分、收藏商品数量
获取会员信息
获取会员可编辑信息
获取会员注册协议
获取会员注册项
获取会员白名单设置
获取信任登录传参信息
获取商品浏览记录
获取图片验证码
获取手机短信验证码
获取授权手机号-仅支持微信
获取授权手机号-仅支持微信
获取条形码/二维码
获取第三方登录配置列表
获取订阅列表
记录导购被访问的UV
订单
获取权益核销码
修改购物车促销
修改购物车商品数量(批量)
修改购物车选中状态
创建订单
创建订单
删除疫情登记信息
多店铺购物车列表
支付结果查询
物流查询
用户回复评价
用户评价
申请开票
疫情登记信息
疫情登记所需信息
确认发货
绑定订单
统计订单数量
统计订单数量和权益核销数量
获取JsPayConfig
获取会员购物车商品数量
获取商品评价列表
获取小程序微信支付，天工支付需要的参数
获取支付单详情
获取支付需要的参数， 积分以及预存款直接扣除
获取权益列表
修改购物车商品数量(单一)
获取权益核销记录列表
获取权益详情
获取点赞状态
获取用户拼团订单列表
获取用户拼团订单详情
获取用户订单列表
获取用户订单发票列表
获取自提码
获取自提订单提货码
获取订单优惠以及运费信息
获取订单详情
获取订单详情
获取评价详情
获取评论回复列表
获取配置信息保存
订单发货单列表
订单发货单详情
订单取消
评价点赞
评价点赞总数
评价点赞验证
购物车中选择加价购商品
购物车列表
购物车删除
购物车增加
营销
获取商品的组合商品列表
会员领取付费会员卡
参与砍价日志
参与砍价活动
参与转盘抽奖
取消会员秒杀资格
填写抽奖订单收货地址(废弃)
抽奖下单(废弃)
抽奖规则(废弃)
抽奖订单物流查询(废弃)
抽奖轮播图展示(废弃)
检查会员是否中奖(废弃)
登陆赠送抽奖次数
确认收货抽奖订单(废弃)
获取会员签到记录列表
获取促销商品列表
获取到秒杀商品的资格
获取加价购商品列表
获取参与抽奖订单列表(废弃)
获取商品促销活动列表(废弃)
获取商品历史中奖者列表(废弃)
保存小程序formid
获取大转盘配置
获取抽奖活动列表(废弃)
获取抽奖活动详情(废弃)
获取抽奖订单详情(废弃)
获取拼团活动列表
获取指定商品的活动信息
获取某个抽奖活动的中奖者详情(废弃)
获取某个抽奖活动的开奖逻辑信息(废弃)
获取某个抽奖活动的所有参与列表(废弃)
获取注册引导营销配置
获取猜你喜欢商品列表
获取用户参加砍价活动详情
获取用户自己参与的所有抽奖活动(废弃)
获取用户自己的某个活动参与订单列表(废弃)
获取砍价分享小程序码
获取砍价活动列表
获取秒杀活动列表
获取秒杀活动详情
获取组合商品的基础信息
记录会员签到
卡券
获取付费会员等级卡详情(废弃)
使用兑换卡券
用户使用优惠券
用户删除已领取的卡券
用户核销卡券
用户领取卡券
获取POS卡券列表
获取付费会员信息
获取付费会员等级卡列表
获取付费会员等级卡列表
我的优惠券列表
获取兑换卡券使用信息
获取卡券列表
获取卡券详情
获取用户已领取的优惠券列表
获取用户已领取的优惠券列表
获取用户已领取的优惠券详情
获取用户已领取的优惠券详情
获取等级列表
购买付费会员折扣卡
分销推广
获取任务制佣金统计
会员成为推广员
删除推广员关联的商品
推广员佣金提现申请
推广员佣金提现申请列表
推广员佣金统计
推广员返佣积分统计
推广员首页数据
更新推广员信息
关联推广员关联的商品
获取任务制佣金记录
获取店招默认封面图
获取推广二维码
获取推广员2级下线
获取推广员佣金列表
获取推广员关联的商品
获取推广员基本信息
获取推广员小程序码
获取设置虚拟店首页模板
积分商城
扫条形码加入购物车
获取分类列表
获取分类子分类
获取商品列表
获取商品收藏情况
获取商品详情
获取指定等级分类列表
获取猜你喜欢商品列表
获取积分商城设置
导购
导购员购物车扫码新增
会员发起投诉导购员
会员绑定与导购员之间的关系
会员获取导购员信息
会员获取导购员信息
会员获取投诉列表
会员获取投诉详情
修改购物车选中状态
关系延续埋点
大屏端签到验证
完成导购任务分享
会员查看与导购员之间的关系
导购员购物车新增
扫条形码加入购物车
提交子任务参数
获取会员订单列表
获取会员订单详情
获取导购员促销单
获取导购员购物车
获取导购店铺列表
获取导购签到二维码
获取导购购物车商品数量
验证导购员的店铺id是否有效
报名
报名提交
获取所有记录的日期列表
获取指定报名日志
获取指定报名日志
获取指定报名活动
获取指定时间段内的数据统计数据
模板
会员中心分享信息
小程序模板设置信息
小程序模板详情
小程序模板详情
开屏广告信息
获取pc模板头尾部
获取pc模板页面内容
获取全局tdk设置信息
微信
获取小程序分享配置信息
小程序oauth授权登录
小程序oauth授权登录确认
小程序静默授权获取openid和unionid
根据share_id获取参数
第三方预登录
获取小程序会员中心配置信息
获取小程序公共配置信息
小程序oauth授权登录状态获取 pc接口
获取小程序订阅消息模板列表
获取小程序购物车提醒配置信息
获取小程序页面配置信息
获取小程序首页营销文章
获取小程序首页营销文章详情
获取授权跳转地址
获取静默登录openid
预约
用户提交预约数据
获取可用预约项目
获取可预约的日期
获取可预约的时段
获取指定项目的预约量
获取资源位列表信息
获取资源位详情
获取预约记录列表
积分
积分列表
获取积分信息
获取积分规则信息
推广管理
佣金提现申请
获取提现申请列表
店铺
获取店铺标签列表
关联店铺标签
大屏广告接口
新增店铺标签
更新店铺标签
申请店铺入驻
获取图片验证码
获取店铺信息
获取店铺列表
获取店铺售后地址
获取店铺总店
删除店铺标签详情
获取店铺标签列表
获取店铺标签详情
获取店铺统计
获取店铺详情
获取店铺配送方式
获取所店铺有列表
获取手机短信验证码
获取首页轮播图
逆地址解析
验证店铺id是否有效
验证短信验证码
商品
获取商品收藏情况
扫条形码加入购物车
获取分类列表
获取商品价格、库存等参数
获取商品会员价
获取商品分享的数据
获取商品列表
检查是否可以分享
获取商品详情
获取导购货架商品列表
获取导购货架商品详情
获取小店上架分类
获取小店上架商品列表
获取热门关键词
商城前端调用接口【1.0】
公共分类
获取提现方式列表
基本信息
Path： /api/h5app/wxapp/trade/withdraw/list
Method： GET
接口描述：
获取提现方式列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ pay_type_code | string | 非必须 |  | 支付渠道编码 |
| ├─ pay_type_name | string | 非必须 |  | 支付渠道名称 |
获取支付配置信息列表
基本信息
Path： /api/h5app/wxapp/trade/payment/list
Method： GET
接口描述：
获取支付配置信息列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ pay_type_code | string | 非必须 |  | 支付渠道编码 |
| ├─ pay_type_name | string | 非必须 |  | 支付渠道名称 |
获取汇付版本状态
基本信息
Path： /api/h5app/wxapp/trade/payment/hfpayversionstatus
Method： GET
接口描述：
获取汇付版本状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ hfpay_version_status | string | 非必须 |  | 是否汇付版本 true 汇付版本 false 非汇付版本 |
卡券包
当前用户获取等级卡券包
基本信息
Path： /api/h5app/wxapp/user/currentGardCardPackage
Method： POST
接口描述：
当前用户获取等级卡券包
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ type | bool | 非必须 |  | vip_grade,grade 类型 |
得到的卡券包中卡券信息
基本信息
Path： /api/h5app/wxapp/user/getBindCardList
Method： GET
接口描述：
得到的卡券包中卡券信息
请求参数
Query
参数名称
是否必须
示例
备注
| type
| 是
|
| 场景:vip_grade 会员购买升级, grade 等级升级
| grade_id
| 是
|
| 等级ID,从 /wxapp/member 接口获取 付费会员取:vip_grade_id 普通会员取 nextGradeInfo.grade_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 内含卡券总数量 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ give_num | string | 非必须 |  | 发送数量 |
| ├─ takeEffect | string | 非必须 |  | 有效期文字 |
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，discount:折扣券;cash:代金券;gift:兑换券;new_gift:兑换券(新) |
| ├─ title | string | 非必须 |  | 优惠券标题 |
| ├─ date_type | string | 非必须 |  | 有效期类型 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ quantity | string | 非必须 |  | 总库存数量 |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ kq_status | string | 非必须 |  | 卡券状态 0:正常 1:暂停 2:关闭 |
| ├─ grade_ids | string | 非必须 |  | 等级限制 |
| ├─ vip_grade_ids | string | 非必须 |  | vip等级限制 |
| ├─ get_limit | string | 非必须 |  | 卡券已发放数量 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ get_num | string | 非必须 |  | 卡券已发放数量 |
| ├─ lock_time | string | 非必须 |  | 兑换商品后的锁定时间 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ send_begin_time | string | 非必须 |  | 发放开始时间 |
| ├─ send_end_time | string | 非必须 |  | 发放结束时间 |
未读已领卡券列表
基本信息
Path： /api/h5app/wxapp/user/showCardPackage
Method： GET
接口描述：
获取未读已领卡券列表
请求参数
Query
参数名称
是否必须
示例
备注
| receive_type
| 是
|
| 未读场景:template 模版领取,vip_grade 会员购买升级, grade 等级升级
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ receive_record_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ receive_id | string | 非必须 |  | 卡券包领取记录ID |
| ├─ package_id | string | 非必须 |  | 卡券包ID |
| ├─ receive_type | string | 非必须 |  | 领取场景:template 模版领取,vip_grade 会员购买升级, grade 等级升级 |
| ├─ receive_status | string | 非必须 |  | 卡券包领取状态：in_progress 正在领取中,success 领取成功 |
| ├─ front_show | string | 非必须 |  | 是否已读 1/0 已读/未读 |
| ├─ receive_time | string | 非必须 |  | 有效期类型 |
| ├─ success_count | string | 非必须 |  | 此卡券包成功领取卡券数 |
| ├─ receive_record_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ takeEffect | string | 非必须 |  | 有效期文字 |
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，discount:折扣券;cash:代金券;gift:兑换券;new_gift:兑换券(新) |
| ├─ title | string | 非必须 |  | 优惠券标题 |
| ├─ date_type | string | 非必须 |  | 有效期类型 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ quantity | string | 非必须 |  | 总库存数量 |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ kq_status | string | 非必须 |  | 卡券状态 0:正常 1:暂停 2:关闭 |
| ├─ grade_ids | string | 非必须 |  | 等级限制 |
| ├─ vip_grade_ids | string | 非必须 |  | vip等级限制 |
| ├─ get_limit | string | 非必须 |  | 卡券已发放数量 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ receive_status | string | 非必须 |  | 卡券领取状态：in_progress 正在领取中,success 领取成功 |
| ├─ get_num | string | 非必须 |  | 卡券已发放数量 |
| ├─ lock_time | string | 非必须 |  | 兑换商品后的锁定时间 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ send_begin_time | string | 非必须 |  | 发放开始时间 |
| ├─ send_end_time | string | 非必须 |  | 发放结束时间 |
| ├─ all_card_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ takeEffect | string | 非必须 |  | 有效期文字 |
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，discount:折扣券;cash:代金券;gift:兑换券;new_gift:兑换券(新) |
| ├─ title | string | 非必须 |  | 优惠券标题 |
| ├─ date_type | string | 非必须 |  | 有效期类型 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ quantity | string | 非必须 |  | 总库存数量 |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ kq_status | string | 非必须 |  | 卡券状态 0:正常 1:暂停 2:关闭 |
| ├─ grade_ids | string | 非必须 |  | 等级限制 |
| ├─ vip_grade_ids | string | 非必须 |  | vip等级限制 |
| ├─ get_limit | string | 非必须 |  | 卡券已发放数量 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ receive_status | string | 非必须 |  | 卡券领取状态：in_progress 正在领取中,success 领取成功 |
| ├─ get_num | string | 非必须 |  | 卡券已发放数量 |
| ├─ lock_time | string | 非必须 |  | 兑换商品后的锁定时间 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ send_begin_time | string | 非必须 |  | 发放开始时间 |
| ├─ send_end_time | string | 非必须 |  | 发放结束时间 |
确认已读已领卡券列表
基本信息
Path： /api/h5app/wxapp/user/confirmPackageShow
Method： POST
接口描述：
确认已读已领卡券列表
请求参数
Query
参数名称
是否必须
示例
备注
| receive_ids
| 是
|
| 卡券包领取ID 此参数为数组
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | bool | 非必须 |  | 操作结果 |
领取卡券包
基本信息
Path： /api/h5app/wxapp/user/receiveCardPackage
Method： POST
接口描述：
模版挂件通过卡券包ID领取卡券包
请求参数
Query
参数名称
是否必须
示例
备注
| package_id
| 是
|
| 卡券包ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | bool | 非必须 |  | 领取结果 |
Adapay
新建分销员认证信息
基本信息
Path： /api/h5app/wxapp/adapay/popularize/create_cert
Method： POST
接口描述：
新建分销员认证信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | bool | 非必须 |  | 操作结果 |
更新分销员认证信息
基本信息
Path： /api/h5app/wxapp/adapay/popularize/update_cert
Method： POST
接口描述：
更新分销员认证信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | bool | 非必须 |  | 操作结果 |
获取分销员认证信息
基本信息
Path： /api/h5app/wxapp/adapay/popularize/cert
Method： GET
接口描述：
获取分销员认证信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ member_id | string | 非必须 |  | 认证会员ID 0为未创建过认证信息，1为创建过认证信息 |
| ├─ tel_no | string | 非必须 |  | 银行预留手机号 |
| ├─ card_id | string | 非必须 |  | 银行账号 |
| ├─ cert_id | string | 非必须 |  | 开户证件号码 |
| ├─ card_name | string | 非必须 |  | 开户人姓名 |
| ├─ cert_status | object | 非必须 |  |  |
| ├─ audit_state | string | 非必须 |  | 审核状态 A 待审核；B 审核失败；C 开户失败； D 开户成功但未创建结算账户； E 开户和创建结算账户成功； |
| ├─ audit_value | string | 非必须 |  | 审核状态语义化值 AUDIT_WAIT 待审核；AUDIT_FAIL 审核失败；AUDIT_MEMBER_FAIL 开户失败； AUDIT_ACCOUNT_FAIL 开户成功但未创建结算账户； AUDIT_SUCCESS 开户和创建结算账户成功；DISPLAY_NONE 汇付设置未打开 |
| ├─ audit_desc | string | 非必须 |  | 审核描述 |
| ├─ error_info | string | 非必须 |  | 错误信息 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
腾讯广告
腾讯广告保留click_id
基本信息
Path： /api/h5app/wxapp/ad/tencent/click
Method： POST
接口描述：
腾讯广告
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Content-Type
| application/x-www-form-urlencoded
| 是
|
| Authorization
|
| 是
|
| JWT验证token
Body
参数名称
参数类型
是否必须
示例
备注
| click_id
| text
| 是
|
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 上传状态 |
获取腾讯广告数据上报所需参数
基本信息
Path： /api/h5app/wxapp/ad/tencent/info
Method： GET
接口描述：
腾讯广告
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ access_token | object | 非必须 |  |  |
| ├─ token | stirng | 非必须 |  | token |
| ├─ expire_time | integer | 非必须 |  | 到期时间 |
| ├─ click_id | integer | 非必须 |  | 暂无描述 |
| ├─ nonce | string | 必须 |  |  |
| ├─ account_id | string | 必须 |  |  |
| ├─ user_action_set_id | string | 必须 |  |  |
企业
获取单个微信门店详情
基本信息
Path： /api/h5app/wxapp/shops/wxshops/{wx_shop_id}
Method： GET
接口描述：
获取单个微信门店详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| wx_shop_id
|
| 微信门店id，非微信方的mp_poi_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ wx_shop_id | string | 非必须 |  |  |
| ├─ mp_poi_id | string | 非必须 |  |  |
| ├─ pic_list | string | 非必须 |  |  |
| ├─ contract_phone | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  |  |
| ├─ credential | string | 非必须 |  |  |
| ├─ company_name | string | 非必须 |  |  |
| ├─ qualification_list | string | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ is_domestic | integer | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ is_direct_store | integer | 非必须 |  |  |
企业微信，小程序登录
基本信息
Path： /api/h5app/wxapp/workwechatlogin
Method： POST
接口描述：
企业微信，小程序登录
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid
| salesperson-type
|
| 是
|
| 登陆类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ session3rd | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ avatar | string | 非必须 |  | 头像 |
| ├─ phoneNumber | string | 非必须 |  | 手机号 |
| ├─ salesperson_name | string | 非必须 |  | 导购员姓名 |
| ├─ salesperson_type | string | 非必须 |  | 导购员类型 |
| ├─ salesperson_id | string | 非必须 |  | 导购员id |
| ├─ store_name | string | 非必须 |  | 门店名称 |
| ├─ work_userid | string | 非必须 |  | 工号 |
| ├─ salesperson_job | string | 非必须 |  | 职务 |
| ├─ employee_status | string | 非必须 |  | 员工类型 [1 员工] [2 编外] |
商城站点信息 - 获取
基本信息
Path： /api/h5app/wxapp/shops/info
Method： GET
接口描述：
获取商场站点的基本信息
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ intro | string | 必须 |  | 商城简介 |
| ├─ logo | string | 必须 |  | 商城logo |
| ├─ brand_name | string | 必须 |  | 商城名称 |
| ├─ protocol | object | 必须 |  | 协议内容 |
| ├─ member_register | string | 必须 |  | 用户注册协议的标题 |
| ├─ privacy | string | 必须 |  | 隐私政策协议的标题 |
批量获取文章点赞数量和点赞状态
基本信息
Path： /api/h5app/wxapp/article/praise/getcountresult
Method： GET
接口描述：
批量获取文章点赞数量和点赞状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_ids
|
| ids
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章关注
基本信息
Path： /api/h5app/wxapp/article/focus/{article_id}
Method： GET
接口描述：
文章关注
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章关注总数量
基本信息
Path： /api/h5app/wxapp/article/focus/num/{article_id}
Method： GET
接口描述：
文章关注总数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章列表
基本信息
Path： /api/h5app/wxapp/article/management
Method： GET
接口描述：
文章列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| title
| 否
|
| 标题
| article_id
| 否
|
| 文章id
| category_id
| 否
|
| 文章栏目id
| province
| 否
|
| 省
| city
| 否
|
| 市
| area
| 否
|
| 区
| article_type
| 否
|
| 文章类型,general:普通文章; bring:带货文章
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ article_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ title | integer | 非必须 |  |  |
| ├─ author | integer | 非必须 |  |  |
| ├─ summary | string | 非必须 |  |  |
| ├─ content | string | 非必须 |  |  |
| ├─ image_url | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ sort | integer | 非必须 |  |  |
| ├─ share_image_url | string | 非必须 |  |  |
| ├─ operator_id | string | 非必须 |  |  |
| ├─ release_status | string | 非必须 |  |  |
| ├─ article_type | string | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  |  |
| ├─ head_portrait | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
文章点赞
基本信息
Path： /api/h5app/wxapp/article/praise/{article_id}
Method： GET
接口描述：
文章点赞
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章点赞总数
基本信息
Path： /api/h5app/wxapp/article/praise/num/{article_id}
Method： GET
接口描述：
文章点赞总数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章点赞验证
基本信息
Path： /api/h5app/wxapp/article/praise/check/{article_id}
Method： GET
接口描述：
文章点赞验证
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
文章详情
基本信息
Path： /api/h5app/wxapp/article/management/{article_id}
Method： GET
接口描述：
文章详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| article_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ article_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ title | integer | 非必须 |  |  |
| ├─ author | integer | 非必须 |  |  |
| ├─ summary | string | 非必须 |  |  |
| ├─ content | string | 非必须 |  |  |
| ├─ image_url | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ sort | integer | 非必须 |  |  |
| ├─ share_image_url | string | 非必须 |  |  |
| ├─ operator_id | string | 非必须 |  |  |
| ├─ release_status | string | 非必须 |  |  |
| ├─ article_type | string | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  |  |
| ├─ head_portrait | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
商城协议 - 获取
基本信息
Path： /api/h5app/wxapp/shops/protocol
Method： GET
接口描述：
获取商城内的协议信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| type
| 是
|
| 协议类型 【member_register 用户注册协议】【privacy 隐私策略协议】
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ type | string | 必须 |  | 协议类型 |
| ├─ title | string | 必须 |  | 协议标题 |
| ├─ content | string | 必须 |  | 协议内容 |
获取启用物流公司列表
基本信息
Path： /api/h5app/wxapp/company/logistics/list
Method： GET
接口描述：
获取启用物流公司列表
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ corp_id | integer | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  |  |
| ├─ corp_name | string | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ is_enable | integer | 非必须 |  |  |
获取启用物流公司列表
基本信息
Path： /api/h5app/wxapp/company/logistics/enableList
Method： GET
接口描述：
获取启用物流公司列表
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ corp_code | string | 非必须 |  |  |
| ├─ corp_name | string | 非必须 |  |  |
获取商城配置信息
基本信息
Path： /api/h5app/wxapp/company/setting
Method： GET
接口描述：
获取商城配置信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ logo | integer | 非必须 |  |  |
| ├─ intro | integer | 非必须 |  |  |
| ├─ brand_name | integer | 非必须 |  |  |
获取微信门店列表
基本信息
Path： /api/h5app/wxapp/shops/wxshops
Method： GET
接口描述：
获取微信门店列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
| wx_shop_id
| 否
|
| 门店id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ wx_shop_id | string | 非必须 |  |  |
| ├─ mp_poi_id | string | 非必须 |  |  |
| ├─ pic_list | string | 非必须 |  |  |
| ├─ contract_phone | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  |  |
| ├─ credential | string | 非必须 |  |  |
| ├─ company_name | string | 非必须 |  |  |
| ├─ qualification_list | string | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ is_domestic | integer | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ is_direct_store | integer | 非必须 |  |  |
获取文章栏目列表
基本信息
Path： /api/h5app/wxapp/article/category
Method： GET
接口描述：
获取文章栏目列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ category_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ category_name | integer | 非必须 |  |  |
| ├─ parent_id | integer | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ category_type | string | 非必须 |  |  |
| ├─ path | string | 非必须 |  |  |
| ├─ sort | integer | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ children |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
获取文章的所有省份列表
基本信息
Path： /api/h5app/wxapp/article/province
Method： GET
接口描述：
获取文章的所有省份列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
获取最近门店
基本信息
Path： /api/h5app/wxapp/shops/getNearestWxShops
Method： GET
接口描述：
获取最近门店
请求参数
Query
参数名称
是否必须
示例
备注
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ wx_shop_id | string | 非必须 |  |  |
| ├─ mp_poi_id | string | 非必须 |  |  |
| ├─ pic_list | string | 非必须 |  |  |
| ├─ contract_phone | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  |  |
| ├─ credential | string | 非必须 |  |  |
| ├─ company_name | string | 非必须 |  |  |
| ├─ qualification_list | string | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
获取评价状态
基本信息
Path： /api/h5app/traderate/getstatus
Method： GET
接口描述：
获取评价状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ rate_status | boolean | 非必须 |  |  |
获取配置外部链接
基本信息
Path： /api/h5app/wxapp/setting/weburl
Method： GET
接口描述：
获取配置外部链接
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ mycoach | stirng | 非必须 |  |  |
| ├─ aftersales | stirng | 非必须 |  |  |
获取非自提无店铺开关状态
基本信息
Path： /api/h5app/wxapp/nostores/getstatus
Method： GET
接口描述：
获取非自提无店铺开关状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ nostores_status | bool | 非必须 |  |  |
获取默认货币配置
基本信息
Path： /api/h5app/wxapp/currencyGetDefault
Method： GET
接口描述：
获取默认货币配置
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ currency | integer | 非必须 |  |  |
| ├─ title | string | 非必须 |  |  |
| ├─ symbol | string | 非必须 |  |  |
| ├─ rate | string | 非必须 |  |  |
| ├─ is_default | string | 非必须 |  |  |
售后
创建售后单
基本信息
Path： /api/h5app/wxapp/aftersales
Method： POST
接口描述：
创建售后单
请求参数
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单号
| item_id
| 是
|
| 交易商品ID
| sub_order_id
| 是
|
| 子单ID
| reason_id
| 是
|
| 售后原因ID
| reason
| 是
|
| 申请售后原因
| goods_status
| 否
|
| 收货状态 1:未收到货 2:已收到货
| detail
| 是
|
| 售后商品明细
| aftersales_type
| 是
|
| 售后类型， ONLY_REFUND 仅退款 REFUND_GOODS 退货退款 EXCHANGING_GOODS 换货
| description
| 是
|
| 申请描述
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ aftersales_status | string | 非必须 |  | 售后状态 |
| ├─ aftersales_bn | string | 非必须 |  | 售后单号 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ evidence_pic | string | 非必须 |  | 图片凭证信息 |
| ├─ memo | string | 非必须 |  | 售后备注 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ reason | string | 非必须 |  | 申请售后原因 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | integer | 非必须 |  | 应退总积分 |
| ├─ refuse_reason | string | 非必须 |  | 拒绝原因 |
| ├─ sendconfirm_data | string | 非必须 |  | 商家重新发货物流信息 |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
| ├─ goods_status | integer | 非必须 |  | 货物状态，1：未收到货，2：已收到货 |
| ├─ sendback_data | object | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  | 物流公司编码 |
| ├─ logi_no | string | 非必须 |  | 物流单号 |
| ├─ receiver_address | string | 非必须 |  | 收货地址 |
| ├─ receiver_mobile | string | 非必须 |  | 收货电话 |
| ├─ detail | object [] | 非必须 |  |  |
item 类型: object
| ├─ detail_id | integer | 非必须 |  | 售后明细ID |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ aftersales_bn | integer | 非必须 |  | 售后单号 |
| ├─ aftersales_status | integer | 非必须 |  | 售后状态 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ auto_refuse_time | integer | 非必须 |  | 售后自动驳回时间 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名 |
| ├─ item_pic | string | 非必须 |  | 图片 |
| ├─ num | integer | 非必须 |  | 数量 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | string | 非必须 |  | 积分支付应退款积分 |
| ├─ sub_order_id | string | 非必须 |  | 订单明细表id |
| ├─ update_time | string | 非必须 |  | 更新时间 |
售后关闭
基本信息
Path： /api/h5app/wxapp/aftersales/close
Method： POST
接口描述：
售后关闭
请求参数
Query
参数名称
是否必须
示例
备注
| aftersales_bn
| 是
|
| 售后单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ aftersales_status | string | 非必须 |  | 售后状态 |
| ├─ aftersales_bn | string | 非必须 |  | 售后单号 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ evidence_pic | string | 非必须 |  | 图片凭证信息 |
| ├─ memo | string | 非必须 |  | 售后备注 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ reason | string | 非必须 |  | 申请售后原因 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | integer | 非必须 |  | 应退总积分 |
| ├─ refuse_reason | string | 非必须 |  | 拒绝原因 |
| ├─ sendconfirm_data | string | 非必须 |  | 商家重新发货物流信息 |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
| ├─ goods_status | integer | 非必须 |  | 货物状态，1：未收到货，2：已收到货 |
| ├─ sendback_data | object | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  | 物流公司编码 |
| ├─ logi_no | string | 非必须 |  | 物流单号 |
| ├─ receiver_address | string | 非必须 |  | 收货地址 |
| ├─ receiver_mobile | string | 非必须 |  | 收货电话 |
| ├─ detail | object [] | 非必须 |  |  |
item 类型: object
| ├─ detail_id | integer | 非必须 |  | 售后明细ID |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ aftersales_bn | integer | 非必须 |  | 售后单号 |
| ├─ aftersales_status | integer | 非必须 |  | 售后状态 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ auto_refuse_time | integer | 非必须 |  | 售后自动驳回时间 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名 |
| ├─ item_pic | string | 非必须 |  | 图片 |
| ├─ num | integer | 非必须 |  | 数量 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | string | 非必须 |  | 积分支付应退款积分 |
| ├─ sub_order_id | string | 非必须 |  | 订单明细表id |
| ├─ update_time | string | 非必须 |  | 更新时间 |
售后提醒内容获取
基本信息
Path： /api/h5app/wxapp/aftersales/remind/detail
Method： GET
接口描述：
售后提醒内容获取
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| company_id
| 是
|
| companyID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ intro | string | 非必须 |  | 内容详情 |
| ├─ is_open | boolean | 非必须 | false | 是否开启 |
售后消费者回寄
基本信息
Path： /api/h5app/wxapp/aftersales/sendback
Method： POST
接口描述：
售后消费者回寄
请求参数
Query
参数名称
是否必须
示例
备注
| aftersales_bn
| 是
|
| 售后单号
| corp_code
| 是
|
| 快递公司
| logi_no
| 是
|
| 快递单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ aftersales_status | string | 非必须 |  | 售后状态 |
| ├─ aftersales_bn | string | 非必须 |  | 售后单号 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ evidence_pic | string | 非必须 |  | 图片凭证信息 |
| ├─ memo | string | 非必须 |  | 售后备注 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ reason | string | 非必须 |  | 申请售后原因 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | integer | 非必须 |  | 应退总积分 |
| ├─ refuse_reason | string | 非必须 |  | 拒绝原因 |
| ├─ sendconfirm_data | string | 非必须 |  | 商家重新发货物流信息 |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
| ├─ goods_status | integer | 非必须 |  | 货物状态，1：未收到货，2：已收到货 |
| ├─ sendback_data | object | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  | 物流公司编码 |
| ├─ logi_no | string | 非必须 |  | 物流单号 |
| ├─ receiver_address | string | 非必须 |  | 收货地址 |
| ├─ receiver_mobile | string | 非必须 |  | 收货电话 |
| ├─ detail | object [] | 非必须 |  |  |
item 类型: object
| ├─ detail_id | integer | 非必须 |  | 售后明细ID |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ aftersales_bn | integer | 非必须 |  | 售后单号 |
| ├─ aftersales_status | integer | 非必须 |  | 售后状态 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ auto_refuse_time | integer | 非必须 |  | 售后自动驳回时间 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名 |
| ├─ item_pic | string | 非必须 |  | 图片 |
| ├─ num | integer | 非必须 |  | 数量 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | string | 非必须 |  | 积分支付应退款积分 |
| ├─ sub_order_id | string | 非必须 |  | 订单明细表id |
| ├─ update_time | string | 非必须 |  | 更新时间 |
获取售后单列表
基本信息
Path： /api/h5app/wxapp/aftersales
Method： GET
接口描述：
getAftersalesList
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| aftersales_type
| 否
|
| 售后类型
| aftersales_status
| 否
|
| 售后状态
| order_id
| 否
|
| 订单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 数量 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ aftersales_status | string | 非必须 |  | 售后状态 |
| ├─ aftersales_bn | string | 非必须 |  | 售后单号 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ evidence_pic | string | 非必须 |  | 图片凭证信息 |
| ├─ memo | string | 非必须 |  | 售后备注 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ reason | string | 非必须 |  | 申请售后原因 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | integer | 非必须 |  | 应退总积分 |
| ├─ refuse_reason | string | 非必须 |  | 拒绝原因 |
| ├─ sendconfirm_data | string | 非必须 |  | 商家重新发货物流信息 |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
| ├─ goods_status | integer | 非必须 |  | 货物状态，1：未收到货，2：已收到货 |
| ├─ sendback_data | object | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  | 物流公司编码 |
| ├─ logi_no | string | 非必须 |  | 物流单号 |
| ├─ receiver_address | string | 非必须 |  | 收货地址 |
| ├─ receiver_mobile | string | 非必须 |  | 收货电话 |
| ├─ detail | object [] | 非必须 |  |  |
item 类型: object
| ├─ detail_id | integer | 非必须 |  | 售后明细ID |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ aftersales_bn | integer | 非必须 |  | 售后单号 |
| ├─ aftersales_status | integer | 非必须 |  | 售后状态 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ auto_refuse_time | integer | 非必须 |  | 售后自动驳回时间 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名 |
| ├─ item_pic | string | 非必须 |  | 图片 |
| ├─ num | integer | 非必须 |  | 数量 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | string | 非必须 |  | 积分支付应退款积分 |
| ├─ sub_order_id | string | 非必须 |  | 订单明细表id |
| ├─ update_time | string | 非必须 |  | 更新时间 |
获取售后单详情
基本信息
Path： /api/h5app/wxapp/aftersales/info
Method： GET
接口描述：
获取售后单详情
请求参数
Query
参数名称
是否必须
示例
备注
| aftersales_bn
| 是
|
| 售后单号
| item_id
| 是
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ aftersales_status | string | 非必须 |  | 售后状态 |
| ├─ aftersales_bn | string | 非必须 |  | 售后单号 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ evidence_pic | string | 非必须 |  | 图片凭证信息 |
| ├─ memo | string | 非必须 |  | 售后备注 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ reason | string | 非必须 |  | 申请售后原因 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | integer | 非必须 |  | 应退总积分 |
| ├─ refuse_reason | string | 非必须 |  | 拒绝原因 |
| ├─ sendconfirm_data | string | 非必须 |  | 商家重新发货物流信息 |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ update_time | string | 非必须 |  | 更新时间 |
| ├─ goods_status | integer | 非必须 |  | 货物状态，1：未收到货，2：已收到货 |
| ├─ sendback_data | object | 非必须 |  |  |
| ├─ corp_code | string | 非必须 |  | 物流公司编码 |
| ├─ logi_no | string | 非必须 |  | 物流单号 |
| ├─ receiver_address | string | 非必须 |  | 收货地址 |
| ├─ receiver_mobile | string | 非必须 |  | 收货电话 |
| ├─ detail | object [] | 非必须 |  |  |
item 类型: object
| ├─ detail_id | integer | 非必须 |  | 售后明细ID |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ aftersales_bn | integer | 非必须 |  | 售后单号 |
| ├─ aftersales_status | integer | 非必须 |  | 售后状态 |
| ├─ aftersales_type | string | 非必须 |  | 售后类型 |
| ├─ auto_refuse_time | integer | 非必须 |  | 售后自动驳回时间 |
| ├─ create_time | string | 非必须 |  | 创建时间 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名 |
| ├─ item_pic | string | 非必须 |  | 图片 |
| ├─ num | integer | 非必须 |  | 数量 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ progress | integer | 非必须 |  | 处理进度 |
| ├─ refund_fee | string | 非必须 |  | 应退总金额 |
| ├─ refund_point | string | 非必须 |  | 积分支付应退款积分 |
| ├─ sub_order_id | string | 非必须 |  | 订单明细表id |
| ├─ update_time | string | 非必须 |  | 更新时间 |
获取售后原因列表
基本信息
Path： /api/h5app/aftersales/reason/list
Method： GET
接口描述：
售后原因列表获取
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| sub_order_id
| 是
|
| 子订单号
| biz_claim_type
| 是
|
| 退款类型 1:仅退款, 2:退货退款
| goods_status
| 是
|
| 货物状态 1:未收到货, 2:已收到货
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ reason_id | integer | 非必须 |  | 退款原因id |
| ├─ reason | string | 非必须 |  | 退款原因 |
| ├─ proof_required | boolean | 非必须 |  | 是否要求上传凭证 |
| ├─ desc_required | boolean | 非必须 |  | 是否要求留言 |
获取售后商品价格
基本信息
Path： /api/h5app/wxapp/aftersales/item/price
Method： GET
接口描述：
获取售后商品价格
请求参数
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单id
| item_id
| 是
|
| 商品id
| number
| 是
|
| 商品数量
| aftersales_bn
| 否
|
| 售后单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ price | string | 非必须 |  | 售后商品价格 |
获取退款单
基本信息
Path： /api/h5app/wxapp/refunds
Method： GET
接口描述：
获取退款单
请求参数
Query
参数名称
是否必须
示例
备注
| aftersales_bn
| 是
|
| 获取退款单
返回数据
成功返回结构
社区活动
创建社区数据[此接口暂时不可用]
基本信息
Path： /api/h5app/wxapp/promotion/community/apply
Method： POST
接口描述：
创建社区数据
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| community_name
| 是
|
| 社区名称
| leader_name
| 是
|
| 团长姓名
| leader_mobile
| 是
|
| 团长手机
| address
| 否
|
| 经销商地址
| leader_id_card
| 否
|
| 团长身份证号
| lng
| 否
|
| 地图纬度
| lat
| 否
|
| 地图经度
| country
| 否
|
| 国家名称,默认china
| status
| 否
|
| 状态
| referrer
| 否
|
| 推荐人
| num
| 否
|
| 社区人数
| description
| 否
|
| 备注说明
| leader_nickname
| 否
|
| 团长昵称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ community_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ community_name | integer | 非必须 |  |  |
| ├─ leader_name | integer | 非必须 |  |  |
| ├─ leader_mobile | string | 非必须 |  |  |
| ├─ leader_id_card | string | 非必须 |  |  |
| ├─ leader_nickname | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ referrer_id | string | 非必须 |  |  |
| ├─ referrer | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ pass_time | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取定位最近的社区
基本信息
Path： /api/h5app/wxapp/promotion/community/nearInfo
Method： GET
接口描述：
获取定位最近的社区
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
路径参数
参数名称
示例
备注
| lng
|
| 经度
| lat
|
| 维度
| page
|
| 分页
| pageSize
|
| 每页页码
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ community_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ community_name | integer | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  |  |
| ├─ pic_imgs | string | 非必须 |  |  |
| ├─ leader_name | integer | 非必须 |  |  |
| ├─ leader_mobile | string | 非必须 |  |  |
| ├─ leader_id_card | string | 非必须 |  |  |
| ├─ leader_nickname | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ referrer_id | string | 非必须 |  |  |
| ├─ referrer | string | 非必须 |  |  |
| ├─ deny_reason | string | 非必须 |  |  |
| ├─ source | string | 非必须 |  |  |
| ├─ bd | string | 非必须 |  |  |
| ├─ business_district | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ pass_time | string | 非必须 |  |  |
| ├─ shop_number | string | 非必须 |  |  |
| ├─ site_number | string | 非必须 |  |  |
| ├─ pass_date | string | 非必须 |  |  |
| ├─ regions_id |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ regions |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取活动列表【该接口暂不可用】
基本信息
Path： /api/h5app/wxapp/promotion/community/activitylist
Method： GET
接口描述：
获取活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| activity_id
| 是
|
| id
| name
| 是
|
| 名称
| start_time
| 是
|
| 开始时间
| end_time
| 是
|
| 结束时间
| status
| 是
|
| 状态
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ activity_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ delivery_start_time | string | 非必须 |  |  |
| ├─ delivery_end_time | string | 非必须 |  |  |
| ├─ community | string | 非必须 |  |  |
| ├─ coupon_id | string | 非必须 |  |  |
| ├─ total_num | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ item_data | string | 非必须 |  |  |
| ├─ activity_type | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取活动商品的销量
基本信息
Path： /api/h5app/wxapp/promotion/community/activityitemsales
Method： GET
接口描述：
获取活动商品的销量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| activity_id
| 是
|
| id
| item_ids
| 是
|
| 名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ activity_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ item_id | integer | 非必须 |  |  |
| ├─ item_name | integer | 非必须 |  |  |
| ├─ activity_store | integer | 非必须 |  |  |
| ├─ limit_num | integer | 非必须 |  |  |
| ├─ activity_price | integer | 非必须 |  |  |
| ├─ vip_price | integer | 非必须 |  |  |
| ├─ svip_price | integer | 非必须 |  |  |
| ├─ points | integer | 非必须 |  |  |
| ├─ sales_store | integer | 非必须 |  |  |
| ├─ initial_sales | integer | 非必须 |  |  |
获取活动商品详情及活动详情
基本信息
Path： /api/h5app/wxapp/promotion/community/activityitemsinfo
Method： GET
接口描述：
获取活动商品详情及活动详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| item_id
| 是
|
| 商品id
| activity_id
| 是
|
| 活动id
| community_id
| 是
|
| 社区id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ item | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ activity_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ delivery_start_time | string | 非必须 |  |  |
| ├─ delivery_end_time | string | 非必须 |  |  |
| ├─ community | string | 非必须 |  |  |
| ├─ coupon_id | string | 非必须 |  |  |
| ├─ total_num | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ banner_img | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ activity_image | string | 非必须 |  |  |
| ├─ activity_video | string | 非必须 |  |  |
| ├─ activity_phone | string | 非必须 |  |  |
| ├─ delivery_date | string | 非必须 |  |  |
| ├─ last_second | string | 非必须 |  |  |
| ├─ item | string | 非必须 |  |  |
| ├─ activity_type | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ community | object [] | 非必须 |  |  |
item 类型: object
| ├─ community_id | integer | 非必须 |  |  |
| ├─ community_name | integer | 非必须 |  |  |
| ├─ leader_name | integer | 非必须 |  |  |
| ├─ leader_mobile | string | 非必须 |  |  |
| ├─ leader_id_card | string | 非必须 |  |  |
| ├─ leader_nickname | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ cur | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ currency | string | 非必须 |  |  |
| ├─ title | string | 非必须 |  |  |
| ├─ symbol | string | 非必须 |  |  |
| ├─ rate | integer | 非必须 |  |  |
| ├─ is_default | boolean | 非必须 |  |  |
| ├─ use_platform | integer | 非必须 |  |  |
| ├─ history_data |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
获取活动详情及活动商品列表
基本信息
Path： /api/h5app/wxapp/promotion/community/activityitemslist
Method： GET
接口描述：
获取活动详情及活动商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| community_id
| 是
|
| id
| activity_id
| 否
|
| activity_id
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
| status
| 否
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ activity_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_image | string | 非必须 |  |  |
| ├─ activity_video | string | 非必须 |  |  |
| ├─ activity_phone | string | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ delivery_time | string | 非必须 |  |  |
| ├─ delivery_date | string | 非必须 |  |  |
| ├─ community | string | 非必须 |  |  |
| ├─ coupon_id | string | 非必须 |  |  |
| ├─ total_num | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ items | string | 非必须 |  |  |
| ├─ activity_type | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ cur | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ currency | string | 非必须 |  |  |
| ├─ title | string | 非必须 |  |  |
| ├─ symbol | string | 非必须 |  |  |
| ├─ rate | integer | 非必须 |  |  |
| ├─ is_default | boolean | 非必须 |  |  |
| ├─ use_platform | integer | 非必须 |  |  |
| ├─ last_second | string | 非必须 |  |  |
| ├─ history_data |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
获取社区列表
基本信息
Path： /api/h5app/wxapp/promotion/community/list
Method： GET
接口描述：
获取社区列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
路径参数
参数名称
示例
备注
| lng
|
| 经度
| lat
|
| 维度
| page
|
| 分页
| pageSize
|
| 每页页码
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ community_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ community_name | integer | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  |  |
| ├─ pic_imgs | string | 非必须 |  |  |
| ├─ leader_name | integer | 非必须 |  |  |
| ├─ leader_mobile | string | 非必须 |  |  |
| ├─ leader_id_card | string | 非必须 |  |  |
| ├─ leader_nickname | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ referrer_id | string | 非必须 |  |  |
| ├─ referrer | string | 非必须 |  |  |
| ├─ deny_reason | string | 非必须 |  |  |
| ├─ source | string | 非必须 |  |  |
| ├─ bd | string | 非必须 |  |  |
| ├─ business_district | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ pass_time | string | 非必须 |  |  |
| ├─ shop_number | string | 非必须 |  |  |
| ├─ site_number | string | 非必须 |  |  |
| ├─ pass_date | string | 非必须 |  |  |
| ├─ regions_id |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ regions |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取社区团长详情
基本信息
Path： /api/h5app/wxapp/promotion/community/info
Method： GET
接口描述：
获取社区团长详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
路径参数
参数名称
示例
备注
| community_id
|
| id
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ community_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ community_name | integer | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  |  |
| ├─ pic_imgs | string | 非必须 |  |  |
| ├─ leader_name | integer | 非必须 |  |  |
| ├─ leader_mobile | string | 非必须 |  |  |
| ├─ leader_id_card | string | 非必须 |  |  |
| ├─ leader_nickname | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ country | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ referrer_id | string | 非必须 |  |  |
| ├─ referrer | string | 非必须 |  |  |
| ├─ deny_reason | string | 非必须 |  |  |
| ├─ source | string | 非必须 |  |  |
| ├─ bd | string | 非必须 |  |  |
| ├─ business_district | string | 非必须 |  |  |
| ├─ num | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  |  |
| ├─ pass_time | string | 非必须 |  |  |
| ├─ shop_number | string | 非必须 |  |  |
| ├─ site_number | string | 非必须 |  |  |
| ├─ pass_date | string | 非必须 |  |  |
| ├─ regions_id |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ regions |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
储值
储值兑换积分
基本信息
Path： /api/h5app/wxapp/deposit/to/point
Method： POST
接口描述：
储值兑换积分
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ deposit | string | 非必须 |  | 余额 |
| ├─ point | string | 非必须 |  | 积分 |
充值
基本信息
Path： /api/h5app/weapp/deposit/recharge
Method： POST
接口描述：
对会员卡储值金额进行充值
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | 应用id |
| ├─ timeStamp | string | 非必须 |  | 时间 |
| ├─ nonceStr | string | 非必须 |  |  |
| ├─ package | string | 非必须 |  |  |
| ├─ signType | string | 非必须 |  |  |
| ├─ paySign | string | 非必须 |  |  |
| ├─ trade_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ order_id | string | 非必须 |  | 订单id |
| ├─ trade_id | string | 非必须 |  | 交易id |
充值-新
基本信息
Path： /api/h5app/weapp/deposit/recharge_new
Method： POST
接口描述：
对会员卡储值金额进行充值
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ pay_type | string | 非必须 |  | 支付类型 |
| ├─ order_type | recharge | 非必须 |  | 订单类型 |
充值总金额
基本信息
Path： /api/h5app/wxapp/deposit/info
Method： GET
接口描述：
充值总金额
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ deposit | string | 非必须 |  | 总额（余额） |
获取储值协议
基本信息
Path： /api/h5app/weapp/deposit/recharge/agreement
Method： GET
接口描述：
获取储值协议
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 企业id |
| ├─ content | string | 非必须 |  | 内容 |
获取充值列表
基本信息
Path： /api/h5app/wxapp/deposit/list
Method： GET
接口描述：
获取充值列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页条数
| outin_type
| 否
|
| 交易类型充值或消费。outcome查消费
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ depositTradeId | string | 非必须 |  | 储值流水号 |
| ├─ companyId | string | 非必须 |  | 企业ID |
| ├─ memberCardCode | string | 非必须 |  | 充值会员卡号 |
| ├─ shopId | string | 非必须 |  | 门店ID |
| ├─ shopName | string | 非必须 |  | 门店名称 |
| ├─ userId | string | 非必须 |  | 购买用户 |
| ├─ mobile | string | 非必须 |  | 购买用户手机号 |
| ├─ openId | string | 非必须 |  | 用户open_id |
| ├─ money | string | 非必须 |  | 充值金额/消费金额 |
| ├─ tradeType | string | 非必须 |  | 交易类型充值或消费。consume:消费，recharge:充值 |
| ├─ authorizerAppid | string | 非必须 |  | 公众号的appid |
| ├─ wxaAppid | string | 非必须 |  | 支付小程序的appid |
| ├─ detail | string | 非必须 |  | 交易详情 |
| ├─ timeStart | string | 非必须 |  | 交易起始时间 |
| ├─ timeExpire | string | 非必须 |  | 交易结束时间 |
| ├─ tradeStatus | string | 非必须 |  | 交易状态 |
| ├─ transactionId | string | 非必须 |  | 充值支付订单号 |
| ├─ bankType | string | 非必须 |  | 付款银行 |
| ├─ rechargeRuleId | string | 非必须 |  | 充值满足活动规则ID |
| ├─ payType | string | 非必须 |  | 充值支付方式 |
| ├─ feeType | string | 非必须 |  | 货币类型 |
| ├─ curFeeType | string | 非必须 |  | 系统配置货币类型 |
| ├─ curFeeRate | string | 非必须 |  | 系统配置货币汇率 |
| ├─ curFeeSymbol | string | 非必须 |  | 系统配置货币符号 |
| ├─ curPayFee | string | 非必须 |  | 系统货币支付金额 |
获取充值面额规则
基本信息
Path： /api/h5app/weapp/deposit/rechargerules
Method： GET
接口描述：
获取充值面额规则
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页条数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ companyId | string | 非必须 |  | 企业ID |
| ├─ money | string | 非必须 |  | 充值固定金额 |
| ├─ ruleType | string | 非必须 |  | 充值规则类型 |
| ├─ ruleData | string | 非必须 |  | 充值规则数据 |
| ├─ createTime | string | 非必须 |  | 创建时间 |
系统
上传图片
基本信息
Path： /api/h5app/espier/uploadeLocalImage
Method： POST
接口描述：
保存图片
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ image_url | string | 非必须 |  |  |
上传图片至OSS
基本信息
Path： /api/h5app/wxapp/espier/image_upload
Method： POST
接口描述：
获取上传图片token
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| filesystem
| 是
|
| 文件系统名称
| filename
| 是
|
| 上传文件名称
| group
| 否
|
| 上传文件类型,item 商品，aftersales 售后
| file
| 是
|
| 上传文件(二进制)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ token | string | 非必须 |  |  |
| ├─ domain | string | 非必须 |  | 图片域名 |
| ├─ region | string | 非必须 |  |  |
| ├─ key | string | 非必须 |  | 图片路径 |
获取上传图片token
基本信息
Path： /api/h5app/wxapp/espier/image_upload_token
Method： POST
接口描述：
获取上传图片token
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| filesystem
| 是
|
| 文件系统名称
| filename
| 是
|
| 上传文件名称
| group
| 否
|
| 上传文件类型,item 商品，aftersales 售后
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ token | string | 非必须 |  |  |
| ├─ domain | string | 非必须 |  |  |
| ├─ region | string | 非必须 |  |  |
| ├─ key | string | 非必须 |  |  |
获取地址
基本信息
Path： /api/h5app/wxapp/espier/address
Method： GET
接口描述：
获取地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ value | string | 非必须 |  | 编码 |
| ├─ label | string | 非必须 |  | 地址 |
| ├─ parent_id | string | 非必须 |  | 父级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 自行更改字段描述 |
| ├─ value | string | 非必须 |  | 自行更改字段描述 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级 | 父级id | 父分类id,顶级为0 |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 自行更改字段描述 |
| ├─ value | string | 非必须 |  | 自行更改字段描述 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级 | 父级id | 父分类id,顶级为0 |
| ├─ path | string | 非必须 |  | 路径 |
统计
统计浏览人数
基本信息
Path： /api/h5app/wxapp/track/viewnum
Method： POST
接口描述：
统计浏览人数
请求参数
Query
参数名称
是否必须
示例
备注
| monitor_id
| 是
|
| 门店ID
| source_id
| 是
|
| 交易商品ID
返回数据
成功返回结构
汇付天下
保存汇付取现银行卡
基本信息
Path： /api/h5app/wxapp/hfpay/banksave
Method： GET
接口描述：
保存汇付取现银行卡
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| bank_name
| 是
|
| 银行名称
| card_num
| 是
|
| 银行卡号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ hfpay_bank_card_id | integer | 非必须 |  | 汇付取现银行卡表id |
| ├─ company_id | integer | 非必须 |  | 公司company id |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ user_cust_id | stirng | 非必须 |  | 汇付客户号 |
| ├─ card_type | stirng | 非必须 |  | 绑卡类型 |
| ├─ bank_id | stirng | 非必须 |  | 银行编码code |
| ├─ bank_name | stirng | 非必须 |  | 银行名称 |
| ├─ card_num | stirng | 非必须 |  | 银行卡号 |
| ├─ bind_card_id | stirng | 非必须 |  | 汇付绑定id |
| ├─ is_cash | stirng | 非必须 |  | 是否取现卡 |
| ├─ created_at | datetime | 非必须 |  | 创建时间 |
| ├─ updated_at | datetime | 非必须 |  | 修改时间 |
分销员入驻
基本信息
Path： /api/h5app/hfpay/saveDistributor
Method： GET
接口描述：
分销员入驻
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| user_name
| 是
|
| 用户姓名
| id_card
| 是
|
| 证件号
| user_mobile
| 是
|
| 手机号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ hfpay_enterapply_id | integer | 非必须 |  | 法人证件类型 |
| ├─ company_id | integer | 非必须 |  | 公司company id |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ user_cust_id | stirng | 非必须 |  | 汇付客户号 |
| ├─ acct_id | stirng | 非必须 |  | 汇付子账户 |
| ├─ apply_type | stirng | 非必须 |  | 入驻类型 |
| ├─ corp_license_type | stirng | 非必须 |  | 企业证照类型 |
| ├─ corp_name | stirng | 非必须 |  | 企业名称 |
| ├─ business_code | stirng | 非必须 |  | 营业执照注册号 |
| ├─ institution_code | stirng | 非必须 |  | 组织机构代码 |
| ├─ tax_code | stirng | 非必须 |  | 税务登记证号 |
| ├─ social_credit_code | stirng | 非必须 |  | 统一社会信用代码 |
| ├─ license_start_date | stirng | 非必须 |  | 证照起始日期 |
| ├─ license_end_date | stirng | 非必须 |  | 证照结束日期 |
| ├─ controlling_shareholder | stirng | 非必须 |  | 实际控股人 |
| ├─ legal_name | stirng | 非必须 |  | 法人姓名 |
| ├─ legal_id_card_type | stirng | 非必须 |  | 法人证件类型 |
| ├─ legal_id_card | stirng | 非必须 |  | 法人证件号码 |
| ├─ legal_cert_start_date | stirng | 非必须 |  | 法人证件起始日期 |
| ├─ legal_cert_end_date | stirng | 非必须 |  | 法人证件结束日期 |
| ├─ legal_mobile | stirng | 非必须 |  | 法人手机号码 |
| ├─ contact_name | stirng | 非必须 |  | 企业联系人姓名 |
| ├─ contact_mobile | stirng | 非必须 |  | 企业联系人手机号 |
| ├─ contact_email | stirng | 非必须 |  | 联系人邮箱 |
| ├─ bank_acct_name | stirng | 非必须 |  | 开户银行账户名 |
| ├─ bank_id | stirng | 非必须 |  | 开户银行 |
| ├─ bank_acct_num | stirng | 非必须 |  | 开户银行账号 |
| ├─ bank_prov | stirng | 非必须 |  | 开户银行省份 |
| ├─ bank_area | stirng | 非必须 |  | 开户银行地区 |
| ├─ solo_name | stirng | 非必须 |  | 个体户名称 |
| ├─ solo_business_address | stirng | 非必须 |  | 个体户经营地址 |
| ├─ solo_reg_address | stirng | 非必须 |  | 个体户注册地址 |
| ├─ solo_fixed_telephone | stirng | 非必须 |  | 个体户固定电话 |
| ├─ business_scope | stirng | 非必须 |  | 经营范围 |
| ├─ occupation | stirng | 非必须 |  | 职业 |
| ├─ user_name | stirng | 非必须 |  | 用户姓名 |
| ├─ id_card_type | stirng | 非必须 |  | 证件类型 |
| ├─ id_card | stirng | 非必须 |  | 身份证号 |
| ├─ user_mobile | stirng | 非必须 |  | 手机号 |
| ├─ hf_order_id | stirng | 非必须 |  | 汇付订单号 |
| ├─ hf_order_date | stirng | 非必须 |  | 汇付订单日期 |
| ├─ status | stirng | 非必须 |  | 状态 |
| ├─ business_code_img | stirng | 非必须 |  | 营业执照注册号图片 |
| ├─ institution_code_img | stirng | 非必须 |  | 组织机构代码图片 |
| ├─ tax_code_img | stirng | 非必须 |  | 税务登记证号图片 |
| ├─ social_credit_code_img | stirng | 非必须 |  | 统一社会信用代码图片 |
| ├─ legal_card_imgz | stirng | 非必须 |  | 法人身份证正面照 |
| ├─ legal_card_imgf | stirng | 非必须 |  | 法人身份证反面照 |
| ├─ created_at | datetime | 非必须 |  | 创建时间 |
| ├─ updated_at | datetime | 非必须 |  | 最后修改时间 |
| ├─ business_code_img_local | stirng | 非必须 |  | 本地营业执照注册号图片 |
| ├─ institution_code_img_local | stirng | 非必须 |  | 本地组织机构代码图片 |
| ├─ tax_code_img_local | stirng | 非必须 |  | 本地税务登记证号图片 |
| ├─ social_credit_code_img_local | stirng | 非必须 |  | 本地统一社会信用代码图片 |
| ├─ legal_card_imgz_local | stirng | 非必须 |  | 本地法人身份证正面照 |
| ├─ legal_card_imgf_local | stirng | 非必须 |  | 本地法人身份证反面照 |
| ├─ bank_name | stirng | 非必须 |  | 开户银行名称 |
| ├─ bank_prov_name | stirng | 非必须 |  | 开户银行省份名称 |
| ├─ bank_area_name | stirng | 非必须 |  | 开户银行地区名称 |
| ├─ resp_code | stirng | 非必须 |  | 汇付响应码 |
| ├─ resp_desc | stirng | 非必须 |  | 汇付响应码描述 |
| ├─ hf_apply_id | stirng | 非必须 |  | 汇付开户申请号 |
| ├─ bank_acct_img | stirng | 非必须 |  | 开户银行许可证图片 |
| ├─ bank_acct_img_local | stirng | 非必须 |  | 本地开户银行许可证图片 |
| ├─ bank_branch | stirng | 非必须 |  | 企业开户银行的支行名称 |
获取汇付取现银行卡
基本信息
Path： /api/h5app/hfpay/bank
Method： GET
接口描述：
获取汇付取现银行卡
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| user_id
| 是
|
| 用户ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ hfpay_bank_card_id | integer | 非必须 |  | 汇付取现银行卡表id |
| ├─ company_id | integer | 非必须 |  | 公司company id |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ user_cust_id | stirng | 非必须 |  | 汇付客户号 |
| ├─ card_type | stirng | 非必须 |  | 绑卡类型 |
| ├─ bank_id | stirng | 非必须 |  | 银行编码code |
| ├─ bank_name | stirng | 非必须 |  | 银行名称 |
| ├─ card_num | stirng | 非必须 |  | 银行卡号 |
| ├─ bind_card_id | stirng | 非必须 |  | 汇付绑定id |
| ├─ is_cash | stirng | 非必须 |  | 是否取现卡 |
| ├─ created_at | datetime | 非必须 |  | 创建时间 |
| ├─ updated_at | datetime | 非必须 |  | 修改时间 |
获取汇付取现银行卡多条
基本信息
Path： /api/h5app/hfpay/banklist
Method： GET
接口描述：
获取汇付取现银行卡多条
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| user_id
| 是
|
| 用户ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ hfpay_bank_card_id | integer | 非必须 |  | 汇付取现银行卡表id |
| ├─ company_id | integer | 非必须 |  | 公司company id |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ user_cust_id | stirng | 非必须 |  | 汇付客户号 |
| ├─ card_type | stirng | 非必须 |  | 绑卡类型 |
| ├─ bank_id | stirng | 非必须 |  | 银行编码code |
| ├─ bank_name | stirng | 非必须 |  | 银行名称 |
| ├─ card_num | stirng | 非必须 |  | 银行卡号 |
| ├─ bind_card_id | stirng | 非必须 |  | 汇付绑定id |
| ├─ is_cash | stirng | 非必须 |  | 是否取现卡 |
| ├─ created_at | datetime | 非必须 |  | 创建时间 |
| ├─ updated_at | datetime | 非必须 |  | 修改时间 |
获取经销商入驻信息
基本信息
Path： /api/h5app/hfpay/userapply
Method： GET
接口描述：
获取经销商入驻信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ hfpay_enterapply_id | integer | 非必须 |  | 法人证件类型 |
| ├─ company_id | integer | 非必须 |  | 公司company id |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ user_cust_id | stirng | 非必须 |  | 汇付客户号 |
| ├─ acct_id | stirng | 非必须 |  | 汇付子账户 |
| ├─ apply_type | stirng | 非必须 |  | 入驻类型 |
| ├─ corp_license_type | stirng | 非必须 |  | 企业证照类型 |
| ├─ corp_name | stirng | 非必须 |  | 企业名称 |
| ├─ business_code | stirng | 非必须 |  | 营业执照注册号 |
| ├─ institution_code | stirng | 非必须 |  | 组织机构代码 |
| ├─ tax_code | stirng | 非必须 |  | 税务登记证号 |
| ├─ social_credit_code | stirng | 非必须 |  | 统一社会信用代码 |
| ├─ license_start_date | stirng | 非必须 |  | 证照起始日期 |
| ├─ license_end_date | stirng | 非必须 |  | 证照结束日期 |
| ├─ controlling_shareholder | stirng | 非必须 |  | 实际控股人 |
| ├─ legal_name | stirng | 非必须 |  | 法人姓名 |
| ├─ legal_id_card_type | stirng | 非必须 |  | 法人证件类型 |
| ├─ legal_id_card | stirng | 非必须 |  | 法人证件号码 |
| ├─ legal_cert_start_date | stirng | 非必须 |  | 法人证件起始日期 |
| ├─ legal_cert_end_date | stirng | 非必须 |  | 法人证件结束日期 |
| ├─ legal_mobile | stirng | 非必须 |  | 法人手机号码 |
| ├─ contact_name | stirng | 非必须 |  | 企业联系人姓名 |
| ├─ contact_mobile | stirng | 非必须 |  | 企业联系人手机号 |
| ├─ contact_email | stirng | 非必须 |  | 联系人邮箱 |
| ├─ bank_acct_name | stirng | 非必须 |  | 开户银行账户名 |
| ├─ bank_id | stirng | 非必须 |  | 开户银行 |
| ├─ bank_acct_num | stirng | 非必须 |  | 开户银行账号 |
| ├─ bank_prov | stirng | 非必须 |  | 开户银行省份 |
| ├─ bank_area | stirng | 非必须 |  | 开户银行地区 |
| ├─ solo_name | stirng | 非必须 |  | 个体户名称 |
| ├─ solo_business_address | stirng | 非必须 |  | 个体户经营地址 |
| ├─ solo_reg_address | stirng | 非必须 |  | 个体户注册地址 |
| ├─ solo_fixed_telephone | stirng | 非必须 |  | 个体户固定电话 |
| ├─ business_scope | stirng | 非必须 |  | 经营范围 |
| ├─ occupation | stirng | 非必须 |  | 职业 |
| ├─ user_name | stirng | 非必须 |  | 用户姓名 |
| ├─ id_card_type | stirng | 非必须 |  | 证件类型 |
| ├─ id_card | stirng | 非必须 |  | 身份证号 |
| ├─ user_mobile | stirng | 非必须 |  | 手机号 |
| ├─ hf_order_id | stirng | 非必须 |  | 汇付订单号 |
| ├─ hf_order_date | stirng | 非必须 |  | 汇付订单日期 |
| ├─ status | stirng | 非必须 |  | 状态 |
| ├─ business_code_img | stirng | 非必须 |  | 营业执照注册号图片 |
| ├─ institution_code_img | stirng | 非必须 |  | 组织机构代码图片 |
| ├─ tax_code_img | stirng | 非必须 |  | 税务登记证号图片 |
| ├─ social_credit_code_img | stirng | 非必须 |  | 统一社会信用代码图片 |
| ├─ legal_card_imgz | stirng | 非必须 |  | 法人身份证正面照 |
| ├─ legal_card_imgf | stirng | 非必须 |  | 法人身份证反面照 |
| ├─ created_at | datetime | 非必须 |  | 创建时间 |
| ├─ updated_at | datetime | 非必须 |  | 最后修改时间 |
| ├─ business_code_img_local | stirng | 非必须 |  | 本地营业执照注册号图片 |
| ├─ institution_code_img_local | stirng | 非必须 |  | 本地组织机构代码图片 |
| ├─ tax_code_img_local | stirng | 非必须 |  | 本地税务登记证号图片 |
| ├─ social_credit_code_img_local | stirng | 非必须 |  | 本地统一社会信用代码图片 |
| ├─ legal_card_imgz_local | stirng | 非必须 |  | 本地法人身份证正面照 |
| ├─ legal_card_imgf_local | stirng | 非必须 |  | 本地法人身份证反面照 |
| ├─ bank_name | stirng | 非必须 |  | 开户银行名称 |
| ├─ bank_prov_name | stirng | 非必须 |  | 开户银行省份名称 |
| ├─ bank_area_name | stirng | 非必须 |  | 开户银行地区名称 |
| ├─ resp_code | stirng | 非必须 |  | 汇付响应码 |
| ├─ resp_desc | stirng | 非必须 |  | 汇付响应码描述 |
| ├─ hf_apply_id | stirng | 非必须 |  | 汇付开户申请号 |
| ├─ bank_acct_img | stirng | 非必须 |  | 开户银行许可证图片 |
| ├─ bank_acct_img_local | stirng | 非必须 |  | 本地开户银行许可证图片 |
| ├─ bank_branch | stirng | 非必须 |  | 企业开户银行的支行名称 |
解绑删除汇付取现银行卡
基本信息
Path： /api/h5app/hfpay/bankdel
Method： DELETE
接口描述：
解绑删除汇付取现银行卡
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| card_num
| 是
|
| 银行卡号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ result | boolean | 非必须 |  | 删除状态 true 删除成功 false 删除失败 |
IM
获取一洽配置
基本信息
Path： /api/h5app/wxapp/im/echat
Method： GET
接口描述：
获取一洽配置
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ is_open | string | 非必须 |  | 是否开启 |
| ├─ echat_url | string | 非必须 |  | 一洽客服链接 |
获取店铺美洽配置
基本信息
Path： /api/h5app/wxapp/im/meiqia/distributor/{distributor_id}
Method： GET
接口描述：
获取店铺美洽配置
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| distributor_id
|
| 店铺id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ meiqia_id | string | 非必须 |  | 美洽ID |
| ├─ meiqia_token | string | 非必须 |  | 美洽token |
获取美洽配置
基本信息
Path： /api/h5app/wxapp/im/meiqia
Method： GET
接口描述：
获取美洽配置
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| type
|
| 客服类型 backend frontend
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ is_open | boolean | 非必须 |  | 售前客服状态 |
| ├─ is_distributor_open | boolean | 非必须 |  | 店铺客服状态 |
| ├─ enterprise_id | string | 非必须 |  | 企业ID |
| ├─ group_id | string | 非必须 |  | 客服组ID |
| ├─ persion_ids | string | 非必须 |  | 客服ID |
| ├─ type | string | 非必须 |  | im配置类型: all backend frontend |
评论
创建评论
基本信息
Path： /api/h5app/wxapp/comment
Method： POST
接口描述：
创建评论
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店id
| content
| 否
|
| 评论内容
| pics
| 否
|
| 评论图片
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ comment_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ user_id | integer | 非必须 |  |  |
| ├─ shop_id | integer | 非必须 |  |  |
| ├─ content | string | 非必须 |  |  |
| ├─ stuck | boolean | 非必须 |  |  |
| ├─ hid | boolean | 非必须 |  |  |
| ├─ source | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ pics |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
获取评论列表
基本信息
Path： /api/h5app/wxapp/comments
Method： GET
接口描述：
获取评论列表
请求参数
Query
参数名称
是否必须
示例
备注
| page_no
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| page_size
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| shop_id
| 否
|
| 店铺id
| is_hide
| 否
|
| 是否隐藏
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ comment_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ user_id | integer | 非必须 |  |  |
| ├─ shop_id | integer | 非必须 |  |  |
| ├─ content | string | 非必须 |  |  |
| ├─ stuck | boolean | 非必须 |  |  |
| ├─ hid | boolean | 非必须 |  |  |
| ├─ source | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ pics |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
会员
地址详情
基本信息
Path： /api/h5app/wxapp/member/address/{address_id}
Method： GET
接口描述：
地址详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| address_id
|
| 地址id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ address_id | string | 非必须 | 415 | 地址id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ user_id | string | 非必须 | 20264 | 用户id |
| ├─ username | string | 非必须 | 张三 | 名称 |
| ├─ telephone | string | 非必须 | 18890908989 | 手机号码 |
| ├─ area | string | 非必须 | null | 地区 |
| ├─ province | string | 非必须 | 广东省 | 省 |
| ├─ city | string | 非必须 | 广州市 | 市 |
| ├─ county | string | 非必须 | 海珠区 | 区 |
| ├─ adrdetail | string | 非必须 | 新港中路397号 | 详细地址 |
| ├─ postalCode | string | 非必须 | 510000 | 邮编 |
| ├─ is_def | string | 非必须 | true | 是否默认地址 |
| ├─ created | string | 非必须 | 1598846042 |  |
| ├─ updated | string | 非必须 | 1598846042 | 修改时间 |
| ├─ third_data | string | 非必须 | null | 百胜等第三方返回的数据 |
| ├─ lat | string | 非必须 |  | 经度 |
| ├─ lng | string | 非必须 |  | 纬度 |
H5刷新Token
基本信息
Path： /api/h5app/token/refresh
Method： GET
接口描述：
刷新Token
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ result | boolean | 非必须 |  |  |
会员地址列表
基本信息
Path： /api/h5app/wxapp/member/addresslist
Method： GET
接口描述：
地址列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| address_id
| 否
|
| 地址列表
| page
| 否
|
| 页码
| pageSize
| 否
|
| 条数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ address_id | string | 非必须 | 415 | 地址id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ user_id | string | 非必须 | 20264 | 用户id |
| ├─ username | string | 非必须 | 张三 | 名称 |
| ├─ telephone | string | 非必须 | 18890908989 | 手机号码 |
| ├─ area | string | 非必须 | null | 地区 |
| ├─ province | string | 非必须 | 广东省 | 省 |
| ├─ city | string | 非必须 | 广州市 | 市 |
| ├─ county | string | 非必须 | 海珠区 | 区 |
| ├─ adrdetail | string | 非必须 | 新港中路397号 | 详细地址 |
| ├─ postalCode | string | 非必须 | 510000 | 邮编 |
| ├─ is_def | string | 非必须 | true | 是否默认地址 |
| ├─ created | string | 非必须 | 1598846042 |  |
| ├─ updated | string | 非必须 | 1598846042 | 修改时间 |
| ├─ third_data | string | 非必须 | null | 百胜等第三方返回的数据 |
| ├─ lat | string | 非必须 |  | 经度 |
| ├─ lng | string | 非必须 |  | 纬度 |
会员心愿单收藏数量
基本信息
Path： /api/h5app/wxapp/member/collect/article/num
Method： GET
接口描述：
会员心愿单收藏数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总数 |
会员收藏商品列表
基本信息
Path： /api/h5app/wxapp/member/collect/item
Method： GET
接口描述：
商品收藏列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| page
|
| 页码
| pageSize
|
| 条数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ fav_id | string | 非必须 |  | 收藏id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_image | string | 非必须 |  | 商品图片 |
| ├─ item_price | string | 非必须 |  | 商品价格 |
| ├─ item_type | string | 非必须 |  | 商品类型 normal:普通商品 pointsmall:积分商城商品 |
| ├─ point | string | 非必须 |  | 积分商城商品的积分价格 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ price | string | 非必须 |  | 商品价格 |
会员收藏商品数量
基本信息
Path： /api/h5app/wxapp/member/collect/item/num
Method： GET
接口描述：
会员收藏商品数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ fav_total_count | string | 非必须 |  | 收藏总数 |
会员收藏店铺列表
基本信息
Path： /api/h5app/wxapp/member/collect/distribution
Method： GET
接口描述：
会员收藏店铺列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ child_count | string | 非必须 |  | 导购员引入的会员数 |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_default | string | 非必须 |  | 是否是默认门店 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ review_status | string | 非必须 |  | 入驻审核状态，0未审核，1已审核 |
| ├─ source_from | string | 非必须 |  | 店铺来源，1管理端添加，2小程序申请入驻 | 来源类型 default默认 |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ contract_phone | string | 非必须 |  | 联系电话 |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ regionauth_id | string | 非必须 |  | 地区id |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ rate | string | 非必须 |  | 平台服务费率 |
| ├─ store_address | string | 非必须 |  | 门店地址 |
| ├─ store_name | string | 非必须 |  | 门店名称 |
| ├─ phone | string | 非必须 |  |  |
| ├─ distance_show | string | 非必须 |  |  |
| ├─ distance_unit | string | 非必须 |  |  |
| ├─ fav_num | string | 非必须 |  |  |
会员收藏店铺数量
基本信息
Path： /api/h5app/wxapp/member/collect/distribution/num
Method： GET
接口描述：
会员收藏店铺数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总数 |
会员收藏心愿单列表
基本信息
Path： /api/h5app/wxapp/member/collect/article
Method： GET
接口描述：
会员收藏心愿单列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页码
| pageSize
| 否
|
| 条数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ article_id | string | 非必须 |  | 文章id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ summary | string | 非必须 |  | 摘要 |
| ├─ content | string | 非必须 |  | 文章详细内容 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ image_url | string | 非必须 |  | 文章封面 |
| ├─ share_image_url | string | 非必须 |  | 分享图片 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ author | string | 非必须 |  | 作者 |
| ├─ operator_id | string | 非必须 |  | 作者id |
| ├─ release_time | string | 非必须 |  | 文章发布时间 |
| ├─ article_type | string | 非必须 |  | 文章类型，general:普通文章; bring:带货文章 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ head_portrait | string | 非必须 |  | 作者头像 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 文章类目id |
会员收藏心愿单详情
基本信息
Path： /api/h5app/wxapp/member/collect/article/info
Method： GET
接口描述：
会员收藏心愿单详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ article_id | string | 非必须 |  | 文章id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ summary | string | 非必须 |  | 摘要 |
| ├─ content | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  | 名称 |
| ├─ base | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ subtitle | string | 非必须 |  | 副标题 |
| ├─ padded | string | 非必须 |  |  |
| ├─ config | object | 非必须 |  |  |
| ├─ align | string | 非必须 |  | 配置 |
| ├─ data | object [] | 非必须 |  |  |
item 类型: object
| ├─ content | string | 非必须 |  | 文章详细内容  |
| ├─ sort | string | 非必须 |  | 文章排序 |
| ├─ image_url | string | 非必须 |  | 文章封面 |
| ├─ share_image_url | string | 非必须 |  | 分享图片 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ author | string | 非必须 |  | 作者 |
| ├─ operator_id | string | 非必须 |  | 作者id |
| ├─ release_status | string | 非必须 |  | 文章发布状态 |
| ├─ release_time | string | 非必须 |  | 文章发布时间 |
| ├─ article_type | string | 非必须 |  | 文章类型，general:普通文章; bring:带货文章 |
| ├─ distributor_id | string | 非必须 |  | 店铺id |
| ├─ head_portrait | string | 非必须 |  | 作者头像 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 文章类目id |
会员绑定
基本信息
Path： /api/h5app/wxapp/member/bind
Method： GET
接口描述：
会员绑定
请求参数
Query
参数名称
是否必须
示例
备注
| company_id
| 是
|
| company_id
| username
| 是
|
| 会员手机号
| vcode
| 否
|
| 短信验证码的值
| check_type
| 否
|
| login 登录验证码
| password
| 否
|
| 会员密码
| union_id
| 否
|
| union_id
| open_id
| 否
|
| open_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ token | string | 非必须 |  |  |
保存商品浏览记录
基本信息
Path： /api/h5app/wxapp/member/browse/history/save
Method： POST
接口描述：
保存商品浏览记录
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| item_id
| 是
|
| 商品ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
修改会员信息
基本信息
Path： /api/h5app/wxapp/member
Method： PUT
接口描述：
修改会员信息
请求参数
Query
参数名称
是否必须
示例
备注
| mobile
| 是
|
| 手机号
| country
| 否
|
| 国家
| province
| 否
|
| 省份
| city
| 否
|
| 城市
| language
| 否
|
| 语言
| username
| 是
|
| 姓名
| avatar
| 是
|
| 头像
| sex
| 是
|
| 性别, 这里给文字，后端根据文字来自行处理
| birthday
| 是
|
| 生日，例2021-05-10
| address
| 是
|
| 家庭住址
| email
| 是
|
| 常用邮箱
| industry
| 是
|
| 从事行业
| income
| 是
|
| 年收入
| edu_background
| 是
|
| 学历, 这里给文字，后端根据文字来自行处理
| habbit.*.name
| 是
|
| 爱好多选项中的name，即多选项中的文字描述
| habbit.*.ischecked
| 是
|
| 该爱好是否被选中, true表示被选中, false表示未选中
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 必须 |  | 用户id |
| ├─ company_id | string | 必须 |  | 公司id |
| ├─ grade_id | string | 必须 |  | 等级ID | 等级id | 会员等级 |
| ├─ mobile | string | 必须 |  | 手机号 |
| ├─ user_card_code | string | 必须 |  | 会员卡号 |
| ├─ offline_card_code | string | 必须 |  | 线下会员卡号 |
| ├─ inviter_id | string | 必须 |  | 推荐人id |
| ├─ source_from | string | 必须 |  | 来源类型 default默认 |
| ├─ source_id | string | 必须 |  | 来源id |
| ├─ monitor_id | string | 必须 |  | 监控id |
| ├─ latest_source_id | string | 必须 |  | 最近来源id |
| ├─ latest_monitor_id | string | 必须 |  | 最近监控页面id |
| ├─ authorizer_appid | string | 必须 |  | 公众号的appid |
| ├─ use_point | string | 必须 |  | 是否可以使用积分 |
| ├─ wxa_appid | string | 必须 |  | 小程序的appid |
| ├─ created | string | 必须 |  |  |
| ├─ updated | string | 必须 |  | 修改时间 |
| ├─ disabled | string | 必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ remarks | string | 必须 |  | 备注 |
| ├─ third_data | string | 必须 |  | 百胜等第三方返回的数据 |
| ├─ username | string | 必须 |  | 名称 |
| ├─ avatar | string | 必须 |  | 头像 |
| ├─ sex | string | 必须 |  | 性别。0 未知；1 男；2 女 |
| ├─ birthday | string | 必须 |  | 出生日期 |
| ├─ address | string | 必须 |  | 具体地址 |
| ├─ email | string | 必须 |  | 常用邮箱 |
| ├─ industry | string | 必须 |  | 所属行业 | 从事行业 |
| ├─ income | string | 必须 |  | 收入 |
| ├─ edu_background | string | 必须 |  | 学历 |
| ├─ habbit | string [] | 必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 爱好 |
| ├─ have_consume | string | 必须 |  | 是否有消费 |
修改会员信息（不使用通用的验证规则）
基本信息
Path： /api/h5app/wxapp/memberinfo
Method： PUT
接口描述：
修改会员信息（不使用通用的验证规则）
请求参数
Query
参数名称
是否必须
示例
备注
| username
| 是
|
| 姓名
| avatar
| 是
|
| 头像
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ user_id | string | 必须 | 20264 | 用户id |
| ├─ company_id | string | 必须 | 1 | 公司id |
| ├─ grade_id | string | 必须 | 4 | 等级ID | 等级id | 会员等级 |
| ├─ mobile | string | 必须 | 18321148690 | 手机号 |
| ├─ user_card_code | string | 必须 | 324A50B01181 | 会员卡号 |
| ├─ offline_card_code | string | 必须 | null | 线下会员卡号 |
| ├─ inviter_id | string | 必须 | 0 | 推荐人id |
| ├─ source_from | string | 必须 | default | 来源类型 default默认 |
| ├─ source_id | string | 必须 | 0 | 来源id |
| ├─ monitor_id | string | 必须 | 0 | 监控id |
| ├─ latest_source_id | string | 必须 | 0 | 最近来源id |
| ├─ latest_monitor_id | string | 必须 | 0 | 最近监控页面id |
| ├─ authorizer_appid | string | 必须 | wx6b8c2837f47e8a09 | 公众号的appid |
| ├─ use_point | string | 必须 | false | 是否可以使用积分 |
| ├─ wxa_appid | string | 必须 | wx912913df9fef6ddd | 小程序的appid |
| ├─ created | string | 必须 | 1598845028 |  |
| ├─ updated | string | 必须 | 1600917506 | 修改时间 |
| ├─ disabled | string | 必须 | false | 是否禁用 true=禁用,false=启用 |
| ├─ remarks | string | 必须 | null | 备注 |
| ├─ third_data | string | 必须 | 100102866937 | 百胜等第三方返回的数据 |
| ├─ username | string | 必须 | null | 名称 |
| ├─ avatar | string | 必须 | https://thirdwx.qlogo.cn/mmopen/vi_32/28Qz0boz9fjJYJiapHjxu5nNcBKDZMcNlrpctITqfTawwnsw8Wu9Af4k6DzIXlSv01m3nvxV48Nic9JsroJ9NuGA/132 | 头像 |
| ├─ sex | string | 必须 | 0 | 性别。0 未知；1 男；2 女 |
| ├─ birthday | string | 必须 | null | 出生日期 |
| ├─ address | string | 必须 | null | 具体地址 |
| ├─ email | string | 必须 | null | 常用邮箱 |
| ├─ industry | string | 必须 | null | 所属行业 | 从事行业 |
| ├─ income | string | 必须 | null | 收入 |
| ├─ edu_background | string | 必须 | null | 学历 |
| ├─ habbit | string [] | 必须 |  |  |
item 类型: string
| ├─  |  | 非必须 | undefined | 爱好 |
| ├─ have_consume | string | 必须 | true | 是否有消费 |
修改发票信息
基本信息
Path： /api/h5app/wxapp/member/invoices/{invoices_id}
Method： PUT
接口描述：
修改发票信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ invoices_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  |  |
| ├─ username | string | 非必须 |  |  |
| ├─ telephone | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ county | string | 非必须 |  |  |
| ├─ adrdetail | string | 非必须 |  |  |
| ├─ postalCode | string | 非必须 |  |  |
| ├─ is_def | string | 非必须 |  |  |
修改密码
基本信息
Path： /api/h5app/wxapp/member/reset/password
Method： POST
接口描述：
修改密码
请求参数
Query
参数名称
是否必须
示例
备注
| mobile
| 是
|
| 手机号
| password
| 是
|
| 密码
| vcode
| 是
|
| 验证码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ grade_id | string | 非必须 |  | 等级ID | 等级id | 会员等级 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ user_card_code | string | 非必须 |  | 会员卡号 |
| ├─ offline_card_code | string | 非必须 |  | 线下会员卡号 |
| ├─ inviter_id | string | 非必须 |  | 推荐人id |
| ├─ source_from | string | 非必须 |  | 来源类型 default默认 |
| ├─ source_id | string | 非必须 |  | 来源id |
| ├─ monitor_id | string | 非必须 |  | 监控id |
| ├─ latest_source_id | string | 非必须 |  | 最近来源id |
| ├─ latest_monitor_id | string | 非必须 |  | 最近监控页面id |
| ├─ authorizer_appid | string | 非必须 |  | 公众号的appid |
| ├─ use_point | string | 非必须 |  | 是否可以使用积分 |
| ├─ wxa_appid | string | 非必须 |  | 小程序的appid |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ disabled | string | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ remarks | string | 非必须 |  | 备注 |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
修改收货地址
基本信息
Path： /api/h5app/wxapp/member/address/{address_id}
Method： PUT
接口描述：
修改收货地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| address_id
|
| 地址id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ address_id | string | 非必须 | 415 | 地址id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ user_id | string | 非必须 | 20264 | 用户id |
| ├─ username | string | 非必须 | 张三 | 名称 |
| ├─ telephone | string | 非必须 | 18890908989 | 手机号码 |
| ├─ area | string | 非必须 | null | 地区 |
| ├─ province | string | 非必须 | 广东省 | 省 |
| ├─ city | string | 非必须 | 广州市 | 市 |
| ├─ county | string | 非必须 | 海珠区 | 区 |
| ├─ adrdetail | string | 非必须 | 新港中路397号 | 详细地址 |
| ├─ postalCode | string | 非必须 | 510000 | 邮编 |
| ├─ is_def | string | 非必须 | true | 是否默认地址 |
| ├─ created | string | 非必须 | 1598846042 |  |
| ├─ updated | string | 非必须 | 1598846042 | 修改时间 |
| ├─ third_data | string | 非必须 | null | 百胜等第三方返回的数据 |
| ├─ lat | string | 非必须 |  | 经度 |
| ├─ lng | string | 非必须 |  | 纬度 |
创建会员
基本信息
Path： /api/h5app/wxapp/member
Method： POST
接口描述：
获取会员信息
请求参数
Query
参数名称
是否必须
示例
备注
| mobile
| 是
|
| 手机号
| auth_type
| 否
|
| 登录类型：wxapp，wx_offiaccount
| company_id
| 否
|
| 企业ID
| password
| 否
|
| 登陆密码
| user_name
| 否
|
| 姓名
| user_type
| 是
|
| 用户类型
| sex
| 否
|
| 性别
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ token | string | 非必须 |  | 登录token |
删除发票
基本信息
Path： /api/h5app/wxapp/member/invoices/{invoices_id}
Method： DELETE
接口描述：
删除发票
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| invoices_id
|
| 发票id
返回数据
成功返回结构
删除地址
基本信息
Path： /api/h5app/wxapp/member/address/{address_id}
Method： DELETE
接口描述：
删除地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| address_id
|
| 地址id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ address_id | string | 非必须 |  | 地址id |
删除收藏商品
基本信息
Path： /api/h5app/wxapp/member/collect/item
Method： DELETE
接口描述：
删除收藏商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 结果状态 |
删除收藏店铺
基本信息
Path： /api/h5app/wxapp/member/collect/distribution
Method： DELETE
接口描述：
删除收藏店铺
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
删除收藏心愿单
基本信息
Path： /api/h5app/wxapp/member/collect/article
Method： DELETE
接口描述：
删除收藏心愿单
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
发票详情
基本信息
Path： /api/h5app/wxapp/member/invoices/{invoices_id}
Method： GET
接口描述：
发票详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| invoices_id
|
| 发票id
返回数据
成功返回结构
商品缺货通知订阅
基本信息
Path： /api/h5app/wxapp/member/subscribe/item/{item_id}
Method： POST
接口描述：
商品缺货通知订阅
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 标题 |
地区列表(废弃)
基本信息
Path： /api/h5app/wxapp/member/address_area
Method： GET
接口描述：
地区列表(废弃)
请求参数
返回数据
成功返回结构
会员发票列表
基本信息
Path： /api/h5app/wxapp/member/invoiceslist
Method： GET
接口描述：
会员发票列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
成功返回结构
是否收藏店铺
基本信息
Path： /api/h5app/wxapp/member/collect/distribution/check
Method： GET
接口描述：
是否收藏店铺
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 店铺ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ is_fav | string | 非必须 |  | 是否收藏 |
更新会员手机号
基本信息
Path： /api/h5app/wxapp/member/mobile
Method： PUT
接口描述：
更新会员手机号
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| old_mobile
| 是
|
| 会员的旧手机
| old_region_mobile
| 是
|
| 会员的旧手机（带区号）
| old_country_code
| 是
|
| 会员的旧手机的区号
| new_mobile
| 是
|
| 会员的新手机
| new_region_mobile
| 是
|
| 会员的新手机（带区号）
| new_country_code
| 是
|
| 会员的新手机的区号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ user_id | string | 必须 |  |  |
| ├─ company_id | string | 必须 |  |  |
| ├─ grade_id | string | 必须 |  |  |
| ├─ mobile | string | 必须 |  |  |
| ├─ region_mobile | string | 必须 |  |  |
| ├─ user_card_code | string | 必须 |  |  |
| ├─ offline_card_code | string | 必须 |  |  |
| ├─ inviter_id | string | 必须 |  |  |
| ├─ source_from | string | 必须 |  |  |
| ├─ source_id | string | 必须 |  |  |
| ├─ monitor_id | string | 必须 |  |  |
| ├─ latest_source_id | string | 必须 |  |  |
| ├─ latest_monitor_id | string | 必须 |  |  |
| ├─ authorizer_appid | string | 必须 |  |  |
| ├─ use_point | string | 必须 |  |  |
| ├─ wxa_appid | string | 必须 |  |  |
| ├─ created | integer | 必须 |  |  |
| ├─ updated | integer | 必须 |  |  |
| ├─ disabled | string | 必须 |  |  |
| ├─ remarks | string | 必须 |  |  |
| ├─ third_data | string | 必须 |  |  |
添加发票信息
基本信息
Path： /api/h5app/wxapp/member/invoices
Method： POST
接口描述：
添加发票信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ invoices_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  |  |
| ├─ username | string | 非必须 |  |  |
| ├─ telephone | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ county | string | 非必须 |  |  |
| ├─ adrdetail | string | 非必须 |  |  |
| ├─ postalCode | string | 非必须 |  |  |
| ├─ is_def | string | 非必须 |  |  |
添加心愿单商品
基本信息
Path： /api/h5app/wxapp/member/collect/article/{article_id}
Method： POST
接口描述：
添加心愿单商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ fav_id | string | 非必须 |  | 收藏id |
| ├─ company_id | string | 非必须 |  | 公司id  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ article_id | string | 非必须 |  | 文章id |
| ├─ created | string | 非必须 |  |  |
添加收藏商品
基本信息
Path： /api/h5app/wxapp/member/collect/item/{item_id}
Method： POST
接口描述：
添加收藏商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ fav_id | string | 非必须 |  | 收藏id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_image | string | 非必须 |  | 商品图片 |
| ├─ item_price | string | 非必须 |  | 商品价格（分） |
| ├─ item_type | string | 非必须 |  | 商品类型 normal:普通商品 pointsmall:积分商城商品 |
| ├─ point | string | 非必须 |  | 积分商城商品的积分价格 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
添加收藏店铺
基本信息
Path： /api/h5app/wxapp/member/collect/distribution/{distributor_id}
Method： POST
接口描述：
添加收藏店铺
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ fav_id | string | 非必须 |  | 收藏id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ created | string | 非必须 |  |  |
添加收货地址
基本信息
Path： /api/h5app/wxapp/member/address
Method： POST
接口描述：
添加收货地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ address_id | string | 非必须 | 415 | 地址id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ user_id | string | 非必须 | 20264 | 用户id |
| ├─ username | string | 非必须 | 张三 | 名称 |
| ├─ telephone | string | 非必须 | 18890908989 | 手机号码 |
| ├─ area | string | 非必须 | null | 地区 |
| ├─ province | string | 非必须 | 广东省 | 省 |
| ├─ city | string | 非必须 | 广州市 | 市 |
| ├─ county | string | 非必须 | 海珠区 | 区 |
| ├─ adrdetail | string | 非必须 | 新港中路397号 | 详细地址 |
| ├─ postalCode | string | 非必须 | 510000 | 邮编 |
| ├─ is_def | string | 非必须 | true | 是否默认地址 |
| ├─ created | string | 非必须 | 1598846042 |  |
| ├─ updated | string | 非必须 | 1598846042 | 修改时间 |
| ├─ third_data | string | 非必须 | null | 百胜等第三方返回的数据 |
| ├─ lat | string | 非必须 |  | 经度 |
| ├─ lng | string | 非必须 |  | 纬度 |
用户登陆
基本信息
Path： /api/h5app/wxapp/login
Method： POST
接口描述：
用户登陆获取Token
请求参数
Query
参数名称
是否必须
示例
备注
| username
| 是
|
| 登陆用户名
| auth_type
| 是
|
| 登录类型:local
| password
| 否
|
| 登陆密码
| company_id
| 否
|
| 企业ID
| check_type
| 否
|
| 验证类型：mobile 手机验证码 password 密码
| vcode
| 否
|
| 短信验证码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ token | stirng | 非必须 |  |  |
绑定导购
基本信息
Path： /api/h5app/wxapp/member/bindSalesperson
Method： POST
接口描述：
绑定导购
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  |  |
获取POS会员基础信息
基本信息
Path： /api/h5app/wxapp/pos_member
Method： GET
接口描述：
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| user_code
| 是
|
| 卡号或者手机号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ customer | object | 非必须 |  |  |
| ├─ phone | string | 非必须 |  | 手机号码 |
| ├─ nick | string | 非必须 |  | 淘宝nick |
| ├─ tmallBoundStores | string [] | 非必须 |  | 天猫店铺编码 |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ points | number | 非必须 |  | 可用积分 |
| ├─ names | string | 非必须 |  | 姓名 |
| ├─ sex | string | 非必须 |  | 性别 F:女, M:男, N或字段未返回: 未知 |
| ├─ levels | string | 非必须 |  | 会员卡等级 |
| ├─ dbno | string | 非必须 |  |  |
| ├─ expiry | string | 非必须 |  |  |
| ├─ birthday | string | 非必须 |  |  |
| ├─ sms | string | 非必须 |  |  |
| ├─ mail | string | 非必须 |  |  |
| ├─ state | number | 非必须 |  |  |
| ├─ channel | string | 非必须 |  |  |
| ├─ consumption | string | 非必须 |  | 过去十二月消费金额 |
| ├─ amountToNextLevel | string | 非必须 |  | 到下一等级的差值金额 |
| ├─ levelExpireTime | string | 非必须 |  | 卡等级过期时间 |
| ├─ couponNumber | number | 非必须 |  |  |
| ├─ pmcode | string | 非必须 |  | 会员卡号 |
| ├─ unionid | string | 非必须 |  |  |
| ├─ pmdate | string | 非必须 |  |  |
| ├─ member_info | object | 非必须 |  | ECX会员信息 |
| ├─ user_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ grade_id | string | 非必须 |  |  |
| ├─ mobile | string | 非必须 |  |  |
| ├─ user_card_code | string | 非必须 |  |  |
| ├─ offline_card_code | null | 非必须 |  |  |
| ├─ inviter_id | string | 非必须 |  |  |
| ├─ source_from | string | 非必须 |  |  |
| ├─ source_id | string | 非必须 |  |  |
| ├─ monitor_id | string | 非必须 |  |  |
| ├─ latest_source_id | string | 非必须 |  |  |
| ├─ latest_monitor_id | string | 非必须 |  |  |
| ├─ authorizer_appid | string | 非必须 |  |  |
| ├─ use_point | boolean | 非必须 |  |  |
| ├─ points | number | 非必须 |  |  |
| ├─ wxa_appid | string | 非必须 |  |  |
| ├─ created | number | 非必须 |  |  |
| ├─ updated | number | 非必须 |  |  |
| ├─ disabled | boolean | 非必须 |  |  |
| ├─ remarks | null | 非必须 |  |  |
| ├─ username | string | 非必须 |  |  |
| ├─ avatar | string | 非必须 |  |  |
| ├─ sex | number | 非必须 |  |  |
| ├─ birthday | string | 非必须 |  |  |
| ├─ address | null | 非必须 |  |  |
| ├─ email | null | 非必须 |  |  |
| ├─ industry | null | 非必须 |  |  |
| ├─ income | null | 非必须 |  |  |
| ├─ edu_background | null | 非必须 |  |  |
| ├─ habbit | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ have_consume | boolean | 非必须 |  |  |
获取会员优惠券、积分、收藏商品数量
基本信息
Path： /api/h5app/wxapp/member/statistical
Method： GET
接口描述：
获取会员优惠券、积分、收藏商品数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ discount_total_count | string | 非必须 |  |  |
| ├─ point_total_count | string | 非必须 |  | 积分总数 |
| ├─ fav_total_count | string | 非必须 |  | 收藏总数 |
获取会员信息
基本信息
Path： /api/h5app/wxapp/member
Method： GET
接口描述：
获取会员信息
请求参数
Query
参数名称
是否必须
示例
备注
| open_id
| 否
|
| 用户表示
| card_id
| 否
|
| 卡券ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ memberInfo | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ grade_id | string | 非必须 |  | 等级ID | 等级id | 会员等级 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ user_card_code | string | 非必须 |  | 会员卡号 |
| ├─ offline_card_code | string | 非必须 |  | 线下会员卡号 |
| ├─ inviter_id | string | 非必须 |  | 推荐人id |
| ├─ source_from | string | 非必须 |  | 来源类型 default默认 |
| ├─ source_id | string | 非必须 |  | 来源id |
| ├─ monitor_id | string | 非必须 |  | 监控id |
| ├─ latest_source_id | string | 非必须 |  | 最近来源id |
| ├─ latest_monitor_id | string | 非必须 |  | 最近监控页面id |
| ├─ authorizer_appid | string | 非必须 |  | 公众号的appid |
| ├─ use_point | string | 非必须 |  | 是否可以使用积分 |
| ├─ wxa_appid | string | 非必须 |  | 小程序的appid |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ disabled | string | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ remarks | string | 非必须 |  | 备注 |
| ├─ third_data | string | 非必须 |  | 百胜等第三方返回的数据 |
| ├─ username | string | 非必须 |  | 名称 |
| ├─ avatar | string | 非必须 |  | 头像 |
| ├─ sex | string | 非必须 |  | 性别。0 未知；1 男；2 女 |
| ├─ birthday | string | 非必须 |  | 出生日期 |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ email | string | 非必须 |  | 常用邮箱 |
| ├─ industry | string | 非必须 |  | 所属行业 | 从事行业 |
| ├─ income | string | 非必须 |  | 收入 |
| ├─ edu_background | string | 非必须 |  | 学历 |
| ├─ habbit | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 爱好 |
| ├─ have_consume | string | 非必须 |  | 是否有消费 |
| ├─ userDiscountCount | string | 非必须 |  |  |
| ├─ deposit | string | 非必须 |  | 余额 |
| ├─ point | string | 非必须 |  | 积分 |
| ├─ coupon | string | 非必须 |  | 优惠券数量 |
| ├─ luckdraw | string | 非必须 |  |  |
| ├─ point_open_status | string | 非必须 |  | 积分开启状态 |
| ├─ cardInfo | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ brand_name | string | 非必须 |  | 商户名称 |
| ├─ logo_url | string | 非必须 |  | logo |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ code_type | string | 非必须 |  | 卡券码类型(CODE_TYPE_TEXT CODE_TYPE_BARCODE CODE_TYPE_QRCODE CODE_TYPE_ONLY_QRCODE CODE_TYPE_ONLY_BARCODE CODE_TYPE_NONE) |
| ├─ background_pic_url | string | 非必须 |  | 背景图 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ vipgrade | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ vip_type | string | 非必须 |  | 会员类型 |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ lv_type | string | 非必须 |  | 等级类型 |
| ├─ is_had_vip | string | 非必须 |  | 是否有过VIP |
| ├─ is_vip | string | 非必须 |  | 是否VIP |
| ├─ end_time | string | 非必须 |  | 结束时间 |
| ├─ day | string | 非必须 |  | 生日日期 |
| ├─ valid | string | 非必须 |  |  |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ discount | string | 非必须 |  | 折扣值 |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ guide_title | string | 非必须 |  | 购买引导文本 |
| ├─ background_pic_url | string | 非必须 |  | 商家自定义会员卡背景图 |
| ├─ is_open_popularize | string | 非必须 |  | 是否开启推广员分销 |
| ├─ is_staff | string | 非必须 |  | 是否员工 |
| ├─ is_recharge_status | string | 非必须 |  | 储值状态 |
获取会员可编辑信息
基本信息
Path： /api/h5app/wxapp/memberinfo
Method： GET
接口描述：
获取会员可编辑信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ info | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ username | string | 非必须 |  | 名称 |
| ├─ avatar | string | 非必须 |  | 头像 |
| ├─ sex | string | 非必须 |  | 性别。0 未知；1 男；2 女 |
| ├─ birthday | string | 非必须 |  | 出生日期 |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ email | string | 非必须 |  | 常用邮箱 |
| ├─ industry | string | 非必须 |  | 所属行业 |
| ├─ income | string | 非必须 |  | 收入 |
| ├─ edu_background | string | 非必须 |  | 学历 |
| ├─ habbit | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 爱好 |
| ├─ have_consume | string | 非必须 |  | 是否有消费 |
| ├─ registerSetting | object | 非必须 |  |  |
| ├─ username | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ sex | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ birthday | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ address | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ email | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ industry | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 对象类型 |
| ├─ income | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 对象详情 |
| ├─ edu_background | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 配置名称 |
| ├─ habbit | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 配置名称 |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ element_type | string | 非必须 |  | 对象类型 |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  | 对象详情 |
| ├─ ischecked | string | 非必须 |  |  |
获取会员注册协议
基本信息
Path： /api/h5app/wxapp/member/agreement
Method： GET
接口描述：
获取会员注册协议
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ type | string | 必须 |  | 协议类型 |
| ├─ title | string | 必须 |  | 协议标题 |
| ├─ content | string | 必须 |  | 协议内容 |
获取会员注册项
基本信息
Path： /api/h5app/wxapp/member/setting
Method： GET
接口描述：
获取会员注册项
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| is_edite_page
| 是
|
| 是否是可编辑页面
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 必须 |  |  |
| ├─ username | object | 非必须 |  |  |
| ├─ name | string | 必须 | 年收入 | 展示给用户看的字段内容 |
| ├─ key | string | 必须 | income | 前后端交互的key |
| ├─ is_open | string | 必须 | 1 | 是否开启, [0 关闭] [1 开启] |
| ├─ is_required | string | 必须 |  | 是否必填, [0 关闭] [1 开启] |
| ├─ is_edit | string | 必须 |  | 是否可编辑, [0 关闭] [1 开启] |
| ├─ element_type | string | 必须 | select | 元素类型 [input 文本框] [numeric 数字] [date 日期] [select 下拉框] [checkbox 复选框] |
| ├─ field_type | integer | 必须 | 4 | 字段类型【1 文本】【2 数字】【3 日期】【4 单选项】【5 复选框】 |
| ├─ range | object [] | 必须 |  | 数字或日期类型的范围，是一个数组对象 |
item 类型: object
| ├─ start | string | 必须 | 0 | 最小值，如果是null则无下限 |
| ├─ end | string | 必须 | 999 | 最大值，如果是null则无上限 |
| ├─ select | object [] | 必须 |  | 单选项的下拉框描述，是一个数组 |
item 类型: object
| ├─ value1 | string | 必须 |  | 下拉框描述1 |
| ├─ value2 | string | 必须 |  | 下拉框描述2 |
| ├─ checkbox | object [] | 必须 |  | 复选框的每个选项描述和是否默认选中，是一个数组对象 |
item 类型: object
| ├─ name | string | 必须 | 游戏 | 描述内容 |
| ├─ ischecked | string | 必须 | 1 | 是否选中，1为选中，0为不选中 |
获取会员白名单设置
基本信息
Path： /api/h5app/wxapp/whitelist/status
Method： GET
接口描述：
获取会员白名单设置
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
获取信任登录传参信息
基本信息
Path： /api/h5app/wxapp/trustlogin/params
Method： GET
接口描述：
获取信任登录传参信息
请求参数
Query
参数名称
是否必须
示例
备注
| trustlogin_tag
| 是
|
| 信任登录标签
| version_tag
| 是
|
| 信任登录类型 standard pc端 touch h5端
| redirect
| 否
|
| 上一次的访问路径
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ config_info | object | 非必须 |  |  |
| ├─ type | string | 非必须 |  | 类型 |
| ├─ app_id | string | 非必须 |  | app_id |
| ├─ secret | string | 非必须 |  | secret |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ redirect_url | string | 非必须 |  | 跳转地址 |
获取商品浏览记录
基本信息
Path： /api/h5app/wxapp/member/browse/history/list
Method： GET
接口描述：
获取商品浏览记录
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ history_id | string | 非必须 |  | id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ itemData | object | 非必须 |  |  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | string | 非必须 |  | 商品库存 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  | 商品销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  |  |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 积分 |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  | 商品集合ID |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码 |
| ├─ brief | string | 非必须 |  | 图片简介 |
| ├─ price | string | 非必须 |  | 商品价格 |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 | 有效期的类型 | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  | 税率 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 分润类型 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  |  |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 货号 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | string | 非必须 |  |  |
获取图片验证码
基本信息
Path： /api/h5app/wxapp/member/image/code
Method： GET
接口描述：
获取图片验证码
请求参数
Query
参数名称
是否必须
示例
备注
| type
| 是
|
| 类型: sign, forgot_password,login
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ imageToken | string | 非必须 |  | 图片token |
| ├─ imageData | string | 非必须 |  | base64图片 |
获取手机短信验证码
基本信息
Path： /api/h5app/wxapp/member/sms/code
Method： GET
接口描述：
获取手机短信验证码
请求参数
Query
参数名称
是否必须
示例
备注
| mobile
| 是
|
| 手机号
| token
| 否
|
| 图片验证码token
| yzm
| 否
|
| 图片验证码的值
| type
| 否
|
| 验证码类型 【sign 注册验证码】【forget_password 重置密码验证码】【login 登录验证码】【update 修改手机号】
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ message | string | 非必须 |  | 描述 |
获取授权手机号-仅支持微信
基本信息
Path： /api/h5app/wxapp/member/decryptPhoneInfo
Method： GET
接口描述：
手机号授权解密获取手机号
请求参数
Query
参数名称
是否必须
示例
备注
| encryptedData
| 是
|
| 小程序登录时用户授权手机号的加密数据
| iv
| 是
|
| 小程序登录时用户授权手机号加密算法的初始向量
返回数据
成功返回结构
获取授权手机号-仅支持微信
基本信息
Path： /api/h5app/wxapp/member/decryptPhone
Method： GET
接口描述：
手机号授权解密获取手机号
请求参数
Query
参数名称
是否必须
示例
备注
| appid
| 是
|
| 小程序appid
| code
| 是
|
| 登录时获取的 code
| encryptedData
| 是
|
| 小程序登录时用户授权手机号的加密数据
| iv
| 是
|
| 小程序登录时用户授权手机号加密算法的初始向量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  | open_id |
| ├─ union_id | string | 非必须 |  | union_id |
获取条形码/二维码
基本信息
Path： /api/h5app/wxapp/barcode
Method： GET
接口描述：
获取条形码/二维码
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ barcode_url | string | 非必须 |  | base64条形码 |
| ├─ qrcode_url | string | 非必须 |  | base64二维码图片 |
获取第三方登录配置列表
基本信息
Path： /api/h5app/wxapp/trustlogin/list
Method： GET
接口描述：
获取第三方登录配置列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| version_tag
| 是
|
| 信任登录类型 standard pc端 touch h5端
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ type | string | 非必须 |  | 类型 |
| ├─ app_id | string | 非必须 |  | app_id |
| ├─ secret | string | 非必须 |  | secret |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ status | string | 非必须 |  | 状态 |
获取订阅列表
基本信息
Path： /api/h5app/wxapp/member/item/is_subscribe/{item_id}
Method： GET
接口描述：
获取订阅列表
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 标题 |
记录导购被访问的UV
基本信息
Path： /api/h5app/wxapp/member/salesperson/uniquevisito
Method： POST
接口描述：
记录导购被访问的UV
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| work_userid
| 是
|
| 导购员工编号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | boolean | 非必须 |  | 状态 |
订单
获取权益核销码
基本信息
Path： /api/h5app/wxapp/rightscode/{rights_id}
Method： GET
接口描述：
获取权益核销码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  barcode_url | string | 非必须 |  | 一维码链接 |
|  qrcode_url | string | 非必须 |  | 二维码链接 |
|  code | string | 非必须 |  | code码 |
|  _ignore_data | string | 非必须 |  |  |
修改购物车促销
基本信息
Path： /api/h5app/wxapp/cartupdate/promotion
Method： PUT
接口描述：
修改购物车促销
请求参数
Query
参数名称
是否必须
示例
备注
| cart_id
| 是
|
| shop,distributor,community
| activity_id
| 是
|
| 活动id
| activity_type
| 是
|
| 活动类型，community：社区活动，goods_promotion:商品促销
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 状态 true 成功 |
修改购物车商品数量(批量)
基本信息
Path： /api/h5app/wxapp/cartupdate/batchnum
Method： PUT
接口描述：
修改购物车商品数量(批量)
请求参数
Query
参数名称
是否必须
示例
备注
| cart
| 是
|
| shop,distributor,community
返回数据
成功返回结构
修改购物车选中状态
基本信息
Path： /api/h5app/wxapp/cartupdate/checkstatus
Method： PUT
接口描述：
修改购物车选中状态
请求参数
Query
参数名称
是否必须
示例
备注
| cart_id
| 是
|
| shop,distributor,community
| is_checked
| 是
|
| shop_id,distributor_id,community_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | integer | 非必须 |  | 状态 1 成功 0 失败 |
创建订单
基本信息
Path： /api/h5app/wxapp/order
Method： POST
接口描述：
创建订单
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店ID
| item_id
| 否
|
| 交易商品ID
| item_num
| 否
|
| 交易商品数量
| items[][item_id]
| 否
|
| 交易商品ID
| items[][num]
| 否
|
| 交易商品数量
| bargain_id
| 否
|
| 砍价活动id
| source_id
| 否
|
| 订单来源ID
| monitor_id
| 否
|
| 监控页面ID
| salesman_id
| 否
|
| 导购ID
| receipt_type
| 否
|
| 收货方式：ziti 自提 logistics 快递
| receiver_name
| 否
|
| 收货人姓名
| receiver_mobile
| 否
|
| 收货人手机号
| receiver_zip
| 否
|
| 收货人邮编
| receiver_state
| 否
|
| 收货人所在省份
| receiver_city
| 否
|
| 收货人所在城市
| receiver_district
| 否
|
| 收货人所在地区
| receiver_address
| 否
|
| 收货人详细地址
| epidemic_register_info
| 否
|
| 疫情防控登记 json{name,cert_id,mobile,temperature,job,symptom,symptom_des,is_risk_area}
| cart_type
| 是
|
| 购物车类型 cart 购物车 fastbuy 立即购买 offline 离线购物车
| order_type
| 是
|
| 订单类型，service服务业订单 bargain 砍价订单 normal 实物订单
| pay_type
| 否
|
| 支付类型 wxpay 微信支付 point 积分支付 deposit 储值支付
| invoice_content
| 否
|
| 开票信息
| invoice_type
| 否
|
| 开票类型
| coupon_discount
| 否
|
| 优惠券优惠码
| not_use_coupon
| 否
|
| 不使用优惠券
| iscrossborder
| 否
|
| 是否海外购
| isShopScreen
| 否
|
| 是否大屏
| isNostores
| 否
|
| 是否支持无门店下单门店自提
| point_use
| 否
|
| 是否使用积分
| pack
| 否
|
| 是否需要包装
| remark
| 否
|
| 订单备注
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | 应用ID |
| ├─ timeStamp | string | 非必须 |  | 时间戳 |
| ├─ nonceStr | string | 非必须 |  | 随机字符串 |
| ├─ package | string | 非必须 |  | 订单详情扩展字符串 |
| ├─ signType | string | 非必须 |  | 签名方式 |
| ├─ paySign | string | 非必须 |  | 签名 |
| ├─ team_id | string | 非必须 |  |  |
| ├─ trade_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ trade_id | string | 非必须 |  | 交易单号 |
创建订单
基本信息
Path： /api/h5app/wxapp/order_new
Method： POST
接口描述：
创建订单
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店ID
| item_id
| 否
|
| 交易商品ID
| item_num
| 否
|
| 交易商品数量
| items[][item_id]
| 否
|
| 交易商品ID
| items[][num]
| 否
|
| 交易商品数量
| bargain_id
| 否
|
| 砍价活动id
| source_id
| 否
|
| 订单来源ID
| monitor_id
| 否
|
| 监控页面ID
| salesman_id
| 否
|
| 导购ID
| receipt_type
| 否
|
| 收货方式：ziti 自提 logistics 快递
| receiver_name
| 否
|
| 收货人姓名
| receiver_mobile
| 否
|
| 收货人手机号
| receiver_zip
| 否
|
| 收货人邮编
| receiver_state
| 否
|
| 收货人所在省份
| receiver_city
| 否
|
| 收货人所在城市
| receiver_district
| 否
|
| 收货人所在地区
| receiver_address
| 否
|
| 收货人详细地址
| cart_type
| 是
|
| 购物车类型 cart 购物车 fastbuy 立即购买 offline 离线购物车
| order_type
| 是
|
| 订单类型，service服务业订单 bargain 砍价订单 normal 实物订单
| pay_type
| 否
|
| 支付类型 wxpay 微信支付 point 积分支付 deposit 储值支付
| invoice_content
| 否
|
| 开票信息
| invoice_type
| 否
|
| 开票类型
| coupon_discount
| 否
|
| 优惠券优惠码
| not_use_coupon
| 否
|
| 不使用优惠券
| iscrossborder
| 否
|
| 是否海外购
| isShopScreen
| 否
|
| 是否大屏
| isNostores
| 否
|
| 是否支持无门店下单门店自提
| point_use
| 否
|
| 是否使用积分
| pack
| 否
|
| 是否需要包装
| remark
| 否
|
| 订单备注
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ order_type | string | 非必须 |  | 订单类型 |
删除疫情登记信息
基本信息
Path： /api/h5app/h5app/wxapp/epidemic/info/del/{id}
Method： POST
接口描述：
删除疫情登记信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
多店铺购物车列表
基本信息
Path： /api/h5app/wxapp/cart/list
Method： GET
接口描述：
多店铺购物车列表
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 店铺id
| distributor_id
| 否
|
| 店铺id
| shop_type
| 否
|
| 店铺类型：shop,distributor,community
| items[][item_id]
| 否
|
| 批量添加购物车商品ID
| items[][num]
| 否
|
| 批量添加购物车商品数量
| cart_type
| 否
|
| 购物车类型
| iscrossborder
| 否
|
| 是否海外购
| isShopScreen
| 否
|
| 是否大屏操作
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ valid_cart | object [] | 非必须 |  | 有效购物车 |
item 类型: object
| ├─ shop_name | integer | 非必须 |  | 店铺名称 |
| ├─ address | integer | 非必须 |  | 店铺地址 |
| ├─ mobile | integer | 非必须 |  | 店铺手机号 |
| ├─ lat | integer | 非必须 |  | 腾讯地图经度 |
| ├─ lng | integer | 非必须 |  | 腾讯地图纬度 |
| ├─ hour | integer | 非必须 |  | 营业时间 |
| ├─ is_ziti | integer | 非必须 |  | 是否支持自提 |
| ├─ is_delivery | integer | 非必须 |  | 是否支持配送 |
| ├─ shop_id | integer | 非必须 |  | 门店ID |
| ├─ cart_total_price | integer | 非必须 |  | 计算商品促销之前的购物车总价 |
| ├─ item_fee | integer | 非必须 |  | 商品原价总金额 |
| ├─ cart_total_num | integer | 非必须 |  | 购物车商品数量 |
| ├─ cart_total_count | integer | 非必须 |  | 购物车商品总量 |
| ├─ discount_fee | integer | 非必须 |  | 优惠总金额 |
| ├─ total_fee | integer | 非必须 |  | 结算总金额 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额 |
| ├─ list | object [] | 非必须 |  | 购物车商品列表 |
item 类型: object
| ├─ cart_id | integer | 非必须 |  | 购物车ID |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ user_id | integer | 非必须 |  | 用户ID |
| ├─ user_ident | string | 非必须 |  | 会员ident |
| ├─ shop_type | string | 非必须 |  | 店铺类型 |
| ├─ shop_id | integer | 非必须 |  | 店铺id |
| ├─ activity_type | string | 非必须 |  | 活动类型 |
| ├─ activity_id | integer | 非必须 |  | 活动id |
| ├─ marketing_type | string | 非必须 |  | 促销类型 |
| ├─ marketing_id | integer | 非必须 |  | 促销id |
| ├─ item_type | string | 非必须 |  | 商品类型 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ items_id |  [] | 非必须 |  | 组合商品关联商品id |
| ├─  |  | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ pics | string | 非必须 |  | 图片 |
| ├─ price | integer | 非必须 |  | 购买商品价格 |
| ├─ num | integer | 非必须 |  | 购买商品数量 |
| ├─ wxa_appid | string | 非必须 |  | 小程序appid |
| ├─ is_checked | boolean | 非必须 |  | 购物车是否选中 |
| ├─ is_plus_buy | boolean | 非必须 |  | 是加价购商品 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ is_last_price | boolean | 非必须 |  | 是否为最后固定的价格 |
| ├─ discount_fee | integer | 非必须 |  | 优惠金额 |
| ├─ total_fee | integer | 非必须 |  | 结算金额 |
| ├─ store | integer | 非必须 |  | 商品库存 |
| ├─ market_price | integer | 非必须 |  | 销售价 |
| ├─ brief | string | 非必须 |  | 商品简介 |
| ├─ approve_status | string | 非必须 |  | 商品状态 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格 |
| ├─ parent_id | integer | 非必须 |  | 组合商品购物车ID |
| ├─ goods_id | integer | 非必须 |  | 产品ID |
| ├─ item_category | integer | 非必须 |  | 商品主类目 |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ taxstrategy_id | integer | 非必须 |  | 税费策略id |
| ├─ taxation_num | integer | 非必须 |  | 计税单位份数 |
| ├─ origincountry_id | integer | 非必须 |  | 产地国id |
| ├─ origincountry_name | string | 非必须 |  | 产地国称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国图标 |
| ├─ discount_desc | string | 非必须 |  | 优惠描述 |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额 |
| ├─ activity_info | object [] | 非必须 |  | 参会的活动信息 |
item 类型: object
| ├─ id | integer | 非必须 |  | 活动ID |
| ├─ type | string | 非必须 |  | 活动类型 |
| ├─ info | integer | 非必须 |  | 活动描述 |
| ├─ rule | integer | 非必须 |  | 活动规则 |
| ├─ discount_fee | integer | 非必须 |  | 折扣金额 |
| ├─ used_activity |  [] | 非必须 |  | 参与的活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ used_activity_ids |  [] | 非必须 |  | 参与的活动ID列表 |
| ├─  |  | 非必须 |  |  |
| ├─ gift_activity |  [] | 非必须 |  | 参与的满赠活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ plus_buy_activity |  [] | 非必须 |  | 参与加价购活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ invalid_cart |  [] | 非必须 |  | 失效购物车列表 |
| ├─  |  | 非必须 |  |  |
| ├─ is_check_store | boolean | 非必须 |  | 是否检查过库存 |
支付结果查询
基本信息
Path： /api/h5app/wxapp/payment/query
Method： POST
接口描述：
支付结果查询
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| trade_id
| 是
|
| 支付单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | 微信appid |
| ├─ timeStamp | string | 非必须 |  | 时间戳 |
| ├─ nonceStr | string | 非必须 |  | 随机字符串 |
| ├─ package | string | 非必须 |  | 订单详情扩展字符串 |
| ├─ signType | string | 非必须 |  | 签名方式 |
| ├─ paySign | string | 非必须 |  | 签名 |
| ├─ trade_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ trade_id | string | 非必须 |  | 交易单号 |
物流查询
基本信息
Path： /api/h5app/wxapp/trackerpull
Method： POST
接口描述：
物流查询
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| order_type
| 是
|
| 订单类型
| order_id
| 是
|
| 订单编号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ AcceptTime | string | 非必须 |  | 物流时间 |
| ├─ AcceptStation | string | 非必须 |  | 物流详情描述 |
用户回复评价
基本信息
Path： /api/h5app/wxapp/order/replyRate
Method： POST
接口描述：
用户回复评价
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ reply_id | string | 非必须 |  | 回复id |
| ├─ rate_id | string | 非必须 |  | 评价id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ operator_id | string | 非必须 |  | 操作员的id |
| ├─ content | string | 非必须 |  | 评价内容 |
| ├─ content_len | integer | 非必须 |  | 评价内容长度 |
| ├─ role | string | 非必须 |  | 回复角色.seller：卖家；buyer：买家 |
| ├─ created | integer | 非必须 |  |  |
| ├─ unionid | string | 非必须 |  | 微信unionid |
用户评价
基本信息
Path： /api/h5app/wxapp/order/rate/create
Method： POST
接口描述：
用户评价
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单编号
| anonymous
| 否
|
| rates[0][item_id]
| 是
|
| 商品id
| rates[0][content]
| 是
|
| 评价内容
| rates[0][star]
| 是
|
| 评分星数
| rates[0][pics][0]
| 是
|
| 评价图片
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ rate_id | string | 非必须 |  | 评价id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ item_id | string | 非必须 |  | 商品ID |
| ├─ goods_id | string | 非必须 |  | 产品ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ rate_pic | string | 非必须 |  | 评价图片 |
| ├─ rate_pic_num | integer | 非必须 |  | 评价图片数量 |
| ├─ content | string | 非必须 |  | 评价内容 |
| ├─ content_len | integer | 非必须 |  | 评价内容长度 |
| ├─ is_reply | integer | 非必须 |  | 评价是否回复。0:否；1:是 |
| ├─ disabled | integer | 非必须 |  | 是否删除。0:否；1:是 |
| ├─ anonymous | string | 非必须 |  | 是否匿名。0:否；1:是 |
| ├─ star | string | 非必须 |  | 评价星级 |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ unionid | string | 非必须 |  | 微信unionid |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ order_type | string | 非必须 |  |  |
申请开票
基本信息
Path： /api/h5app/wxapp/order/applyinvoicing/{order_id}
Method： POST
接口描述：
在创建订单后，可以单独申请开票
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| order_id
|
Query
参数名称
是否必须
示例
备注
| invoice_type
| 是
|
| 开票类型
| invoice_content
| 是
|
| 开票信息
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
疫情登记信息
基本信息
Path： /api/h5app/h5app/wxapp/epidemic/info
Method： GET
接口描述：
疫情登记信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | id |
| ├─ order_id | string | 非必须 |  | 订单ID |
| ├─ user_id | string | 非必须 |  | 用户ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ name | string | 非必须 |  | 登记姓名 |
| ├─ mobile | string | 非必须 |  | 登记手机号 |
| ├─ cert_id | string | 非必须 |  | 身份证号 |
| ├─ temperature | string | 非必须 |  | 温度 |
| ├─ job | string | 非必须 |  | 职业 |
| ├─ symptom | string | 非必须 |  | 症状 |
| ├─ symptom_des | string | 非必须 |  | 症状描述 |
| ├─ is_risk_area | string | 非必须 |  | 是否去过中高风险地区 |
| ├─ order_time | string | 非必须 |  | 下单时间 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ distributor_name | string | 非必须 |  | 店铺名称 |
疫情登记所需信息
基本信息
Path： /api/h5app/h5app/wxapp/epidemic/mixed/cat
Method： GET
接口描述：
疫情登记所需信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ temperature | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ job | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
确认发货
基本信息
Path： /api/h5app/wxapp/order/confirmReceipt
Method： POST
接口描述：
确认发货
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ title | string | 非必须 |  | 订单标题 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ freight_fee | integer | 非必须 |  | 运费价格，以分为单位 |
| ├─ freight_type | string | 非必须 |  |  |
| ├─ item_fee | string | 非必须 |  | 商品金额，以分为单位 |
| ├─ item_point | integer | 非必须 |  |  |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位 |
| ├─ step_paid_fee | integer | 非必须 |  | 分阶段付款已支付金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 订单总分销金额，以分为单位 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ receipt_type | string | 非必须 |  | 收货方式。可选值有 logistics:物流;ziti:店铺自提 |
| ├─ ziti_code | string | 非必须 |  | 店铺自提码 |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ ziti_status | string | 非必须 |  | 店铺自提状态。可选值有 PENDING:等待自提;DONE:自提完成;NOTZITI:自提完成; APPROVE:审核通过,药品自提需要审核 |
| ├─ order_status | string | 非必须 |  | 订单状态。可选值有 DONE—订单完成;NOTPAY—未支付;PART_PAYMENT-部分付款;WAIT_GROUPS_SUCCESS-等待拼团成功;PAYED-已支付;CANCEL—已取消;WAIT_BUYER_CONFIRM-待用户收货 |
| ├─ order_source | string | 非必须 |  | 订单来源。可选值有 member-用户自主下单;shop-商家代客下单 |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 normal:普通实体订单 |
| ├─ order_class | string | 非必须 |  | 订单种类。可选值有 normal:普通订单;groups:拼团订单;;community 社区活动订单;bargain:助力订单;seckill:秒杀订单;shopguide:导购订单 |
| ├─ auto_cancel_time | string | 非必须 |  | 订单自动取消时间 |
| ├─ auto_cancel_seconds | integer | 非必须 |  |  |
| ├─ auto_finish_time | string | 非必须 |  | 订单自动完成时间 |
| ├─ is_distribution | string | 非必须 |  | 是否分销订单 |
| ├─ source_id | string | 非必须 |  | 订单来源id |
| ├─ monitor_id | string | 非必须 |  | 订单监控页面id |
| ├─ salesman_id | string | 非必须 |  | 导购员ID |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_corp_source | string | 非必须 |  | 快递代码来源 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货;PARTAIL-部分发货 |
| ├─ cancel_status | string | 非必须 |  | 取消订单状态。可选值有 NO_APPLY_CANCEL 未申请;WAIT_PROCESS 等待审核;REFUND_PROCESS 退款处理;SUCCESS 取消成功;FAILS 取消失败 |
| ├─ delivery_time | integer | 非必须 |  | 发货时间 |
| ├─ end_time | integer | 非必须 |  | 订单完成时间 |
| ├─ end_date | string | 非必须 |  |  |
| ├─ receiver_name | string | 非必须 |  | 收货人姓名 |
| ├─ receiver_mobile | string | 非必须 |  | 收货人手机号 |
| ├─ receiver_zip | string | 非必须 |  | 收货人邮编 |
| ├─ receiver_state | string | 非必须 |  | 收货人所在省份 |
| ├─ receiver_city | string | 非必须 |  | 收货人所在城市 |
| ├─ receiver_district | string | 非必须 |  | 收货人所在地区 |
| ├─ receiver_address | string | 非必须 |  | 收货人详细地址 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ point | integer | 非必须 |  | 消费积分 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ remark | string | 非必须 |  | 订单备注 |
| ├─ third_params | object | 非必须 |  |  |
| ├─ is_liveroom | string | 非必须 |  |  |
| ├─ invoice | string | 非必须 |  | 发票信息(DC2Type:json_array) |
| ├─ send_point | integer | 非必须 |  | 是否分发积分0否 1是 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ is_invoiced | string | 非必须 |  | 是否已开发票 |
| ├─ invoice_number | string | 非必须 |  | 发票号 |
| ├─ audit_status | string | 非必须 |  | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_msg | string | 非必须 |  | 审核意见 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣金额，以分为单位 |
| ├─ point_use | integer | 非必须 |  | 积分抵扣使用的积分数 |
| ├─ pay_status | string | 非必须 |  | 支付状态。可选值有 NOTPAY—未支付;PAYED-已支付;ADVANCE_PAY-预付款完成;TAIL_PAY-支付尾款中 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ bonus_points | integer | 非必须 |  | 购物赠送积分 |
| ├─ get_point_type | integer | 非必须 |  | 获取积分类型，0 老订单按订单完成时送,1 新订单按下单时计算送 |
| ├─ pack | string | 非必须 |  | 包装 |
| ├─ is_shopscreen | string | 非必须 |  | 是否门店订单 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ is_profitsharing | integer | 非必须 |  | 是否分账订单 1不分账 2分账 |
| ├─ profitsharing_status | integer | 非必须 |  | 分账状态 1未分账 2已分账 |
| ├─ order_auto_close_aftersales_time | integer | 非必须 |  | 自动关闭售后时间 |
| ├─ profitsharing_rate | integer | 非必须 |  | 分账费率 |
| ├─ bind_auth_code | string | 非必须 |  |  |
| ├─ extra_points | integer | 非必须 |  |  |
| ├─ type | integer | 非必须 |  | 订单类型，0普通订单,1跨境订单,....其他 |
| ├─ taxable_fee | integer | 非必须 |  | 计税总价，以分为单位 |
| ├─ identity_id | string | 非必须 |  | 身份证号码 |
| ├─ identity_name | string | 非必须 |  | 身份证姓名 |
| ├─ total_tax | integer | 非必须 |  | 总税费 |
| ├─ discount_info | string | 非必须 |  |  |
绑定订单
基本信息
Path： /api/h5app/wxapp/order/bind/{order_id}
Method： POST
接口描述：
绑定订单
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| auth_code
|
| 验证码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
统计订单数量
基本信息
Path： /api/h5app/wxapp/orderscount
Method： GET
接口描述：
统计订单数量
请求参数
Query
参数名称
是否必须
示例
备注
| order_type
| 否
|
| 订单类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ service_notpay | integer | 非必须 |  | 未付款数量 |
| ├─ service_payed | integer | 非必须 |  | 已付款数量 |
| ├─ normal_notpay_notdelivery | integer | 非必须 |  | 未付款未发货 |
| ├─ normal_payed_notdelivery | integer | 非必须 |  | 已付款未发货 or 已付款已发货 |
| ├─ normal_payed_daifahuo | integer | 非必须 |  | 待发货 |
| ├─ normal_payed_daishouhuo | integer | 非必须 |  | 待收货 |
| ├─ normal_payed_daiziti | integer | 非必须 |  | 待自提订单 |
| ├─ aftersales | integer | 非必须 |  | 待处理售后 |
| ├─ rate_status | integer | 非必须 |  |  |
统计订单数量和权益核销数量
基本信息
Path： /api/h5app/wxapp/order/count
Method： GET
接口描述：
统计订单数量和权益核销数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ rightsLogTotal | integer | 非必须 |  | 权益核销数量 |
| ├─ rightsTotal | integer | 非必须 |  | 权益数量 |
| ├─ orderTotal | integer | 非必须 |  | 已完成订单数量 |
| ├─ couponTotal | integer | 非必须 |  | 优惠券数量 |
获取JsPayConfig
基本信息
Path： /api/h5app/wxapp/order/jspayconfig
Method： POST
接口描述：
获取JsPayConfig
请求参数
返回数据
成功返回结构
获取会员购物车商品数量
基本信息
Path： /api/h5app/wxapp/cartcount
Method： GET
接口描述：
获取会员购物车商品数量
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 店铺id
| shop_type
| 是
|
| shop、distributor、community、mall
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 数据集合 |
| ├─ cart_count | integer | 非必须 |  | 购物车数量 |
| ├─ item_count | integer | 非必须 |  | 商品数量 |
获取商品评价列表
基本信息
Path： /api/h5app/wxapp/order/rate/list
Method： GET
接口描述：
获取商品评价列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| item_id
| 否
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ rate_id | string | 非必须 |  | 评价id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ item_id | string | 非必须 |  | 商品ID |
| ├─ goods_id | string | 非必须 |  | 产品ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ rate_pic | string | 非必须 |  | 评价图片 |
| ├─ rate_pic_num | integer | 非必须 |  | 评价图片数量 |
| ├─ content | string | 非必须 |  | 评价内容 |
| ├─ content_len | integer | 非必须 |  | 评价内容长度 |
| ├─ is_reply | string | 非必须 |  | 评价是否回复。0:否；1:是 |
| ├─ disabled | string | 非必须 |  | 是否删除。0:否；1:是 |
| ├─ anonymous | string | 非必须 |  | 是否匿名。0:否；1:是 |
| ├─ star | integer | 非必须 |  | 评价星级 |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ unionid | string | 非必须 |  | 微信unionid |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ order_type | string | 非必须 |  | 订单类型 |
| ├─ avatar | string | 非必须 |  | 会员头像 |
| ├─ username | string | 非必须 |  | 会员昵称 |
| ├─ praise_num | integer | 非必须 |  | 点赞数 |
| ├─ reply | object | 非必须 |  | 回复记录 |
| ├─ total_count | integer | 非必须 |  | 记录数 |
获取小程序微信支付，天工支付需要的参数
基本信息
Path： /api/h5app/wxapp/payment/config
Method： GET
接口描述：
获取小程序微信支付，天工支付需要的参数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| pay_type
| 是
|
| 支付方式
| shop_id
| 是
|
| 门店ID，用于识别哪个门店支付
| order_id
| 是
|
| 订单id
| poiid
| 是
|
| 微信门店ID
| total_fee
| 是
|
| 消费总金额 单位/分
| member_card_code
| 是
|
| 使用的会员卡code
| coupon_code
| 否
|
| 优惠券code
| body
| 是
|
| 交易商品简单描述
| detail
| 是
|
| 交易商品详情
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | 微信appid |
| ├─ timeStamp | string | 非必须 |  | 时间戳 |
| ├─ nonceStr | string | 非必须 |  | 随机字符串 |
| ├─ package | string | 非必须 |  | 订单详情扩展字符串 |
| ├─ signType | string | 非必须 |  | 签名方式 |
| ├─ paySign | string | 非必须 |  | 签名 |
| ├─ trade_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ trade_id | string | 非必须 |  | 交易单号 |
获取支付单详情
基本信息
Path： /api/h5app/wxapp/trade/detail
Method： GET
接口描述：
获取支付单详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| trade_id
| 是
|
| 交易单号id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ trade_id | string | 非必须 |  | 交易单号 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ distributor_id | string | 非必须 |  | 门店ID |
| ├─ trade_source_type | string | 非必须 |  | 交易单来源类型。可选值有 membercard-会员卡购买;normal-实体订单购买;servers-服务订单购买;normal_community-社区订单购买;diposit-预存款购买;order_pay-买单购买; |
| ├─ user_id | string | 非必须 |  | 购买用户 |
| ├─ mobile | string | 非必须 |  | 购买用户手机号 |
| ├─ open_id | string | 非必须 |  | 用户open_id |
| ├─ discount_info | string | 非必须 |  | 优惠金额，优惠金额，优惠原因json结构 |
| ├─ mch_id | string | 非必须 |  | 商户号，微信支付 |
| ├─ total_fee | integer | 非必须 |  | 应付总金额,以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ pay_fee | integer | 非必须 |  | 支付金额 |
| ├─ trade_state | string | 非必须 |  | 交易状态。可选值有 SUCCESS—支付成功;REFUND—转入退款;NOTPAY—未支付;CLOSED—已关闭;REVOKED—已撤销;PAYERROR--支付失败(其他原因，如银行返回失败) |
| ├─ pay_type | string | 非必须 |  | 支付方式。wxpay-微信支付;deposit-预存款支付;pos-刷卡;point-积分 |
| ├─ transaction_id | string | 非必须 |  | 支付订单号 |
| ├─ authorizer_appid | string | 非必须 |  | 公众号的appid |
| ├─ wxa_appid | string | 非必须 |  | 支付小程序的appid |
| ├─ bank_type | string | 非必须 |  | 付款银行 |
| ├─ body | string | 非必须 |  | 交易商品简单描述 |
| ├─ detail | string | 非必须 |  | 交易商品详情 |
| ├─ time_start | string | 非必须 |  | 交易起始时间 |
| ├─ time_expire | string | 非必须 |  | 交易结束时间 |
| ├─ cur_pay_fee | integer | 非必须 |  | 系统货币支付金额 |
| ├─ cur_fee_symbol | string | 非必须 |  | 系统配置货币符号 |
| ├─ cur_fee_rate | integer | 非必须 |  | 系统配置货币汇率 |
| ├─ cur_fee_type | string | 非必须 |  | 系统配置货币类型 |
| ├─ coupon_fee | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ coupon_info | string | 非必须 |  | 优惠券信息json结构 |
| ├─ inital_request | string | 非必须 |  | 统一下单原始请求json结构 |
| ├─ inital_response | string | 非必须 |  | 支付结果通知json结构 |
获取支付需要的参数， 积分以及预存款直接扣除
基本信息
Path： /api/h5app/wxapp/payment
Method： POST
接口描述：
获取支付需要的参数， 积分以及预存款直接扣除
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| pay_type
| 是
|
| 支付方式
| order_id
| 是
|
| 订单id
| order_type
| 是
|
| 订单类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | 微信appid |
| ├─ timeStamp | string | 非必须 |  | 时间戳 |
| ├─ nonceStr | string | 非必须 |  | 随机字符串 |
| ├─ package | string | 非必须 |  | 订单详情扩展字符串 |
| ├─ signType | string | 非必须 |  | 签名方式 |
| ├─ paySign | string | 非必须 |  | 签名 |
| ├─ trade_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ trade_id | string | 非必须 |  | 交易单号 |
| ├─ team_id | string | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ order_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ title | string | 非必须 |  | 订单标题 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ freight_fee | integer | 非必须 |  | 运费价格，以分为单位 |
| ├─ freight_type | string | 非必须 |  | 运费类型-用于积分商城 cash:现金 point:积分 |
| ├─ item_fee | string | 非必须 |  | 商品金额，以分为单位 |
| ├─ item_point | integer | 非必须 |  | 商品消费总积分 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位 |
| ├─ step_paid_fee | integer | 非必须 |  | 分阶段付款已支付金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 订单总分销金额，以分为单位 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ receipt_type | string | 非必须 |  | 收货方式。可选值有 logistics:物流;ziti:店铺自提 |
| ├─ ziti_code | string | 非必须 |  | 店铺自提码 |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ ziti_status | string | 非必须 |  | 店铺自提状态。可选值有 PENDING:等待自提;DONE:自提完成;NOTZITI:自提完成; APPROVE:审核通过,药品自提需要审核 |
| ├─ order_status | string | 非必须 |  | 订单状态。可选值有 DONE—订单完成;NOTPAY—未支付;PART_PAYMENT-部分付款;WAIT_GROUPS_SUCCESS-等待拼团成功;PAYED-已支付;CANCEL—已取消;WAIT_BUYER_CONFIRM-待用户收货 |
| ├─ order_source | string | 非必须 |  | 订单来源。可选值有 member-用户自主下单;shop-商家代客下单 |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 normal:普通实体订单 |
| ├─ order_class | string | 非必须 |  | 订单种类。可选值有 normal:普通订单;groups:拼团订单;;community 社区活动订单;bargain:助力订单;seckill:秒杀订单;shopguide:导购订单;pointsmall:积分商城 |
| ├─ auto_cancel_time | string | 非必须 |  | 订单自动取消时间 |
| ├─ auto_cancel_seconds | integer | 非必须 |  |  |
| ├─ auto_finish_time | string | 非必须 |  | 订单自动完成时间 |
| ├─ is_distribution | string | 非必须 |  | 是否分销订单 |
| ├─ source_id | string | 非必须 |  | 订单来源id |
| ├─ monitor_id | string | 非必须 |  | 订单监控页面id |
| ├─ salesman_id | string | 非必须 |  | 导购员ID |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_corp_source | string | 非必须 |  | 快递代码来源 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货;PARTAIL-部分发货 |
| ├─ cancel_status | string | 非必须 |  | 取消订单状态。可选值有 NO_APPLY_CANCEL 未申请;WAIT_PROCESS 等待审核;REFUND_PROCESS 退款处理;SUCCESS 取消成功;FAILS 取消失败 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ end_time | string | 非必须 |  | 订单完成时间 |
| ├─ end_date | string | 非必须 |  |  |
| ├─ receiver_name | string | 非必须 |  | 收货人姓名 |
| ├─ receiver_mobile | string | 非必须 |  | 收货人手机号 |
| ├─ receiver_zip | string | 非必须 |  | 收货人邮编 |
| ├─ receiver_state | string | 非必须 |  | 收货人所在省份 |
| ├─ receiver_city | string | 非必须 |  | 收货人所在城市 |
| ├─ receiver_district | string | 非必须 |  | 收货人所在地区 |
| ├─ receiver_address | string | 非必须 |  | 收货人详细地址 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ point | integer | 非必须 |  | 消费积分 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ remark | string | 非必须 |  | 订单备注 |
| ├─ third_params | object | 非必须 |  |  |
| ├─ is_liveroom | string | 非必须 |  |  |
| ├─ invoice | string | 非必须 |  | 发票信息(DC2Type:json_array) |
| ├─ send_point | integer | 非必须 |  | 是否分发积分0否 1是 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ is_invoiced | string | 非必须 |  | 是否已开发票 |
| ├─ invoice_number | string | 非必须 |  | 发票号 |
| ├─ audit_status | string | 非必须 |  | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_msg | string | 非必须 |  | 审核意见 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣金额，以分为单位 |
| ├─ point_use | integer | 非必须 |  | 积分抵扣使用的积分数 |
| ├─ pay_status | string | 非必须 |  | 支付状态。可选值有 NOTPAY—未支付;PAYED-已支付;ADVANCE_PAY-预付款完成;TAIL_PAY-支付尾款中 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ bonus_points | integer | 非必须 |  | 购物赠送积分 |
| ├─ get_point_type | integer | 非必须 |  | 获取积分类型，0 老订单按订单完成时送,1 新订单按下单时计算送 |
| ├─ pack | string | 非必须 |  | 包装 |
| ├─ is_shopscreen | string | 非必须 |  | 是否门店订单 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ is_profitsharing | integer | 非必须 |  | 是否分账订单 1不分账 2分账 |
| ├─ profitsharing_status | integer | 非必须 |  | 分账状态 1未分账 2已分账 |
| ├─ order_auto_close_aftersales_time | string | 非必须 |  | 自动关闭售后时间 |
| ├─ profitsharing_rate | integer | 非必须 |  | 分账费率 |
| ├─ bind_auth_code | string | 非必须 |  | 订单订单验证码 |
| ├─ extra_points | integer | 非必须 |  | 订单获取额外积分 |
| ├─ type | integer | 非必须 |  | 订单类型，0普通订单,1跨境订单,....其他 |
| ├─ taxable_fee | integer | 非必须 |  | 计税总价，以分为单位 |
| ├─ identity_id | string | 非必须 |  | 身份证号码 |
| ├─ identity_name | string | 非必须 |  | 身份证姓名 |
| ├─ total_tax | integer | 非必须 |  | 总税费 |
| ├─ discount_info | string | 非必须 |  |  |
| ├─ can_apply_aftersales | integer | 非必须 |  |  |
| ├─ distributor_name | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ item_id | string | 非必须 |  |  |
| ├─ item_bn | string | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  |  |
| ├─ pic | string | 非必须 |  |  |
| ├─ num | integer | 非必须 |  |  |
| ├─ price | integer | 非必须 |  |  |
| ├─ total_fee | integer | 非必须 |  | 订单金额，以分为单位 |
| ├─ templates_id | integer | 非必须 |  |  |
| ├─ rebate | integer | 非必须 |  |  |
| ├─ total_rebate | integer | 非必须 |  | 订单总分销金额，以分为单位 |
| ├─ item_fee | integer | 非必须 |  | 商品金额，以分为单位 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ item_unit | string | 非必须 |  |  |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ discount_info |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_total_store | string | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货;PARTAIL-部分发货 |
| ├─ aftersales_status | string | 非必须 |  |  |
| ├─ refunded_fee | integer | 非必须 |  |  |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ item_point | integer | 非必须 |  | 商品消费总积分 |
| ├─ point | integer | 非必须 |  | 消费积分 |
| ├─ item_spec_desc | string | 非必须 |  |  |
| ├─ order_item_type | string | 非必须 |  |  |
| ├─ volume | integer | 非必须 |  |  |
| ├─ weight | integer | 非必须 |  |  |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ auto_close_aftersales_time | string | 非必须 |  |  |
| ├─ share_points | integer | 非必须 |  |  |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣金额，以分为单位 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ ome_order_id | string | 非必须 |  |  |
| ├─ delivery_item_num | string | 非必须 |  |  |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ order_status_des | string | 非必须 |  |  |
| ├─ order_status_msg | string | 非必须 |  |  |
| ├─ latest_aftersale_time | integer | 非必须 |  |  |
| ├─ estimate_get_points | string | 非必须 |  |  |
| ├─ delivery_type | string | 非必须 |  |  |
| ├─ is_all_delivery | string | 非必须 |  |  |
| ├─ logistics_items | string | 非必须 |  |  |
获取权益列表
基本信息
Path： /api/h5app/wxapp/rights
Method： GET
接口描述：
获取权益列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ rights_id | string | 非必须 |  | 权益ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ can_reservation | string | 非必须 |  | 是否可预约 |
| ├─ rights_name | string | 非必须 |  | 权益标题 |
| ├─ rights_subname | string | 非必须 |  | 权益子标题 |
| ├─ total_num | string | 非必须 |  | 服务商品原始总次数,0标示无限制 |
| ├─ total_consum_num | string | 非必须 |  | 总消耗次数 |
| ├─ start_time | string | 非必须 |  | 权益开始时间 |
| ├─ end_time | string | 非必须 |  | 权益结束时间 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ label_infos | object [] | 非必须 |  |  |
item 类型: object
| ├─ label_id | string | 非必须 |  |  |
| ├─ label_name | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ rights_from | string | 非必须 |  | 权益来源 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ operator_desc | string | 非必须 |  | 操作员信息 |
| ├─ status | string | 非必须 |  | 权益状态; valid:有效的, expire:过期的; invalid:失效的 |
| ├─ is_not_limit_num | string | 非必须 |  | 限制核销次数,1:不限制；2:限制 |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ total_surplus_num | integer | 非必须 |  |  |
修改购物车商品数量(单一)
基本信息
Path： /api/h5app/wxapp/cartupdate/num
Method： PUT
接口描述：
修改购物车商品数量(单一)
请求参数
Query
参数名称
是否必须
示例
备注
| cart_id
| 是
|
| shop,distributor,community
| is_checked
| 是
|
| shop_id,distributor_id,community_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ activity_id | integer | 非必须 |  | 活动id |
| ├─ activity_type | integer | 非必须 |  | 活动类型 |
| ├─ cart_id | integer | 非必须 |  | 购物车id |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ is_checked | boolean | 非必须 |  | 购物车是否选中 |
| ├─ is_plus_buy | boolean | 非必须 |  | 是加价购商品 |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_type | string | 非必须 |  | 商品类型。可选值有 normal 实体类商品;services 服务类商品, normal_gift:实体赠品,services_gift:服务类赠品 |
| ├─ items_id | string | 非必须 |  | 组合商品关联商品id |
| ├─ marketing_id | integer | 非必须 |  | 促销id |
| ├─ marketing_type | integer | 非必须 |  | 促销类型 |
| ├─ num | integer | 非必须 |  | 购买商品数量 |
| ├─ pics | integer | 非必须 |  | 图片 |
| ├─ price | integer | 非必须 |  | 购买商品价格 单位分 |
| ├─ shop_id | integer | 非必须 |  | 店铺id 或者 社区id |
| ├─ shop_type | integer | 非必须 |  | 店铺类型；distributor:店铺，shop:门店，community:社区, mall:商城, drug 药品清单 |
| ├─ updated | integer | 非必须 |  | 修改时间 |
| ├─ user_id | integer | 非必须 |  | 会员id |
| ├─ user_ident | integer | 非必须 |  | 会员ident,会员信息和session生成的唯一值 |
| ├─ wxa_appid | integer | 非必须 |  | 小程序appid |
获取权益核销记录列表
基本信息
Path： /api/h5app/wxapp/rightsLogs
Method： GET
接口描述：
获取权益核销记录列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总记录数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ rights_id | string | 非必须 |  | 权益ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ rights_name | string | 非必须 |  | 权益标题 |
| ├─ consum_num | string | 非必须 |  | 消耗次数 |
| ├─ rights_subname | string | 非必须 |  | 权益子标题 |
| ├─ attendant | string | 非必须 |  | 服务员 |
| ├─ consum_time | string | 非必须 |  | 核销时间 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ salesperson_mobile | string | 非必须 |  | 核销员手机号 |
| ├─ store_name | string | 非必须 |  | 门店名称 |
获取权益详情
基本信息
Path： /api/h5app/wxapp/rights/{rights_id}
Method： GET
接口描述：
获取权益详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| rights_id
|
| 权益id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ rights_id | string | 非必须 |  | 权益ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ can_reservation | string | 非必须 |  | 是否可预约 |
| ├─ rights_name | string | 非必须 |  | 权益标题 |
| ├─ rights_subname | string | 非必须 |  | 权益子标题 |
| ├─ total_num | string | 非必须 |  | 服务商品原始总次数,0标示无限制 |
| ├─ total_consum_num | string | 非必须 |  | 总消耗次数 |
| ├─ is_not_limit_num | integer | 非必须 |  | 限制核销次数,1:不限制；2:限制 |
| ├─ status | string | 非必须 |  | 权益状态; valid:有效的, expire:过期的; invalid:失效的 |
| ├─ start_time | integer | 非必须 |  | 权益开始时间 |
| ├─ end_time | integer | 非必须 |  | 权益结束时间 |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ rights_from | string | 非必须 |  | 权益来源 |
| ├─ operator_desc | string | 非必须 |  | 操作员信息 |
| ├─ label_infos | object [] | 非必须 |  |  |
item 类型: object
| ├─ label_id | string | 非必须 |  |  |
| ├─ label_name | string | 非必须 |  |  |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ server_time | integer | 非必须 |  |  |
获取点赞状态
基本信息
Path： /api/h5app/wxapp/order/ratePraise/status
Method： GET
接口描述：
获取点赞状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| rate_ids
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  |  |
获取用户拼团订单列表
基本信息
Path： /api/h5app/wxapp/groupOrders
Method： GET
接口描述：
获取用户拼团订单列表
请求参数
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| team_status
| 否
|
| 不传或者空查询全部,1 进行中, 2 成功, 3 失败
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总记录条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ act_id | integer | 非必须 |  | 活动ID号 |
| ├─ begin_time | integer | 非必须 |  | 开团时间 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ disabled | integer | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ end_time | integer | 非必须 |  | 结束时间(根据成团时效和活动结束时间算出来的) |
| ├─ group_goods_type | string | 非必须 |  | 团购活动商品类型 |
| ├─ head_mid | integer | 非必须 |  | 团长会员ID |
| ├─ id | integer | 非必须 |  | id |
| ├─ itemId | integer | 非必须 |  | 商品id |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ join_person_num | integer | 非必须 |  | 参与人数 |
| ├─ member_info | object | 非必须 |  | 会员信息 |
| ├─ headimgurl | string | 非必须 |  | 会员头像 |
| ├─ nickname | string | 非必须 |  | 会员昵称 |
| ├─ member_list | object [] | 非必须 |  | 拼团会员信息 |
item 类型: object
| ├─ act_id | integer | 非必须 |  | 活动ID号 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ disabled | integer | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ group_goods_type | string | 非必须 |  | 团购活动商品类型 |
| ├─ id | integer | 非必须 |  | id |
| ├─ join_time | integer | 非必须 |  | 参团时间 |
| ├─ member_id | string | 非必须 |  | 会员id |
| ├─ member_info | object | 非必须 |  | 会员信息 |
| ├─ headimgurl | string | 非必须 |  | 会员头像 |
| ├─ nickname | string | 非必须 |  | 会员昵称 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ team_id | string | 非必须 |  | 团id号 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ person_num | integer | 非必须 |  | 拼团人数 |
| ├─ pics | string | 非必须 |  | 商品图片 |
| ├─ price | integer | 非必须 |  | 拼团价格 |
| ├─ team_id | string | 非必须 |  | 团id号 |
| ├─ team_status | integer | 非必须 |  | 状态:1.进行中2.成功3.失败 |
| ├─ updated | integer | 非必须 |  | 修改时间 |
获取用户拼团订单详情
基本信息
Path： /api/h5app/wxapp/groupOrders/{team_id}
Method： GET
接口描述：
获取用户拼团订单详情
请求参数
路径参数
参数名称
示例
备注
| teamId
|
| 拼团id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ activity_info | object | 非必须 |  | 拼团活动信息 |
| ├─ act_name | string | 非必须 |  | 活动名称 |
| ├─ act_price | integer | 非必须 |  | 活动价格 单位分 |
| ├─ begin_time | integer | 非必须 |  | 开始时间 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ disabled | string | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ end_time | integer | 非必须 |  | 结束时间 |
| ├─ free_post | integer | 非必须 |  | 是否包邮 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ group_goods_type | string | 非必须 |  | 团购活动商品类型 |
| ├─ groups_activity_id | integer | 非必须 |  | 活动ID |
| ├─ itemId | integer | 非必须 |  | skuid |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ last_seconds | integer | 非必须 |  |  |
| ├─ limit_buy_num | integer | 非必须 |  | 限买数量 |
| ├─ limit_time | integer | 非必须 |  | 成团时效(单位时) |
| ├─ over_time | integer | 非必须 |  | 拼团活动结束时间 |
| ├─ person_num | integer | 非必须 |  | 拼团人数 |
| ├─ pics | object [] | 非必须 |  | 活动封面 |
item 类型: object
| ├─ #0 | string | 非必须 |  | 图片地址链接 数组下标为数字0开始 |
| ├─ price | integer | 非必须 |  | 活动价格 |
| ├─ remaining_time | integer | 非必须 |  |  |
| ├─ rig_up | integer | 非必须 |  | 是否展示开团列表 |
| ├─ robot | integer | 非必须 |  | 是否成团机器人 |
| ├─ share_desc | string | 非必须 |  | 分享描述 |
| ├─ shop_id | integer | 非必须 |  | 下单门店 |
| ├─ show_status | integer | 非必须 |  |  |
| ├─ store | integer | 非必须 |  | 拼团库存 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ status | integer | 非必须 |  | 活动的状态【null 未知错误】【1 未开始】【2 正在进行】【3 已结束】 |
| ├─ member_list | object | 非必须 |  | 拼团会员信息 |
| ├─ total_count | integer | 非必须 |  | 参团会员总数 |
| ├─ list | object [] | 非必须 |  | 会员信息 |
item 类型: object
| ├─ act_id | integer | 非必须 |  | 活动ID号 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ disabled | integer | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ group_goods_type | string | 非必须 |  | 团购活动商品类型 |
| ├─ id | integer | 非必须 |  | id |
| ├─ join_time | integer | 非必须 |  | 参团时间 |
| ├─ member_id | string | 非必须 |  | 会员id |
| ├─ member_info | object | 非必须 |  | 会员信息 |
| ├─ headimgurl | string | 非必须 |  | 会员头像 |
| ├─ nickname | string | 非必须 |  | 会员昵称 |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ team_id | string | 非必须 |  | 团id号 |
| ├─ team_info | object | 非必须 |  | 参团信息 |
| ├─ act_id | integer | 非必须 |  | 活动ID号 |
| ├─ begin_time | integer | 非必须 |  | 开团时间 |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ disabled | integer | 非必须 |  | 是否禁用 true=禁用,false=启用 |
| ├─ end_time | integer | 非必须 |  | 结束时间(根据成团时效和活动结束时间算出来的) |
| ├─ group_goods_type | integer | 非必须 |  | 团购活动商品类型 |
| ├─ head_mid | integer | 非必须 |  | 团长会员ID |
| ├─ id | integer | 非必须 |  | id |
| ├─ join_person_num | integer | 非必须 |  | 参与人数 |
| ├─ team_id | integer | 非必须 |  | 团id号 |
| ├─ team_status | integer | 非必须 |  | 状态:1.进行中2.成功3.失败 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ status | integer | 非必须 |  | 拼团的状态【null 未知错误】【1 未开始】【2 正在进行】【3 已结束】 |
| ├─ progress | integer | 非必须 |  | 拼团的进度【null 未知错误】【1 未开始】【2 正在拼团】【3 拼团成功】【4 拼团失败】 |
获取用户订单列表
基本信息
Path： /api/h5app/wxapp/orders
Method： GET
接口描述：
获取用户订单列表
请求参数
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| order_id
| 否
|
| 订单号
| mobile
| 否
|
| 手机号
| order_type
| 否
|
| 订单类型
| time_start_begin
| 否
|
| 查询开始时间
| time_start_end
| 否
|
| 查询结束时间
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ title | string | 非必须 |  | 订单标题 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位 |
| ├─ total_rebate | string | 非必须 |  | 总分销金额，以分为单位 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ order_status | string | 非必须 |  | 订单状态。可选值有 DONE—订单完成;NOTPAY—未支付;PART_PAYMENT-部分付款;WAIT_GROUPS_SUCCESS-等待拼团成功;PAYED-已支付;CANCEL—已取消;WAIT_BUYER_CONFIRM-待用户收货 |
| ├─ order_source | string | 非必须 |  | 订单来源。可选值有 member-用户自主下单;shop-商家代客下单 |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 normal:普通实体订单 |
| ├─ auto_cancel_time | string | 非必须 |  | 订单自动取消时间 |
| ├─ is_distribution | string | 非必须 |  | 是否分销订单 |
| ├─ source_id | string | 非必须 |  | 订单来源id |
| ├─ monitor_id | string | 非必须 |  | 订单监控页面id |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货 |
| ├─ receiver_name | string | 非必须 |  | 收货人姓名 |
| ├─ receiver_mobile | string | 非必须 |  | 收货人手机号 |
| ├─ receiver_zip | string | 非必须 |  | 收货人邮编 |
| ├─ receiver_state | string | 非必须 |  | 收货人所在省份 |
| ├─ receiver_city | string | 非必须 |  | 收货人所在城市 |
| ├─ receiver_district | string | 非必须 |  | 收货人所在地区 |
| ├─ receiver_address | string | 非必须 |  | 收货人详细地址 |
| ├─ create_time | string | 非必须 |  | 订单创建时间 |
| ├─ update_time | string | 非必须 |  | 订单更新时间 |
| ├─ freight_fee | string | 非必须 |  | 运费价格，以分为单位 |
| ├─ item_fee | string | 非必须 |  | 商品总金额，以分为单位 |
| ├─ member_discount | string | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | string | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ coupon_discount_desc | string | 非必须 |  | 优惠券使用详情 |
| ├─ member_discount_desc | string | 非必须 |  | 会员折扣使用详情 |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ receipt_type | string | 非必须 |  | 收货方式。可选值有 logistics:物流;ziti:店铺自提 |
| ├─ ziti_code | string | 非必须 |  | 店铺自提码 |
| ├─ ziti_status | string | 非必须 |  | 店铺自提状态。可选值有 PENDING:等待自提;DONE:自提完成;NOTZITI:自提完成; APPROVE:审核通过,药品自提需要审核 |
| ├─ end_time | string | 非必须 |  | 订单完成时间 |
| ├─ cancel_status | string | 非必须 |  | 取消订单状态。可选值有 NO_APPLY_CANCEL 未申请;WAIT_PROCESS 等待审核;REFUND_PROCESS 退款处理;SUCCESS 取消成功;FAILS 取消失败 |
| ├─ cost_fee | string | 非必须 |  | 商品成本价，以分为单位 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | string | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ order_class | string | 非必须 |  | 订单种类。可选值有 normal:普通订单;groups:拼团订单;;community 社区活动订单;bargain:助力订单;seckill:秒杀订单;shopguide:导购订单 |
| ├─ salesman_id | string | 非必须 |  | 导购员ID |
| ├─ auto_finish_time | string | 非必须 |  | 订单自动完成时间 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ discount_info | string | 非必须 |  | 订单优惠详情 |
| ├─ point | string | 非必须 |  | 商品总积分 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ remark | string | 非必须 |  | 订单备注 |
| ├─ third_params | string | 非必须 |  | 第三方特殊字段存储(DC2Type:json_array) |
| ├─ invoice | string | 非必须 |  | 发票信息(DC2Type:json_array) |
| ├─ send_point | string | 非必须 |  | 是否分发积分0否 1是 |
| ├─ step_paid_fee | string | 非必须 |  | 分阶段付款已支付金额，以分为单位 |
| ├─ delivery_corp_source | string | 非必须 |  | 快递代码来源 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ invoice_number | string | 非必须 |  | 发票号 |
| ├─ is_invoiced | string | 非必须 |  | 是否已开发票 |
| ├─ is_online_order | string | 非必须 |  | 是否为线上订单 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ pay_status | string | 非必须 |  | 支付状态。可选值有 NOTPAY—未支付;PAYED-已支付;ADVANCE_PAY-预付款完成;TAIL_PAY-支付尾款中 |
| ├─ type | string | 非必须 |  | 订单类型，0普通订单,1跨境订单,....其他 |
| ├─ identity_id | string | 非必须 |  | 身份证号码 |
| ├─ identity_name | string | 非必须 |  | 身份证姓名 |
| ├─ total_tax | string | 非必须 |  | 总税费 |
| ├─ audit_status | string | 非必须 |  | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_msg | string | 非必须 |  | 审核意见 |
| ├─ taxable_fee | string | 非必须 |  | 计税总价，以分为单位 |
| ├─ point_fee | string | 非必须 |  | 积分抵扣时分摊的积分的金额，以分为单位 |
| ├─ point_use | string | 非必须 |  | 积分抵扣使用的积分数 |
| ├─ get_point_type | string | 非必须 |  | 获取积分类型，0 老订单按订单完成时送,1 新订单按下单时计算送 |
| ├─ get_points | string | 非必须 |  | 订单获取积分 |
| ├─ bonus_points | string | 非必须 |  | 购物赠送积分 |
| ├─ is_shopscreen | string | 非必须 |  | 是否门店订单 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ is_profitsharing | string | 非必须 |  | 是否分账订单 1不分账 2分账 |
| ├─ profitsharing_status | string | 非必须 |  | 分账状态 1未分账 2已分账 |
| ├─ profitsharing_rate | string | 非必须 |  | 分账费率 |
| ├─ order_auto_close_aftersales_time | string | 非必须 |  | 自动关闭售后时间 |
| ├─ pack | string | 非必须 |  | 包装 |
| ├─ bind_auth_code | string | 非必须 |  | 订单订单验证码 |
| ├─ freight_type | string | 非必须 |  | 运费类型-用于积分商城 cash:现金 point:积分 |
| ├─ item_point | string | 非必须 |  | 商品积分 |
| ├─ extra_points | string | 非必须 |  | 订单获取额外积分 |
| ├─ uppoint_use | string | 非必须 |  | 积分抵扣使用的积分升值数 |
| ├─ order_status_msg | string | 非必须 |  | 订单状态描述 |
| ├─ order_status_des | string | 非必须 |  | 订单状态 |
| ├─ source_name | string | 非必须 |  |  |
| ├─ distributor_info | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 最后修改时间 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ province | string | 非必须 |  | 省份 |
| ├─ city | string | 非必须 |  | 城市 |
| ├─ area | string | 非必须 |  | 区域 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ child_count | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ review_status | string | 非必须 |  | 入驻审核状态，0未审核，1已审核 |
| ├─ source_from | string | 非必须 |  | 店铺来源，1管理端添加，2小程序申请入驻 |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内	 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ regionauth_id | string | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | string | 非必须 |  | 分账平台服务费率 |
| ├─ create_date | string | 非必须 |  | 创建时间 |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_bn | string | 非必须 |  | 商品编码 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ pic | string | 非必须 |  | 商品图片 |
| ├─ num | integer | 非必须 |  | 购买商品数量 |
| ├─ price | integer | 非必须 |  | 单价，以分为单位 |
| ├─ total_fee | integer | 非必须 |  | 订单金额，以分为单位 |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ rebate | integer | 非必须 |  | 单个分销金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 总分销金额，以分为单位 |
| ├─ item_fee | integer | 非必须 |  | 商品总金额，以分为单位 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ discount_info | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_total_store | string | 非必须 |  | 是否是总部库存(true:总部库存，false:店铺库存) |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货 |
| ├─ aftersales_status | string | 非必须 |  | 售后状态。可选值有 WAIT_SELLER_AGREE 0 等待商家处理;WAIT_BUYER_RETURN_GOODS 1 商家接受申请，等待消费者回寄;WAIT_SELLER_CONFIRM_GOODS 2 消费者回寄，等待商家收货确认;SELLER_REFUSE_BUYER 3 售后驳回;SELLER_SEND_GOODS 4 卖家重新发货 换货完成;REFUND_SUCCESS 5 退款成功;REFUND_CLOSED 6 退款关闭;CLOSED 7 售后关闭 |
| ├─ refunded_fee | integer | 非必须 |  | 退款金额，以分为单位 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ item_point | integer | 非必须 |  | 商品积分 |
| ├─ point | integer | 非必须 |  | 商品总积分 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型,normal:正常商品，gift: 赠品, plus_buy: 加价购商品 |
| ├─ volume | integer | 非必须 |  | 商品体积 |
| ├─ weight | integer | 非必须 |  | 商品重量 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ auto_close_aftersales_time | integer | 非必须 |  | 自动关闭售后时间 |
| ├─ share_points | integer | 非必须 |  | 积分抵扣时分摊的积分值 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣时分摊的积分的金额，以分为单位 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ ome_order_id | string | 非必须 |  | ome订单号 |
| ├─ delivery_item_num | integer | 非必须 |  | 发货单发货数量 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ distributor_name | string | 非必须 |  |  |
| ├─ delivery_type | string | 非必须 |  |  |
| ├─ orders_delivery_id | string | 非必须 |  | orders_delivery_id |
| ├─ is_all_delivery | string | 非必须 |  |  |
| ├─ delivery_corp_name | string | 非必须 |  | 快递公司名称 |
| ├─ is_split | string | 非必须 |  |  |
| ├─ pager | object | 非必须 |  |  |
| ├─ count | integer | 非必须 |  | 总记录条数 |
| ├─ page_no | integer | 非必须 |  | 页码 |
| ├─ page_size | integer | 非必须 |  | 每页记录数 |
| ├─ rate_status | string | 非必须 |  |  |
获取用户订单发票列表
基本信息
Path： /api/h5app/wxapp/orders/invoice
Method： GET
接口描述：
获取用户订单发票列表
请求参数
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取门店列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总记录条数 |
| ├─ list | object [] | 非必须 |  | 数据集合 |
item 类型: object
| ├─ id | string | 非必须 |  | 自增id |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ status | integer | 非必须 |  | 是否开票 |
| ├─ invoice | string | 非必须 |  | 发票信息 |
获取自提码
基本信息
Path： /api/h5app/wxapp/ziticode
Method： POST
接口描述：
获取自提码
请求参数
Query
参数名称
是否必须
示例
备注
| barcode_url
| 是
|
| 条形码
| qrcode_url
| 是
|
| 二维码
| code
| 是
|
| 码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 会员中心 |
| ├─ barcode_url | string | 非必须 |  | 一维码链接 |
| ├─ qrcode_url | string | 非必须 |  | 二维码链接 |
| ├─ code | string | 非必须 |  | 自提码 |
| ├─ ziti_status | string | 非必须 |  | 自提状态 |
获取自提订单提货码
基本信息
Path： /api/h5app/wxapp/pickupcode/{order_id}
Method： GET
接口描述：
获取自提订单提货码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| order_id
|
| 订单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 发送状态 |
获取订单优惠以及运费信息
基本信息
Path： /api/h5app/wxapp/getFreightFee
Method： POST
接口描述：
获取订单优惠以及运费信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店ID
| item_id
| 否
|
| 交易商品ID
| item_num
| 否
|
| 交易商品数量
| items[][item_id]
| 否
|
| 交易商品ID
| items[][num]
| 否
|
| 交易商品数量
| bargain_id
| 否
|
| 砍价活动id
| source_id
| 否
|
| 订单来源ID
| monitor_id
| 否
|
| 监控页面ID
| salesman_id
| 否
|
| 导购ID
| receipt_type
| 否
|
| 收货方式：ziti 自提 logistics 快递
| receiver_name
| 否
|
| 收货人姓名
| receiver_mobile
| 否
|
| 收货人手机号
| receiver_zip
| 否
|
| 收货人邮编
| receiver_state
| 否
|
| 收货人所在省份
| receiver_city
| 否
|
| 收货人所在城市
| receiver_district
| 否
|
| 收货人所在地区
| receiver_address
| 否
|
| 收货人详细地址
| cart_type
| 是
|
| 购物车类型 cart 购物车 fastbuy 立即购买 offline 离线购物车
| order_type
| 是
|
| 订单类型，service服务业订单 bargain 砍价订单 normal 实物订单
| pay_type
| 否
|
| 支付类型 wxpay 微信支付 point 积分支付 deposit 储值支付
| coupon_discount
| 否
|
| 优惠券优惠码
| not_use_coupon
| 否
|
| 不使用优惠券
| iscrossborder
| 否
|
| 是否海外购
| isShopScreen
| 否
|
| 是否大屏
| isNostores
| 否
|
| 是否支持无门店下单门店自提
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ user_id | integer | 非必须 |  | 用户ID |
| ├─ distributor_id | integer | 非必须 |  | 店铺ID |
| ├─ is_distribution | boolean | 非必须 |  | 是否店铺订单 |
| ├─ remark | string | 非必须 |  | 订单备注 |
| ├─ mobile | string | 非必须 |  | 订单号 |
| ├─ order_source | string | 非必须 |  | 订单来源 |
| ├─ order_class | string | 非必须 |  | 订单种类。可选值有 normal:普通订单;groups:拼团订单;community 社区活动订单;bargain:助力订单;seckill:秒杀订单;shopguide:导购订单 |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 normal:普通实体订单 |
| ├─ order_status | string | 非必须 |  | 订单状态。可选值有 DONE—订单完成;NOTPAY—未支付;PART_PAYMENT-部分付款;WAIT_GROUPS_SUCCESS-等待拼团成功;PAYED-已支付;CANCEL—已取消;WAIT_BUYER_CONFIRM-待用户收货 |
| ├─ auto_cancel_time | number | 非必须 |  | 订单自动取消时间 |
| ├─ discount_fee | number | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ discount_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ type | string | 非必须 |  | 优惠类型 |
| ├─ rule | string | 非必须 |  | 促销规则 |
| ├─ discount_fee | integer | 非必须 |  | 优惠金额 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ salesman_id | integer | 非必须 |  | 导购员ID |
| ├─ point_use | integer | 非必须 |  | 积分抵扣使用的积分数 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣金额，以分为单位 |
| ├─ get_point_type | integer | 非必须 |  | 获取积分类型，0 老订单按订单完成时送,1 新订单按下单时计算送 |
| ├─ is_profitsharing | integer | 非必须 |  | 是否分账订单 1不分账 2分账 |
| ├─ profitsharing_rate | integer | 非必须 |  | 分账费率 |
| ├─ pack | integer | 非必须 |  | 包装 |
| ├─ fee_rate | number | 非必须 |  | 货币汇率 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ source_id | integer | 非必须 |  | 订单来源id |
| ├─ monitor_id | integer | 非必须 |  | 订单监控页面id |
| ├─ is_logistics | boolean | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ point | integer | 非必须 |  | 消费积分 |
| ├─ item_fee | string | 非必须 |  | 商品金额，以分为单位 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 订单总分销金额，以分为单位 |
| ├─ title | string | 非必须 |  | 订单标题 |
| ├─ totalItemNum | integer | 非必须 |  | 商品商品数量 |
| ├─ goods_discount | integer | 非必须 |  | 订单优惠金额 |
| ├─ member_discount | integer | 非必须 |  | 会员优惠 |
| ├─ freight_fee | integer | 非必须 |  | 运费价格，以分为单位 |
| ├─ is_shopscreen | boolean | 非必须 |  | 是否门店大屏订单 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券优惠金额 |
| ├─ coupon_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  | 优惠券ID |
| ├─ coupon_code | string | 非必须 |  | 优惠券码 |
| ├─ info | string | 非必须 |  | 优惠信息 |
| ├─ type | string | 非必须 |  | 优惠类型 |
| ├─ rule | string | 非必须 |  | 促销规则 |
| ├─ discount_fee | integer | 非必须 |  | 优惠金额 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ bonus_points | integer | 非必须 |  | 购物赠送积分 |
| ├─ user_point | integer | 非必须 |  | 用户积分 |
| ├─ max_point | integer | 非必须 |  | 本单会员最大可抵扣积分 |
| ├─ limit_point | integer | 非必须 |  | 本单最大可抵扣积分 |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_bn | string | 非必须 |  | 商品编码 |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ user_id | integer | 非必须 |  | 用户id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ num | number | 非必须 |  | 购买商品数量 |
| ├─ price | number | 非必须 |  | 单价，以分为单位 |
| ├─ item_fee | number | 非必须 |  | 商品总金额，以分为单位 |
| ├─ cost_fee | number | 非必须 |  | 商品成本价，以分为单位 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ total_fee | number | 非必须 |  | 订单金额，以分为单位 |
| ├─ discount_fee | number | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ discount_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ type | string | 非必须 |  | 优惠类型 |
| ├─ rule | string | 非必须 |  | 促销规则 |
| ├─ discount_fee | integer | 非必须 |  | 优惠金额 |
| ├─ rebate | number | 非必须 |  | 单个分销金额，以分为单位 |
| ├─ total_rebate | number | 非必须 |  | 总分销金额，以分为单位 |
| ├─ distributor_id | integer | 非必须 |  | 分销商id |
| ├─ is_total_store | boolean | 非必须 |  | 是否是总部库存 |
| ├─ fee_rate | number | 非必须 |  | 货币汇率 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ item_point | integer | 非必须 |  | 商品积分 |
| ├─ point | integer | 非必须 |  | 商品总积分 |
| ├─ volume | number | 非必须 |  | 商品体积 |
| ├─ weight | number | 非必须 |  | 商品重量 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型 |
| ├─ type | integer | 非必须 |  | 订单类型，0普通订单,1跨境订单 |
| ├─ crossborder_tax_rate | number | 非必须 |  | 商品跨境税费 |
| ├─ is_logistics | boolean | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ member_discount | number | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | number | 非必须 |  | 优惠券抵扣金额，以分为单位 |
获取订单详情
基本信息
Path： /api/h5app/wxapp/order/{order_id}
Method： GET
接口描述：
获取订单详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ orderInfo | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ title | string | 非必须 |  | 订单标题 |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ user_id | string | 非必须 |  | 购买用户 |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ mobile | string | 非必须 |  | 购买用户手机号 |
| ├─ freight_fee | integer | 非必须 |  | 运费价格，以分为单位 |
| ├─ freight_type | string | 非必须 |  |  |
| ├─ item_fee | string | 非必须 |  | 商品总金额，以分为单位 |
| ├─ item_point | integer | 非必须 |  | 商品积分 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 应付总金额,以分为单位 |
| ├─ step_paid_fee | integer | 非必须 |  | 分阶段付款已支付金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 总分销金额，以分为单位 |
| ├─ distributor_id | string | 非必须 |  | 门店ID |
| ├─ receipt_type | string | 非必须 |  | 收货方式。可选值有 logistics:物流;ziti:店铺自提 |
| ├─ ziti_code | string | 非必须 |  | 店铺自提码 |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ ziti_status | string | 非必须 |  | 店铺自提状态。可选值有 PENDING:等待自提;DONE:自提完成;NOTZITI:自提完成; APPROVE:审核通过,药品自提需要审核 |
| ├─ order_status | string | 非必须 |  | 订单状态。可选值有 DONE—订单完成;NOTPAY—未支付;PART_PAYMENT-部分付款;WAIT_GROUPS_SUCCESS-等待拼团成功;PAYED-已支付;CANCEL—已取消;WAIT_BUYER_CONFIRM-待用户收货 |
| ├─ order_source | string | 非必须 |  | 订单来源。可选值有 member-用户自主下单;shop-商家代客下单 |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 normal:普通实体订单 |
| ├─ order_class | string | 非必须 |  | 订单种类。可选值有 normal:普通订单;groups:拼团订单;;community 社区活动订单;bargain:助力订单;seckill:秒杀订单;shopguide:导购订单 |
| ├─ auto_cancel_time | string | 非必须 |  | 订单自动取消时间 |
| ├─ auto_cancel_seconds | integer | 非必须 |  |  |
| ├─ auto_finish_time | string | 非必须 |  | 订单自动完成时间 |
| ├─ is_distribution | string | 非必须 |  | 是否分销订单 |
| ├─ source_id | string | 非必须 |  | 订单来源id |
| ├─ monitor_id | string | 非必须 |  | 订单监控页面id |
| ├─ salesman_id | string | 非必须 |  | 导购员ID |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_corp_source | string | 非必须 |  | 快递代码来源 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货 |
| ├─ cancel_status | string | 非必须 |  | 取消订单状态。可选值有 NO_APPLY_CANCEL 未申请;WAIT_PROCESS 等待审核;REFUND_PROCESS 退款处理;SUCCESS 取消成功;FAILS 取消失败 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ end_time | string | 非必须 |  | 订单完成时间 |
| ├─ end_date | string | 非必须 |  |  |
| ├─ receiver_name | string | 非必须 |  | 收货人姓名 |
| ├─ receiver_mobile | string | 非必须 |  | 收货人手机号 |
| ├─ receiver_zip | string | 非必须 |  | 收货人邮编 |
| ├─ receiver_state | string | 非必须 |  | 收货人所在省份 |
| ├─ receiver_city | string | 非必须 |  | 收货人所在城市 |
| ├─ receiver_district | string | 非必须 |  | 收货人所在地区 |
| ├─ receiver_address | string | 非必须 |  | 收货人详细地址 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额 |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ point | integer | 非必须 |  | 商品总积分 |
| ├─ pay_type | string | 非必须 |  | 支付方式。wxpay-微信支付;deposit-预存款支付;pos-刷卡;point-积分 |
| ├─ remark | string | 非必须 |  | 订单备注 |
| ├─ third_params | object | 非必须 |  |  |
| ├─ is_liveroom | string | 非必须 |  |  |
| ├─ invoice | string | 非必须 |  | 发票信息(DC2Type:json_array) |
| ├─ send_point | integer | 非必须 |  | 是否分发积分0否 1是 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ is_invoiced | string | 非必须 |  | 是否已开发票 |
| ├─ invoice_number | string | 非必须 |  | 发票号 |
| ├─ audit_status | string | 非必须 |  | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_msg | string | 非必须 |  | 审核意见 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣时分摊的积分的金额，以分为单位 |
| ├─ point_use | integer | 非必须 |  | 积分抵扣使用的积分数 |
| ├─ pay_status | string | 非必须 |  | 支付状态。可选值有 NOTPAY—未支付;PAYED-已支付;ADVANCE_PAY-预付款完成;TAIL_PAY-支付尾款中 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ bonus_points | integer | 非必须 |  | 购物赠送积分 |
| ├─ get_point_type | integer | 非必须 |  | 获取积分类型，0 老订单按订单完成时送,1 新订单按下单时计算送 |
| ├─ pack | string | 非必须 |  | 包装 |
| ├─ is_shopscreen | string | 非必须 |  | 是否门店订单 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ is_profitsharing | integer | 非必须 |  | 是否分账订单 1不分账 2分账 |
| ├─ profitsharing_status | integer | 非必须 |  | 分账状态 1未分账 2已分账 |
| ├─ order_auto_close_aftersales_time | string | 非必须 |  | 自动关闭售后时间 |
| ├─ profitsharing_rate | integer | 非必须 |  | 分账费率 |
| ├─ bind_auth_code | string | 非必须 |  |  |
| ├─ extra_points | integer | 非必须 |  |  |
| ├─ type | integer | 非必须 |  | 订单类型，0普通订单,1跨境订单,....其他 |
| ├─ taxable_fee | integer | 非必须 |  | 计税总价，以分为单位 |
| ├─ identity_id | string | 非必须 |  | 身份证号码 |
| ├─ identity_name | string | 非必须 |  | 身份证姓名 |
| ├─ total_tax | integer | 非必须 |  | 总税费 |
| ├─ discount_info | string | 非必须 |  |  |
| ├─ can_apply_aftersales | integer | 非必须 |  |  |
| ├─ distributor_name | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ user_id | string | 非必须 |  | 购买用户 |
| ├─ act_id | string | 非必须 |  | 营销活动ID，团购ID，社区拼团ID，秒杀活动ID等 |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_bn | string | 非必须 |  | 商品编码 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ pic | string | 非必须 |  | 商品图片 |
| ├─ num | integer | 非必须 |  | 购买商品数量 |
| ├─ price | integer | 非必须 |  | 单价，以分为单位 |
| ├─ total_fee | integer | 非必须 |  | 应付总金额,以分为单位 |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ rebate | integer | 非必须 |  | 单个分销金额，以分为单位 |
| ├─ total_rebate | integer | 非必须 |  | 总分销金额，以分为单位 |
| ├─ item_fee | integer | 非必须 |  | 商品总金额，以分为单位 |
| ├─ cost_fee | integer | 非必须 |  | 商品成本价，以分为单位 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ coupon_discount | integer | 非必须 |  | 优惠券抵扣金额，以分为单位 |
| ├─ discount_fee | integer | 非必须 |  | 订单优惠金额 |
| ├─ discount_info | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ is_total_store | string | 非必须 |  | 是否是总部库存(true:总部库存，false:店铺库存) |
| ├─ distributor_id | string | 非必须 |  | 门店ID |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ delivery_corp | string | 非必须 |  | 快递公司 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ delivery_img | string | 非必须 |  | 快递发货凭证 |
| ├─ delivery_time | string | 非必须 |  | 发货时间 |
| ├─ delivery_status | string | 非必须 |  | 发货状态。可选值有 DONE—已发货;PENDING—待发货 |
| ├─ aftersales_status | string | 非必须 |  | 售后状态。可选值有 WAIT_SELLER_AGREE 0 等待商家处理;WAIT_BUYER_RETURN_GOODS 1 商家接受申请，等待消费者回寄;WAIT_SELLER_CONFIRM_GOODS 2 消费者回寄，等待商家收货确认;SELLER_REFUSE_BUYER 3 售后驳回;SELLER_SEND_GOODS 4 卖家重新发货 换货完成;REFUND_SUCCESS 5 退款成功;REFUND_CLOSED 6 退款关闭;CLOSED 7 售后关闭 |
| ├─ refunded_fee | integer | 非必须 |  | 退款金额，以分为单位 |
| ├─ after_sales_fee | integer | 非必须 |  | 退款中的金额，以分为单位 |
| ├─ remain_fee | integer | 非必须 |  | 剩余可退款金额，以分为单位 |
| ├─ remain_point | integer | 非必须 |  | 剩余可退积分 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ cny_fee | integer | 非必须 |  |  |
| ├─ item_point | integer | 非必须 |  | 商品积分 |
| ├─ point | integer | 非必须 |  | 商品总积分 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ order_item_type | string | 非必须 |  | 订单商品类型,normal:正常商品，gift: 赠品, plus_buy: 加价购商品 |
| ├─ volume | integer | 非必须 |  | 商品体积 |
| ├─ weight | integer | 非必须 |  | 商品重量 |
| ├─ is_rate | string | 非必须 |  | 是否评价 |
| ├─ auto_close_aftersales_time | string | 非必须 |  | 自动关闭售后时间 |
| ├─ share_points | integer | 非必须 |  | 积分抵扣时分摊的积分值 |
| ├─ point_fee | integer | 非必须 |  | 积分抵扣时分摊的积分的金额，以分为单位 |
| ├─ is_logistics | string | 非必须 |  | 门店缺货商品总部快递发货 |
| ├─ ome_order_id | string | 非必须 |  | ome订单号 |
| ├─ delivery_item_num | string | 非必须 |  | 发货单发货数量 |
| ├─ get_points | integer | 非必须 |  | 订单获取积分 |
| ├─ order_status_des | string | 非必须 |  |  |
| ├─ order_status_msg | string | 非必须 |  |  |
| ├─ latest_aftersale_time | integer | 非必须 |  |  |
| ├─ estimate_get_points | string | 非必须 |  |  |
| ├─ delivery_type | string | 非必须 |  |  |
| ├─ is_all_delivery | string | 非必须 |  |  |
| ├─ pickupcode_status | string | 非必须 |  |  |
| ├─ is_split | string | 非必须 |  |  |
| ├─ logistics_items | string | 非必须 |  |  |
| ├─ tradeInfo | string | 非必须 |  |  |
| ├─ distributor | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 门店ID |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ mobile | string | 非必须 |  | 购买用户手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ child_count | integer | 非必须 |  |  |
| ├─ is_default | integer | 非必须 |  | 门店id |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 地区编码 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 地区名称 |
| ├─ is_domestic | integer | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | integer | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  |  |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | integer | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | integer | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | string | 非必须 |  | 平台服务费率 |
| ├─ store_address | string | 非必须 |  |  |
| ├─ store_name | string | 非必须 |  |  |
| ├─ phone | string | 非必须 |  |  |
| ├─ cancelData | string | 非必须 |  |  |
获取订单详情
基本信息
Path： /api/h5app/wxapp/order_new/{order_id}
Method： GET
接口描述：
获取订单详情
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单编号 |
| ├─ user_id | integer | 非必须 |  | 会员id |
| ├─ order_type | string | 非必须 |  | 订单类型 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
| ├─ point | integer | 非必须 |  | 积分 |
| ├─ title | string | 非必须 |  | 描述 |
| ├─ total_fee | integer | 非必须 |  | 支付金额 |
| ├─ create_time | integer | 非必须 |  | 创建时间 |
| ├─ payDate | string | 非必须 |  | 支付时间有效期 |
| ├─ tradeId | integer | 非必须 |  | 支付交易单号 |
| ├─ payStatus | string | 非必须 |  | 支付状态 |
获取评价详情
基本信息
Path： /api/h5app/wxapp/order/rate/detail/{rate_id}
Method： GET
接口描述：
获取评价详情
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ rate_id | string | 非必须 |  | 评价id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ item_id | string | 非必须 |  | 商品ID |
| ├─ goods_id | string | 非必须 |  | 产品ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ rate_pic | string | 非必须 |  | 评价图片 |
| ├─ rate_pic_num | integer | 非必须 |  | 评价图片数量 |
| ├─ content | string | 非必须 |  | 评价内容 |
| ├─ content_len | integer | 非必须 |  | 评价内容长度 |
| ├─ is_reply | string | 非必须 |  | 评价是否回复。0:否；1:是 |
| ├─ disabled | string | 非必须 |  | 是否删除。0:否；1:是 |
| ├─ anonymous | string | 非必须 |  | 是否匿名。0:否；1:是 |
| ├─ star | integer | 非必须 |  | 评价星级 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 修改时间 |
| ├─ unionid | string | 非必须 |  | 微信unionid |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ order_type | string | 非必须 |  | 订单类型 |
| ├─ avatar | string | 非必须 |  |  |
| ├─ username | string | 非必须 |  | 用户昵称 |
| ├─ praise_num | integer | 非必须 |  | 点赞数 |
| ├─ reply_count | integer | 非必须 |  | 评论回复数 |
获取评论回复列表
基本信息
Path： /api/h5app/wxapp/order/replyRate/list
Method： GET
接口描述：
获取评论回复列表
请求参数
路径参数
参数名称
示例
备注
| rate_id
|
| id
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取评论回复初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 数据集合 |
| ├─ total_count | integer | 非必须 |  | 总记录条数 |
| ├─ list | object [] | 非必须 |  | 数据列表 |
item 类型: object
| ├─ reply_id | string | 非必须 |  | 回复id |
| ├─ rate_id | string | 非必须 |  | 评价id |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ operator_id | string | 非必须 |  | 操作员的id |
| ├─ content | string | 非必须 |  | 评价内容 |
| ├─ content_len | integer | 非必须 |  | 评价内容长度 |
| ├─ role | string | 非必须 |  | 回复角色.seller：卖家；buyer：买家 |
| ├─ created | integer | 非必须 |  |  |
| ├─ unionid | string | 非必须 |  | 微信unionid |
| ├─ username | string | 非必须 |  |  |
获取配置信息保存
基本信息
Path： /api/h5app/wxapp/trade/setting
Method： GET
接口描述：
获取配置信息保存
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| pay_type
| 是
|
| 支付类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ merchant_id | string | 非必须 |  | 商户ID |
| ├─ key | string | 非必须 |  | 密钥 |
订单发货单列表
基本信息
Path： /api/h5app/wxapp/delivery/lists
Method： GET
接口描述：
订单发货单列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ delivery_num | integer | 非必须 |  | 发货包裹数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ delivery_corp | string | 非必须 |  | 快递公司编号 |
| ├─ delivery_corp_name | string | 非必须 |  | 快递公司名称 |
| ├─ delivery_code | string | 非必须 |  | 快递单号 |
| ├─ items | object [] | 非必须 |  | 快递单内商品 |
item 类型: object
| ├─ pic | string | 非必须 |  | 商品图片 |
| ├─ items_num | integer | 非必须 |  | 快递单商品数量 |
| ├─ status_msg | string | 非必须 |  | 快递单状态描述 |
| ├─ delivery_info | string | 非必须 |  | 物流信息描述 |
| ├─ delivery_id | integer | 非必须 |  | 发货单id |
订单发货单详情
基本信息
Path： /api/h5app/wxapp/delivery/trackerpull
Method： GET
接口描述：
订单发货单详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| delivery_id
| 是
|
| 发货单id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ AcceptStation | string | 非必须 |  | 物流信息描述 |
| ├─ AcceptTime | string | 非必须 |  | 记录更新时间 |
订单取消
基本信息
Path： /api/h5app/wxapp/order/cancel
Method： POST
接口描述：
订单取消
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| order_id
| 是
|
| 订单号
| cancel_reason
| 是
|
| 取消原因
| other_reason
| 是
|
| 其他原因
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ cancel_id | string | 非必须 |  | 取消ID |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ order_type | string | 非必须 |  | 订单类型。可选值有 service 服务业订单;bargain 砍价订单;distribution 分销订单;normal 普通实体订单 |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位 |
| ├─ progress | integer | 非必须 |  | 处理进度。可选值有 0 待处理;1 已取消;2 处理中;3 已完成; 4 已驳回 |
| ├─ cancel_from | string | 非必须 |  | 取消来源。可选值有 buyer 用户取消订单;shop 商家取消订单 |
| ├─ cancel_reason | string | 非必须 |  | 取消原因 |
| ├─ shop_reject_reason | string | 非必须 |  | 商家拒绝理由 |
| ├─ refund_status | string | 非必须 |  | 退款状态。可选值有 READY 待审核;AUDIT_SUCCESS 审核成功待退款;SUCCESS 退款成功;SHOP_CHECK_FAILS 商家审核不通过;CANCEL 撤销退款;PROCESSING 已发起退款等待到账;FAILS 退款失败; |
| ├─ create_time | integer | 非必须 |  | 订单创建时间 |
| ├─ update_time | integer | 非必须 |  | 订单更新时间 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币汇率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
| ├─ point | integer | 非必须 |  | 消费积分 |
| ├─ pay_type | string | 非必须 |  | 支付方式 |
评价点赞
基本信息
Path： /api/h5app/wxapp/order/rate/praise/{rate_id}
Method： GET
接口描述：
评价点赞
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| rate_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
评价点赞总数
基本信息
Path： /api/h5app/wxapp/order/rate/praise/num/{rate_id}
Method： GET
接口描述：
评价点赞总数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| rate_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ count | integer | 非必须 |  |  |
评价点赞验证
基本信息
Path： /api/h5app/wxapp/order/rate/praise/check/{rate_id}
Method： GET
接口描述：
评价点赞验证
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| rate_id
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
购物车中选择加价购商品
基本信息
Path： /api/h5app/wxapp/cart/check/plusitem
Method： POST
接口描述：
购物车增加
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 店铺id
| shop_type
| 否
|
| 店铺类型：shop,distributor,community
| activity_type
| 否
|
| 活动类型
| activity_id
| 否
|
| 活动id
| item_id
| 是
|
| 商品ID
| num
| 是
|
| 商品数量
| isAccumulate
| 否
|
| 购物车数量是否是累加
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 状态 true 成功 false 失败 |
购物车列表
基本信息
Path： /api/h5app/wxapp/cart
Method： GET
接口描述：
购物车列表
请求参数
Query
参数名称
是否必须
示例
备注
| shop_type
| 是
|
| shop,distributor,community
| shop_id
| 是
|
| shop_id,distributor_id,community_id
| activity_type
| 是
|
| 例子：community
| activity_id
| 否
|
| 活动id
返回数据
成功返回结构
购物车删除
基本信息
Path： /api/h5app/wxapp/cartdel
Method： DELETE
接口描述：
购物车删除
请求参数
Query
参数名称
是否必须
示例
备注
| cart_id
| 是
|
| shop,distributor,community
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 数据集合 |
| ├─ status | boolean | 非必须 |  | 删除状态 true 成功 false 失败 |
购物车增加
基本信息
Path： /api/h5app/wxapp/cart
Method： POST
接口描述：
购物车增加
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 店铺id
| distributor_id
| 否
|
| 店铺id
| shop_type
| 否
|
| 店铺类型：shop,distributor,community
| activity_type
| 否
|
| 活动类型
| items_id[]
| 否
|
| 组合商品ID
| activity_id
| 否
|
| 活动id
| item_id
| 是
|
| 商品ID
| num
| 是
|
| 商品数量
| items[][item_id]
| 否
|
| 批量添加购物车商品ID
| items[][num]
| 否
|
| 批量添加购物车商品数量
| cart_type
| 否
|
| 购物车类型
| isAccumulate
| 否
|
| 购物车数量是否是累加
| iscrossborder
| 否
|
| 是否海外购
| isShopScreen
| 否
|
| 是否大屏操作
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ valid_cart | object [] | 非必须 |  | 有效购物车 |
item 类型: object
| ├─ shop_name | integer | 非必须 |  | 店铺名称 |
| ├─ address | integer | 非必须 |  | 店铺地址 |
| ├─ mobile | integer | 非必须 |  | 店铺手机号 |
| ├─ lat | integer | 非必须 |  | 腾讯地图经度 |
| ├─ lng | integer | 非必须 |  | 腾讯地图纬度 |
| ├─ hour | integer | 非必须 |  | 营业时间 |
| ├─ is_ziti | integer | 非必须 |  | 是否支持自提 |
| ├─ is_delivery | integer | 非必须 |  | 是否支持配送 |
| ├─ shop_id | integer | 非必须 |  | 门店ID |
| ├─ cart_total_price | integer | 非必须 |  | 计算商品促销之前的购物车总价 |
| ├─ item_fee | integer | 非必须 |  | 商品原价总金额 |
| ├─ cart_total_num | integer | 非必须 |  | 购物车商品数量 |
| ├─ cart_total_count | integer | 非必须 |  | 购物车商品总量 |
| ├─ discount_fee | integer | 非必须 |  | 优惠总金额 |
| ├─ total_fee | integer | 非必须 |  | 结算总金额 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额 |
| ├─ list | object [] | 非必须 |  | 购物车商品列表 |
item 类型: object
| ├─ cart_id | integer | 非必须 |  | 购物车ID |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ user_id | integer | 非必须 |  | 用户ID |
| ├─ user_ident | string | 非必须 |  | 会员ident |
| ├─ shop_type | string | 非必须 |  | 店铺类型 |
| ├─ shop_id | integer | 非必须 |  | 店铺id |
| ├─ activity_type | string | 非必须 |  | 活动类型 |
| ├─ activity_id | integer | 非必须 |  | 活动id |
| ├─ marketing_type | string | 非必须 |  | 促销类型 |
| ├─ marketing_id | integer | 非必须 |  | 促销id |
| ├─ item_type | string | 非必须 |  | 商品类型 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ items_id |  [] | 非必须 |  | 组合商品关联商品id |
| ├─  |  | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ pics | string | 非必须 |  | 图片 |
| ├─ price | integer | 非必须 |  | 购买商品价格 |
| ├─ num | integer | 非必须 |  | 购买商品数量 |
| ├─ wxa_appid | string | 非必须 |  | 小程序appid |
| ├─ is_checked | boolean | 非必须 |  | 购物车是否选中 |
| ├─ is_plus_buy | boolean | 非必须 |  | 是加价购商品 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ is_last_price | boolean | 非必须 |  | 是否为最后固定的价格 |
| ├─ discount_fee | integer | 非必须 |  | 优惠金额 |
| ├─ total_fee | integer | 非必须 |  | 结算金额 |
| ├─ store | integer | 非必须 |  | 商品库存 |
| ├─ market_price | integer | 非必须 |  | 销售价 |
| ├─ brief | string | 非必须 |  | 商品简介 |
| ├─ approve_status | string | 非必须 |  | 商品状态 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格 |
| ├─ parent_id | integer | 非必须 |  | 组合商品购物车ID |
| ├─ goods_id | integer | 非必须 |  | 产品ID |
| ├─ item_category | integer | 非必须 |  | 商品主类目 |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ taxstrategy_id | integer | 非必须 |  | 税费策略id |
| ├─ taxation_num | integer | 非必须 |  | 计税单位份数 |
| ├─ origincountry_id | integer | 非必须 |  | 产地国id |
| ├─ origincountry_name | string | 非必须 |  | 产地国称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国图标 |
| ├─ discount_desc | string | 非必须 |  | 优惠描述 |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ member_discount | integer | 非必须 |  | 会员折扣金额 |
| ├─ activity_info | object [] | 非必须 |  | 参会的活动信息 |
item 类型: object
| ├─ id | integer | 非必须 |  | 活动ID |
| ├─ type | string | 非必须 |  | 活动类型 |
| ├─ info | integer | 非必须 |  | 活动描述 |
| ├─ rule | integer | 非必须 |  | 活动规则 |
| ├─ discount_fee | integer | 非必须 |  | 折扣金额 |
| ├─ used_activity |  [] | 非必须 |  | 参与的活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ used_activity_ids |  [] | 非必须 |  | 参与的活动ID列表 |
| ├─  |  | 非必须 |  |  |
| ├─ gift_activity |  [] | 非必须 |  | 参与的满赠活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ plus_buy_activity |  [] | 非必须 |  | 参与加价购活动列表 |
| ├─  |  | 非必须 |  |  |
| ├─ invalid_cart |  [] | 非必须 |  | 失效购物车列表 |
| ├─  |  | 非必须 |  |  |
| ├─ is_check_store | boolean | 非必须 |  | 是否检查过库存 |
营销
获取商品的组合商品列表
基本信息
Path： /api/h5app/wxapp/promotions/package
Method： GET
接口描述：
获取商品的组合商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| item_id
| 是
|
| 商品id
| page
| 是
|
| 分页页数,默认1
| pageSize
| 是
|
| 分页条数,默认20
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ package_id | string | 非必须 |  | 组合促销规则id |
| ├─ main_item_id | string | 非必须 |  | 主商品id |
| ├─ main_item_price | string | 非必须 |  | 主商品价格（分） |
| ├─ package_name | string | 非必须 |  | 组合促销名称 |
| ├─ valid_grade | string | 非必须 |  | 会员级别集合 |
| ├─ used_platform | string | 非必须 |  | 适用平台: 0:全场可用,1:只用于pc端,2:小程序端,3:h5端 暂时只支持0 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 | 0 包邮|1 商品 |
| ├─ package_total_price | string | 非必须 |  | 组合促销各商品总价（分） |
| ├─ start_time | string | 非必须 |  | 开始时间 |
| ├─ end_time | string | 非必须 |  | 结束时间 |
| ├─ package_status | string | 非必须 |  | NO_REVIEWED 未审核|PENDING 待审核|AGREE 审核通过|REFUSE 审核拒绝|CANCEL 已取消 |
| ├─ reason | string | 非必须 |  | 审核不通过原因 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ goods_id | string | 非必须 |  | 商品id |
| ├─ status | string | 非必须 |  | 活动状态 waiting:未开始，ongoing:进行中，end:已结束 |
会员领取付费会员卡
基本信息
Path： /api/h5app/wxapp/promotion/getMemberCard
Method： GET
接口描述：
会员领取付费会员卡
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 否
|
| 登录token(h5端必填)
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单编号 |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员等级id |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ mobile | string | 非必须 |  | 会员手机号 |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ price | integer | 非必须 |  | 价格 |
| ├─ card_type | object | 非必须 |  | 类型 |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ price | string | 非必须 |  | 价格(元) |
| ├─ day | string | 非必须 |  | 天数 |
| ├─ desc | string | 非必须 |  | 天数描述 |
| ├─ discount | integer | 非必须 |  | 折扣 8折 |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ source_id | string | 非必须 |  | 订单来源id |
| ├─ source_type | string | 非必须 |  | 订单来源类型 |
| ├─ monitor_id | string | 非必须 |  | 订单监控页面id |
| ├─ order_status | string | 非必须 |  |  |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ fee_type | string | 非必须 |  | 货币类型 |
| ├─ fee_rate | integer | 非必须 |  | 货币费率 |
| ├─ fee_symbol | string | 非必须 |  | 货币符号 |
参与砍价日志
基本信息
Path： /api/h5app/wxapp/promotion/bargainlog
Method： POST
接口描述：
参与砍价日志
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| bargain_id
| 是
|
| 砍价活动id
| user_id
| 是
|
| 参与砍价人id
| open_id
| 是
|
| 助力人员open_id
| nickname
| 是
|
| 助力人员昵称
| headimgurl
| 是
|
| 助力人员头像url
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ company_id | string | 非必须 |  |  |
| ├─ bargain_id | string | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  |  |
| ├─ nickname | string | 非必须 |  |  |
| ├─ headimgurl | string | 非必须 |  |  |
参与砍价活动
基本信息
Path： /api/h5app/wxapp/promotion/userbargain
Method： POST
接口描述：
参与砍价活动
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| bargain_id
| 是
|
| 砍价活动id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ bargain_id | string | 非必须 |  | 砍价活动ID |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ mkt_price | string | 非必须 |  | 市场价格,单位为‘分’ |
| ├─ price | string | 非必须 |  | 销售金额,单位为‘分’ |
| ├─ cutprice_num | string | 非必须 |  | 砍价次数 |
| ├─ cutprice_range | object [] | 非必须 |  |  |
item 类型: object
| ├─ cut | string | 非必须 |  |  |
| ├─ used | string | 非必须 |  |  |
| ├─ cutdown_amount | string | 非必须 |  | 已砍金额,单位为‘分’ |
| ├─ is_ordered | string | 非必须 |  | 是否已下单 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
参与转盘抽奖
基本信息
Path： /api/h5app/wxapp/promotion/turntable
Method： GET
接口描述：
参与转盘抽奖
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ prize_type | string | 非必须 |  | 奖品类型，points:积分，coupon：优惠券，coupons：优惠券包，thanks：未中奖 |
| ├─ prize_name | string | 非必须 |  | 奖项名称 |
| ├─ prize_describe | string | 非必须 |  | 奖品描述 |
| ├─ prize_probability | string | 非必须 |  | 中奖概率 （1-100）*100 |
| ├─ prize_image | string | 非必须 |  | 奖品图片 |
| ├─ prize_url | string | 非必须 |  | 奖项跳转的url |
| ├─ prize_bgcolor | string | 非必须 |  | 奖品背景色 |
| ├─ prize_value | string | 非必须 |  | 奖品值 |
| ├─ goods_options | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 商品数据 |
| ├─ dataForm | object | 非必须 |  |  |
| ├─ background_img | string | 非必须 |  | 背景图 |
| ├─ shadow_color | string | 非必须 |  | 背景色 |
| ├─ line_color | string | 非必须 |  | 分割线颜色 |
| ├─ border_color | string | 非必须 |  | 边框颜色 |
| ├─ pointer_img | string | 非必须 |  |  |
| ├─ describe | string | 非必须 |  | 活动规则描述 |
| ├─ id | string | 非必须 |  | 自行更改字段描述 |
取消会员秒杀资格
基本信息
Path： /api/h5app/wxapp/promotion/seckillactivity/cancelTicket
Method： DELETE
接口描述：
取消会员秒杀资格
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| seckill_ticket
| 否
|
| 会员秒杀ticket
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ ticket | string | 非必须 |  |  |
填写抽奖订单收货地址(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/member/luckyaddress
Method： POST
接口描述：
填写抽奖订单收货地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| luckydraw_trade_id
| 否
|
| 订单id
| address_id
| 否
|
| 地址id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
抽奖下单(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraworder
Method： POST
接口描述：
抽奖下单
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| luckydraw_id
| 是
|
| 抽奖活动id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ company_id | string | 非必须 |  |  |
抽奖规则(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckyrules
Method： GET
接口描述：
抽奖规则
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
抽奖订单物流查询(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/member/luckyorderlogistic
Method： GET
接口描述：
抽奖订单物流查询
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
抽奖轮播图展示(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw_show
Method： GET
接口描述：
抽奖轮播图展示
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
检查会员是否中奖(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/checkwinning/{luckydraw_id}
Method： GET
接口描述：
检查会员是否中奖
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| luckydraw_id
|
| 页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
登陆赠送抽奖次数
基本信息
Path： /api/h5app/wxapp/promotion/loginaddtimes
Method： GET
接口描述：
登陆赠送抽奖次数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ result | integer | 非必须 |  | 赠送的次数 |
确认收货抽奖订单(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/member/luckyorderfinish
Method： POST
接口描述：
确认收货抽奖订单
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| luckydraw_trade_id
| 否
|
| 订单id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取会员签到记录列表
基本信息
Path： /api/h5app/wxapp/promotion/checkin/getlist
Method： GET
接口描述：
获取会员签到记录列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| start_date
| 否
|
| 开始时间
| end_date
| 否
|
| 结束时间
| check_type
| 否
|
| 查询类型：month=按月查，week=按周查，day=按天查
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object | 非必须 |  |  |
获取促销商品列表
基本信息
Path： /api/h5app/wxapp/promotion/fullpromotion/getitemlist
Method： GET
接口描述：
获取促销商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| marketing_id
| 否
|
| 活动id
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ activity | object | 非必须 |  |  |
| ├─ marketing_id | string | 非必须 |  | 促销id |
| ├─ marketing_type | string | 非必须 |  | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠 |
| ├─ rel_marketing_id | string | 非必须 |  | 关联其他营销id |
| ├─ marketing_name | string | 非必须 |  | 营销活动名称 |
| ├─ marketing_desc | string | 非必须 |  | 营销活动描述 |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ release_time | string | 非必须 |  | 活动发布时间 |
| ├─ used_platform | string | 非必须 |  | 适用平台: 0:全场可用,1:只用于pc端,2:小程序端,3:h5端 |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ use_shop | string | 非必须 |  | 适用店铺: 0:全场可用,1:指定店铺可用 |
| ├─ shop_ids | string | 非必须 |  | 店铺id集合 |
| ├─ valid_grade | string | 非必须 |  | 会员级别集合,id数组 |
| ├─ condition_type | string | 非必须 |  | 营销条件标准 quantity:按总件数, totalfee:按总金额 |
| ├─ condition_value | string | 非必须 |  | 营销规则值 |
| ├─ canjoin_repeat | string | 非必须 |  | 是否上不封顶 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ check_status | string | 非必须 |  | 促销状态: non-reviewed:未审核,pending:待审核,agree:审核通过,refuse:已拒绝,cancel:已取消,overdue:已过期 |
| ├─ reason | string | 非必须 |  | 拒绝原因 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_increase_purchase | string | 非必须 |  | 开启加价购，满赠时启用 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  | 活动广告图 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ in_proportion | string | 非必须 |  | 是否按比例多次赠送 |
| ├─ left_time | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_cat_id | string | 非必须 |  | 分类id数组 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ rebate | integer | 非必须 |  | 推广商品 1已选择 0未选择 2申请加入 3拒绝 |
| ├─ rebate_conf | string | 非必须 |  | 分销配置 json |
| ├─ is_point | boolean | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ distributor_id | boolean | 非必须 |  | 店铺id |
| ├─ item_category | boolean | 非必须 |  | 商品主类目id |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 |
| ├─ tax_rate | integer | 非必须 |  | 税率, 百分之～/100 |
| ├─ is_gift | boolean | 非必须 |  | 是否为赠品 |
| ├─ is_package | boolean | 非必须 |  | 是否为打包产品 |
| ├─ is_package_items | boolean | 非必须 |  | 是否组合商品 |
| ├─ is_profit | boolean | 非必须 |  | 是否支持分润 |
| ├─ profit_type | integer | 非必须 |  | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) |
| ├─ profit_fee | integer | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ int | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | integer | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ price | integer | 非必须 |  | 销售价（分） |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ member_price | integer | 非必须 |  | 会员价（分） |
| ├─ point | integer | 非必须 |  | 获取积分个数 |
| ├─ item_source | integer | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ consumeType | integer | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 json |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ currency | string | 非必须 |  | 币种 |
| ├─ title | string | 非必须 |  | 币种名称 |
| ├─ symbol | integer | 非必须 |  | 币种符号 |
| ├─ rate | string | 非必须 |  | 币种税率 |
| ├─ is_default | boolean | 非必须 |  | 是否默认 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
| ├─ total_count | string | 非必须 |  | 总条数 |
获取到秒杀商品的资格
基本信息
Path： /api/h5app/wxapp/promotion/seckillactivity/geticket
Method： GET
接口描述：
获取到秒杀商品的资格
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| seckill_id
| 否
|
| 活动id
| item_id
| 否
|
| 商品id
| num
| 否
|
| 购买数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ ticket | string | 非必须 |  |  |
获取加价购商品列表
基本信息
Path： /api/h5app/wxapp/promotion/pluspricebuy/getItemList
Method： GET
接口描述：
获取促销商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| marketing_id
| 否
|
| 活动id
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ promotion_activity | object | 非必须 |  |  |
| ├─ marketing_id | string | 非必须 |  | 关联营销id |
| ├─ marketing_type | string | 非必须 |  | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 |
| ├─ rel_marketing_id | string | 非必须 |  | 关联其他营销id |
| ├─ marketing_name | string | 非必须 |  | 营销活动名称 |
| ├─ marketing_desc | string | 非必须 |  | 营销活动描述 |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ release_time | string | 非必须 |  | 活动发布时间 |
| ├─ used_platform | string | 非必须 |  | 适用平台: 0:全场可用,1:只用于pc端,2:小程序端,3:h5端 |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ use_shop | string | 非必须 |  | 适用店铺: 0:全场可用,1:指定店铺可用 |
| ├─ shop_ids | string | 非必须 |  | 员工管理的门店id集合 | 店铺id集合 |
| ├─ valid_grade | string | 非必须 |  | 会员级别集合,id数组 |
| ├─ condition_type | string | 非必须 |  | 营销条件标准 quantity:按总件数, totalfee:按总金额 |
| ├─ condition_value | string | 非必须 |  | 营销规则值 |
| ├─ canjoin_repeat | string | 非必须 |  | 是否上不封顶 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ check_status | string | 非必须 |  | 促销状态: non-reviewed:未审核,pending:待审核,agree:审核通过,refuse:已拒绝,cancel:已取消,overdue:已过期 |
| ├─ reason | string | 非必须 |  | 拒绝原因 |
| ├─ activity_background | string | 非必须 |  | 加价购活动页面背景 |
| ├─ navbar_color | string | 非必须 |  | 加价购活动页面导航栏颜色 |
| ├─ timeBackgroundColor | string | 非必须 |  | 加价购活动页面时间背景颜色 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_increase_purchase | string | 非必须 |  | 开启加价购，满赠时启用 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  | 活动广告图 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ in_proportion | string | 非必须 |  | 是否按比例多次赠送 |
| ├─ left_time | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_cat_id | string | 非必须 |  | 分类id数组 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ rebate | integer | 非必须 |  | 推广商品 1已选择 0未选择 2申请加入 3拒绝 |
| ├─ rebate_conf | string | 非必须 |  | 分销配置 json |
| ├─ is_point | boolean | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ distributor_id | boolean | 非必须 |  | 店铺id |
| ├─ item_category | boolean | 非必须 |  | 商品主类目id |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 |
| ├─ tax_rate | integer | 非必须 |  | 税率, 百分之～/100 |
| ├─ is_gift | boolean | 非必须 |  | 是否为赠品 |
| ├─ is_package | boolean | 非必须 |  | 是否为打包产品 |
| ├─ is_package_items | boolean | 非必须 |  | 是否组合商品 |
| ├─ is_profit | boolean | 非必须 |  | 是否支持分润 |
| ├─ profit_type | integer | 非必须 |  | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) |
| ├─ profit_fee | integer | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ int | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | integer | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ price | integer | 非必须 |  | 销售价（分） |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ member_price | integer | 非必须 |  | 会员价（分） |
| ├─ point | integer | 非必须 |  | 获取积分个数 |
| ├─ item_source | integer | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ consumeType | integer | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 json |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ currency | string | 非必须 |  | 币种 |
| ├─ title | string | 非必须 |  | 币种名称 |
| ├─ symbol | integer | 非必须 |  | 币种符号 |
| ├─ rate | string | 非必须 |  | 币种税率 |
| ├─ is_default | boolean | 非必须 |  | 是否默认 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
| ├─ total_count | string | 非必须 |  | 总条数 |
获取参与抽奖订单列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/member/luckydraworder
Method： GET
接口描述：
获取参与抽奖订单列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取商品促销活动列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/fullpromotion/getlist
Method： GET
接口描述：
获取商品促销活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| status
| 否
|
| 活动状态
| item_type
| 否
|
| 商品类型 normal or services
| marketing_type
| 否
|
| 商品类型 normal or services
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ marketing_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ marketing_name | integer | 非必须 |  |  |
| ├─ marketing_desc | integer | 非必须 |  |  |
| ├─ start_time | string | 非必须 |  |  |
| ├─ end_time | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ marketing_id | integer | 非必须 |  |  |
| ├─ item_id | integer | 非必须 |  |  |
| ├─ item_title | string | 非必须 |  |  |
| ├─ price | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ pics | integer | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
| ├─ item_rel_id | integer | 非必须 |  |  |
| ├─ marketing_type | integer | 非必须 |  |  |
| ├─ item_type | integer | 非必须 |  |  |
| ├─ item_brief | integer | 非必须 |  |  |
| ├─ promotion_tag | integer | 非必须 |  |  |
| ├─ start_time | integer | 非必须 |  |  |
| ├─ end_time | integer | 非必须 |  |  |
| ├─ used_platform | string | 非必须 |  |  |
| ├─ use_bound | string | 非必须 |  |  |
| ├─ use_shop | string | 非必须 |  |  |
| ├─ shop_ids | string | 非必须 |  |  |
| ├─ valid_grade | string | 非必须 |  |  |
| ├─ condition_type | string | 非必须 |  |  |
| ├─ marketing_type | string | 非必须 |  |  |
| ├─ condition_value | string | 非必须 |  |  |
| ├─ promotion_tag | string | 非必须 |  |  |
| ├─ free_postage | string | 非必须 |  |  |
| ├─ join_limit | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取商品历史中奖者列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydrawmember
Method： GET
接口描述：
获取商品历史中奖者列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
保存小程序formid
基本信息
Path： /api/h5app/wxapp/promotion/formid
Method： POST
接口描述：
保存小程序formid，如果多个formid使用 , 符合连接
请求参数
Query
参数名称
是否必须
示例
备注
| formid
| 是
|
| formid
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  |  |
获取大转盘配置
基本信息
Path： /api/h5app/wxapp/promotion/turntableconfig
Method： GET
接口描述：
获取大转盘配置详情信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ clear_times_after_end | string | 非必须 |  | 结束时是否清空抽奖次数 |
| ├─ max_times_day | integer | 非必须 |  | 每日可抽奖次数，-1为不限制 |
| ├─ login_get_times | integer | 非必须 |  | 登陆时获取的次数，-1为不设置 |
| ├─ start_time | string | 非必须 |  | 有效开始时间 |
| ├─ end_time | string | 非必须 |  | 有效结束时间 |
| ├─ long_term | string | 非必须 |  | 是否长期有效，1长期有效，0周期有效 |
| ├─ background_img | string | 非必须 |  | 背景图 |
| ├─ turntable_title | string | 非必须 |  | 转盘标题 |
| ├─ line_color | string | 非必须 |  | 分割线颜色 |
| ├─ shopping_full | string | 非必须 |  | 会员购满多少元赠送一次抽奖次数，-1为不设置 |
| ├─ prizes | object [] | 非必须 |  |  |
item 类型: object
| ├─ prize_type | string | 非必须 |  | 奖品类型，points:积分，coupon：优惠券，coupons：优惠券包 |
| ├─ prize_name | string | 非必须 |  | 奖品名称 |
| ├─ prize_describe | string | 非必须 |  | 奖品描述 |
| ├─ prize_probability | string | 非必须 |  | 中奖概率 （1-100）*100 |
| ├─ prize_image | string | 非必须 |  | 中奖图片 |
| ├─ prize_url | string | 非必须 |  | 奖项跳转的url |
| ├─ prize_bgcolor | string | 非必须 |  | 奖项背景色 |
| ├─ prize_value | string | 非必须 |  | 奖品值 |
| ├─ goods_options | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 商品数据 |
| ├─ dataForm | object | 非必须 |  |  |
| ├─ background_img | string | 非必须 |  | 背景图片 |
| ├─ shadow_color | string | 非必须 |  | 阴影颜色 |
| ├─ line_color | string | 非必须 |  | 分割线颜色 |
| ├─ border_color | string | 非必须 |  | 边框颜色 |
| ├─ pointer_img | string | 非必须 |  |  |
| ├─ describe | string | 非必须 |  | 活动规则描述 |
| ├─ shadow_color | string | 非必须 |  | 阴影颜色 |
| ├─ turntable_open | string | 非必须 |  | 是否开启大转盘 |
| ├─ border_color | string | 非必须 |  | 边框颜色 |
| ├─ today_times | string | 非必须 |  | 用户今日已抽奖次数 |
| ├─ surplus_times | string | 非必须 |  | 用户剩余抽奖次数 |
获取抽奖活动列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw
Method： GET
接口描述：
获取抽奖活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| keywords
| 否
|
| 活动名称
| view
| 否
|
| 1未开始 2进行中 3已结束
| page
| 否
|
| 页数
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取抽奖活动详情(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/{luckydraw_id}
Method： GET
接口描述：
获取抽奖活动详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
路径参数
参数名称
示例
备注
| luckydraw_id
|
| 抽奖活动id
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ activity_release_time | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ item_title | string | 非必须 |  |  |
| ├─ item_id | integer | 非必须 |  |  |
| ├─ activity_price | integer | 非必须 |  |  |
| ├─ activity_store | integer | 非必须 |  |  |
| ├─ limit | integer | 非必须 |  |  |
| ├─ is_activity_rebate | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  |  |
| ├─ is_free_shipping | string | 非必须 |  |  |
| ├─ validity_period | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取抽奖订单详情(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/member/luckydraworder/{luckydraw_trade_id}
Method： GET
接口描述：
获取抽奖订单详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| luckydraw_trade_id
|
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取拼团活动列表
基本信息
Path： /api/h5app/wxapp/promotions/groups
Method： GET
接口描述：
获取拼团活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
Query
参数名称
是否必须
示例
备注
| keywords
| 否
|
| 活动名称
| view
| 否
|
| 1未开始 2进行中 3已结束
| group_goods_type
| 否
|
| 商品类型 normal:普通商品 services:服务类
| page
| 否
|
| 页数,默认1
| pageSize
| 否
|
| 每页数量,默认20
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ groups_activity_id | string | 非必须 |  | 活动ID |
| ├─ act_name | string | 非必须 |  | 活动名称 |
| ├─ goods_id | string | 非必须 |  | 商品id |
| ├─ group_goods_type | string | 非必须 |  | 团购活动商品类型 |
| ├─ pics | string | 非必须 |  | 商品图片 |
| ├─ act_price | string | 非必须 |  | 活动价格 |
| ├─ person_num | string | 非必须 |  | 拼团人数 |
| ├─ begin_time | string | 非必须 |  | 开始时间 |
| ├─ end_time | string | 非必须 |  | 结束时间 |
| ├─ limit_buy_num | string | 非必须 |  | 限买数量 |
| ├─ limit_time | string | 非必须 |  | 成团时效(单位时) |
| ├─ store | string | 非必须 |  | 拼团库存 |
| ├─ free_post | string | 非必须 |  | 是否包邮 |
| ├─ rig_up | string | 非必须 |  | 是否展示开团列表 |
| ├─ robot | string | 非必须 |  | 成团机器人 |
| ├─ share_desc | string | 非必须 |  | 分享描述 |
| ├─ disabled | string | 非必须 |  | 是否禁用。0:可用；1:禁用 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |  | 修改时间 |
| ├─ remaining_time | string | 非必须 |  | 剩余时间 |
| ├─ last_seconds | string | 非必须 |  | 剩余秒数 |
| ├─ show_status | string | 非必须 |  | 展示状态 nostart:未开始 noend:未结束 |
| ├─ goods_name | string | 非必须 |  | 商品名称 |
| ├─ activity_status | string | 非必须 |  | 活动状态 1:未开始 2:进行中 3:已结束 |
获取指定商品的活动信息
基本信息
Path： /api/h5app/wxapp/promotion/getskumarketing
Method： GET
接口描述：
获取指定商品的活动信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| item_id
| 否
|
| 活动id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ promotion_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ marketing_id | string | 非必须 |  | 营销id |
| ├─ marketing_type | string | 非必须 |  | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 |
| ├─ rel_marketing_id | string | 非必须 |  | 关联其他营销id |
| ├─ marketing_name | string | 非必须 |  | 营销活动名称 |
| ├─ marketing_desc | string | 非必须 |  | 营销活动描述 |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ release_time | string | 非必须 |  | 活动发布时间 |
| ├─ used_platform | string | 非必须 |  | 适用平台:  0:全场可用,1:只用于pc端,2:小程序端,3:h5端 |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ use_shop | string | 非必须 |  | 适用店铺: 0:全场可用,1:指定店铺可用 |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 店铺id |
| ├─ valid_grade | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 等级id |
| ├─ condition_type | string | 非必须 |  | 营销条件标准 quantity:按总件数, totalfee:按总金额 |
| ├─ condition_value | object [] | 非必须 |  |  |
item 类型: object
| ├─ full | string | 非必须 |  |  |
| ├─ minus | string | 非必须 |  |  |
| ├─ canjoin_repeat | string | 非必须 |  | 是否上不封顶 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ check_status | string | 非必须 |  | 促销状态: non-reviewed:未审核,pending:待审核,agree:审核通过,refuse:已拒绝,cancel:已取消,overdue:已过期 |
| ├─ reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_increase_purchase | string | 非必须 |  | 开启加价购，满赠时启用 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  | 活动广告图 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ in_proportion | string | 非必须 |  | 是否按比例多次赠送 |
| ├─ member_grade | object | 非必须 |  |  |
| ├─ 4 | string | 非必须 |  | 会员等级名称 |
| ├─ items | object | 非必须 |  |  |
| ├─ 5357 | object | 非必须 |  |  |
| ├─ marketing_id | string | 非必须 |  | 营销id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ is_show | string | 非必须 |  | 列表页是否显示 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ marketing_type | string | 非必须 |  | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ price | string | 非必须 |  | 销售金额,单位为‘分’ |
| ├─ item_brief | string | 非必须 |  | 商品简介 |
| ├─ pics | string | 非必须 |  | 活动封面json |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ status | string | 非必须 |  | 是否生效中 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ goods_id | string | 非必须 |  | 关联商品id |
| ├─ condition_rules | string | 非必须 |  | 活动规则描述 |
| ├─ start_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ status | string | 非必须 |  | 状态 ongoing:进行中 |
| ├─ last_seconds | string | 非必须 |  | 剩余秒数 |
获取某个抽奖活动的中奖者详情(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/winning/{luckydraw_id}
Method： GET
接口描述：
获取某个抽奖活动的中奖者详情
请求参数
路径参数
参数名称
示例
备注
| luckydraw_id
|
| 页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取某个抽奖活动的开奖逻辑信息(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/luckylogic/{luckydraw_id}
Method： GET
接口描述：
获取某个抽奖活动的开奖逻辑信息
请求参数
路径参数
参数名称
示例
备注
| luckydraw_id
|
| 页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取某个抽奖活动的所有参与列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/alljoinlist/{luckydraw_id}
Method： GET
接口描述：
获取某个抽奖活动的所有参与列表
请求参数
路径参数
参数名称
示例
备注
| luckydraw_id
|
| 页数
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取注册引导营销配置
基本信息
Path： /api/h5app/wxapp/promotion/register
Method： GET
接口描述：
获取注册引导营销配置,开启中
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 否
|
| 小程序appid(小程序端必填)
| company_id
|
| 否
|
| 公司company_id(h5端必填)
Query
参数名称
是否必须
示例
备注
| register_type
| 否
|
| 注册营销类型 促销类型。可选值有 general-普通;membercard-付费会员卡;all-全部
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | Id |
| ├─ company_id | string | 非必须 |  | 企业Id |
| ├─ is_open | string | 非必须 |  | 是否开启 |
| ├─ register_type | string | 非必须 |  | 注册营销类型 促销类型。可选值有 general-普通;membercard-付费会员卡; |
| ├─ ad_title | string | 非必须 |  | 注册引导广告标题 |
| ├─ ad_pic | string | 非必须 |  | 注册引导图片 |
| ├─ promotions_value | object | 非必须 |  |  |
| ├─ items | string | 非必须 |  | 商品id数组 |
| ├─ itemsList | object [] | 非必须 |  | 服务商品列表 |
item 类型: object
| ├─ key | string | 非必须 |  | 商品id |
| ├─ label | string | 非必须 |  | 商品名称 |
| ├─ coupons | object [] | 非必须 |  | 赠送优惠券 |
item 类型: object
| ├─ card_id | string | 非必须 |  | 优惠券id |
| ├─ count | string | 非必须 |  | 赠送数量 |
| ├─ title | string | 非必须 |  | 优惠券标题 |
| ├─ staff_coupons | object [] | 非必须 |  | 注册送优惠券列表 |
item 类型: object
| ├─ card_id | string | 非必须 |  | 优惠券id |
| ├─ count | string | 非必须 |  | 赠送数量 |
| ├─ title | string | 非必须 |  | 优惠券标题 |
获取猜你喜欢商品列表
基本信息
Path： /api/h5app/wxapp/promotions/recommendlike
Method： GET
接口描述：
获取猜你喜欢商品列表
请求参数
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数,默认：1
| pageSize
| 否
|
| 每页条数,默认：40
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_cat_id | string | 非必须 |  | 分类id数组 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ rebate | integer | 非必须 |  | 推广商品 1已选择 0未选择 2申请加入 3拒绝 |
| ├─ rebate_conf | string | 非必须 |  | 分销配置 json |
| ├─ is_point | boolean | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ distributor_id | boolean | 非必须 |  | 店铺id |
| ├─ item_category | boolean | 非必须 |  | 商品主类目id |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 |
| ├─ tax_rate | integer | 非必须 |  | 税率, 百分之～/100 |
| ├─ is_gift | boolean | 非必须 |  | 是否为赠品 |
| ├─ is_package | boolean | 非必须 |  | 是否为打包产品 |
| ├─ is_package_items | boolean | 非必须 |  | 是否组合商品 |
| ├─ is_profit | boolean | 非必须 |  | 是否支持分润 |
| ├─ profit_type | integer | 非必须 |  | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) |
| ├─ profit_fee | integer | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ int | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | integer | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ price | integer | 非必须 |  | 销售价（分） |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ member_price | integer | 非必须 |  | 会员价（分） |
| ├─ point | integer | 非必须 |  | 获取积分个数 |
| ├─ item_source | integer | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ consumeType | integer | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 json |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
获取用户参加砍价活动详情
基本信息
Path： /api/h5app/wxapp/promotion/userbargain
Method： GET
接口描述：
获取用户参加砍价活动详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| bargain_id
| 是
|
| 砍价活动id
| user_id
| 否
|
| 参与活动用户id
| has_order
| 否
|
| 是否获取订单
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ bargain_info | object | 非必须 |  |  |
| ├─ bargain_id | string | 非必须 |  | 砍价活动ID |
| ├─ title | string | 非必须 |  | 活动名称 |
| ├─ ad_pic | string | 非必须 |  | 活动广告图 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_pics | string | 非必须 |  | 商品图片 |
| ├─ item_intro | string | 非必须 |  | 商品详情 |
| ├─ mkt_price | string | 非必须 |  | 市场价格,单位为‘分’ |
| ├─ price | string | 非必须 |  | 销售金额,单位为‘分’ |
| ├─ limit_num | string | 非必须 |  | 商品限购数量 |
| ├─ order_num | string | 非必须 |  | 已购买数量 |
| ├─ bargain_rules | string | 非必须 |  | 规则描述 |
| ├─ bargain_range | object | 非必须 |  |  |
| ├─ min | string | 非必须 |  |  |
| ├─ max | string | 非必须 |  |  |
| ├─ people_range | object | 非必须 |  |  |
| ├─ min | string | 非必须 |  | 最小砍价人数 |
| ├─ max | string | 非必须 |  | 最大砍价人数 |
| ├─ min_price | string | 非必须 |  | 每个人最少能看的价钱,单位为‘分’ |
| ├─ begin_time | string | 非必须 |  | 开始时间 |
| ├─ end_time | string | 非必须 |  | 结束时间 |
| ├─ share_msg | string | 非必须 |  | 分享内容 |
| ├─ help_pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 翻牌图片 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ is_expired | string | 非必须 |  | 是否过期 |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ left_micro_second | string | 非必须 |  | 剩余描述*1000 |
| ├─ user_bargain_info | object | 非必须 |  |  |
| ├─ bargain_id | string | 非必须 |  | 砍价活动ID |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ mkt_price | string | 非必须 |  | 市场价格,单位为‘分’ |
| ├─ price | string | 非必须 |  | 销售金额,单位为‘分’ |
| ├─ cutprice_num | string | 非必须 |  | 砍价次数 |
| ├─ cutprice_range | object [] | 非必须 |  |  |
item 类型: object
| ├─ cut | string | 非必须 |  |  |
| ├─ used | string | 非必须 |  |  |
| ├─ cutdown_amount | string | 非必须 |  | 已砍金额,单位为‘分’ |
| ├─ is_ordered | string | 非必须 |  | 是否已下单 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  | 修改时间 |
| ├─ user_info | object | 非必须 |  |  |
| ├─ source_from | string | 非必须 |  | 来源类型 default默认 |
| ├─ need_transfer | string | 非必须 |  | 是否禁用。0:不用迁移或迁移完成；1:需要迁移 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ nickname | string | 非必须 |  | 用户昵称 |
| ├─ sex | string | 非必须 |  | 性别。0 未知 1 男 2 女 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ country | string | 非必须 |  | 国家名称 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ language | string | 非必须 |  | 语言 |
| ├─ headimgurl | string | 非必须 |  | 用户头像url |
| ├─ bargain_log | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
获取用户自己参与的所有抽奖活动(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydraw/joinactivitys
Method： GET
接口描述：
获取用户自己参与的所有抽奖活动
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页数
| page
| 否
|
| 页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取用户自己的某个活动参与订单列表(废弃)
基本信息
Path： /api/h5app/wxapp/promotion/luckydrawjoinlist
Method： GET
接口描述：
获取用户自己的某个活动参与订单列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| luckydraw_id
| 否
|
| 抽奖活动id
| page
| 否
|
| 页数
| page
| 否
|
| 页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
获取砍价分享小程序码
基本信息
Path： /api/h5app/wxapp/promotion/bargainfriendwxappcode
Method： GET
接口描述：
获取砍价分享小程序码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
Query
参数名称
是否必须
示例
备注
| bargain_id
| 是
|
| 砍价活动id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ base64Image | string | 非必须 |  |  |
获取砍价活动列表
基本信息
Path： /api/h5app/wxapp/promotion/bargains
Method： GET
接口描述：
获取活动中的砍价活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,默认1
| pageSize
| 否
|
| 每页数量,默认50
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ bargain_id | string | 非必须 |  | 砍价活动ID |
| ├─ title | string | 非必须 |  | 活动名称 |
| ├─ ad_pic | string | 非必须 |  | 活动广告图 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_pics | string | 非必须 |  | 商品图片 |
| ├─ item_intro | string | 非必须 |  | 商品详情 |
| ├─ mkt_price | string | 非必须 |  | 市场价格,单位为‘分’ |
| ├─ price | string | 非必须 |  | 销售金额,单位为‘分’ |
| ├─ limit_num | string | 非必须 |  | 商品限购数量 |
| ├─ order_num | string | 非必须 |  | 已购买数量 |
| ├─ bargain_rules | string | 非必须 |  | 规则描述 |
| ├─ bargain_range | object | 非必须 |  |  |
| ├─ min | string | 非必须 |  |  |
| ├─ max | string | 非必须 |  |  |
| ├─ people_range | object | 非必须 |  |  |
| ├─ min | string | 非必须 |  | 助力最小人数 |
| ├─ max | string | 非必须 |  | 助力最大人数 |
| ├─ min_price | string | 非必须 |  | 每个人最少能砍的价钱,单位为‘分’ |
| ├─ begin_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ share_msg | string | 非必须 |  | 分享内容 |
| ├─ help_pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 翻拍图片url |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ is_expired | string | 非必须 |  | 是否无效 |
| ├─ item_id | string | 非必须 |  | 商品id |
获取秒杀活动列表
基本信息
Path： /api/h5app/wxapp/promotion/seckillactivity/getlist
Method： GET
接口描述：
获取秒杀活动列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| status
| 否
|
| 活动状态
| item_type
| 否
|
| 商品类型 normal or services
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ activity_release_time | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ item_title | string | 非必须 |  |  |
| ├─ item_id | integer | 非必须 |  |  |
| ├─ activity_price | integer | 非必须 |  |  |
| ├─ activity_store | integer | 非必须 |  |  |
| ├─ limit | integer | 非必须 |  |  |
| ├─ is_activity_rebate | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  |  |
| ├─ is_free_shipping | string | 非必须 |  |  |
| ├─ validity_period | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取秒杀活动详情
基本信息
Path： /api/h5app/wxapp/promotion/seckillactivity/getinfo
Method： GET
接口描述：
获取秒杀活动详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| seckill_id
| 否
|
| 活动名称
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ activity_name | integer | 非必须 |  |  |
| ├─ activity_start_time | integer | 非必须 |  |  |
| ├─ activity_end_time | string | 非必须 |  |  |
| ├─ activity_release_time | string | 非必须 |  |  |
| ├─ items | object [] | 非必须 |  |  |
item 类型: object
| ├─ seckill_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ item_title | string | 非必须 |  |  |
| ├─ item_id | integer | 非必须 |  |  |
| ├─ activity_price | integer | 非必须 |  |  |
| ├─ activity_store | integer | 非必须 |  |  |
| ├─ limit | integer | 非必须 |  |  |
| ├─ is_activity_rebate | string | 非必须 |  |  |
| ├─ ad_pic | string | 非必须 |  |  |
| ├─ is_free_shipping | string | 非必须 |  |  |
| ├─ validity_period | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取组合商品的基础信息
基本信息
Path： /api/h5app/wxapp/promotions/package/{packageId}
Method： GET
接口描述：
获取组合商品的基础信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 否
|
| JWT验证token(h5端必填)
路径参数
参数名称
示例
备注
| packageId
|
| 组合商品id
记录会员签到
基本信息
Path： /api/h5app/wxapp/promotion/checkin/create
Method： POST
接口描述：
记录会员签到
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| check_day
| 否
|
| 签到日期
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  | id |
| ├─ company_id | integer | 非必须 |  | 企业ID |
| ├─ user_id | integer | 非必须 |  | 会员id |
| ├─ create_time | integer | 非必须 |  | 签到时间 |
| ├─ tag | integer | 非必须 |  |  |
卡券
获取付费会员等级卡详情(废弃)
基本信息
Path： /api/h5app/wxapp/vipgrades/info
Method： GET
接口描述：
获取付费会员等级卡详情(废弃)
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| vip_grade_id
| 否
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
使用兑换卡券
基本信息
Path： /api/h5app/wxapp/user/exchangeCard
Method： POST
接口描述：
使用兑换卡券
请求参数
Query
参数名称
是否必须
示例
备注
| user_card_id
| 是
|
| 用户领取兑换卡券id
| distributor_id
| 是
|
| 店铺id
| item_id
| 是
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
用户使用优惠券
基本信息
Path： /api/h5app/wxapp/user/usedCard
Method： GET
接口描述：
用户使用优惠券
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 是
|
| 优惠券的 code 码
| shop_id
| 是
|
| 核销门店ID
| verify_code
| 否
|
| 自助核销验证码
| remark_amount
| 否
|
| 自助核销备注金额
| consume_outer_str
| 否
|
| 核销场景
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 结果状态 |
用户删除已领取的卡券
基本信息
Path： /api/h5app/wxapp/user/removeCard
Method： GET
接口描述：
用户删除已领取的卡券
请求参数
Query
参数名称
是否必须
示例
备注
| id
| 否
|
| 指定id,code码和卡券id二选一必填
| code
| 否
|
| 优惠券code码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 删除状态 |
用户核销卡券
基本信息
Path： /api/h5app/wxapp/user/consumCard
Method： GET
接口描述：
用户核销卡券
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 否
|
| 优惠券code码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 领取状态 |
用户领取卡券
基本信息
Path： /api/h5app/wxapp/user/receiveCard
Method： GET
接口描述：
小程序领取卡券处理
请求参数
Query
参数名称
是否必须
示例
备注
| card_id
| 否
|
| 指定优惠券card_id
| salesperson_id
| 否
|
| 导购id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | object | 非必须 |  |  |
| ├─ total_lastget_num | integer | 非必须 |  | 优惠券剩余库存 |
| ├─ lastget_num | integer | 非必须 |  | 用户剩余可领库存 |
获取POS卡券列表
基本信息
Path： /api/h5app/wxapp/getPOSCardList
Method： GET
接口描述：
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| pmcode
| 是
|
| 卡号
| user_id
| 是
|
| 用户ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  | 优惠券状态 pending: 待领取， exchanged：可用，redeemed：已用， expired：已过期 |
| ├─ ruleCode | string | 非必须 |  | 券规则编号 |
undefined: CR004
| ├─ ruleName | string | 非必须 |  | 券规则名称 |
undefined: 满2000减200
| ├─ expireTime | string | 非必须 |  | 优惠券过期时间 |
| ├─ type | string | 非必须 |  | 券类型  MembershipCoupon：入会礼券， BirthdayCoupon：生日礼券， PointCoupon：积分兑换礼券， UpgradeCoupon：升级礼券， 该字段也可能为空 |
| ├─ point | number | 非必须 |  | 兑换消耗积分 积分兑换券返回此字段 |
| ├─ amount | number | 非必须 |  |  |
| ├─ comment | string | 非必须 |  | 部分指定商品不适用 |
undefined: comment
| ├─ minAmount | number | 非必须 |  | 门槛金额  后台设置了将返回，未设置不返回 |
| ├─ ruleType | string | 非必须 |  | 优惠券规则类型 Discount:折扣券, CashVoucher:金额券 |
| ├─ orderAmount | number | 非必须 |  |  |
| ├─ stock | boolean | 非必须 |  |  |
| ├─ exceedLimit | boolean | 非必须 |  |  |
| ├─ pmcode | string | 非必须 |  | 卡号 |
| ├─ valid | boolean | 非必须 |  | 是否有效可用 |
获取付费会员信息
基本信息
Path： /api/h5app/wxapp/vipgrades/uservip
Method： GET
接口描述：
获取付费会员信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 用户ID |
| ├─ vip_type | string | 非必须 |  | 会员类型 |
| ├─ vip_grade_id | string | 非必须 |  | 会员等级id |
| ├─ end_date | string | 非必须 |  | 会员到期时间 |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ is_had_vip | string | 非必须 |  | 是否购买过会员卡 |
| ├─ is_vip | string | 非必须 |  | 是否有效会员卡 |
| ├─ end_time | string | 非必须 |  | 会员到期时间 |
| ├─ day | string | 非必须 |  |  |
| ├─ valid | string | 非必须 |  | 有效 |
| ├─ is_open | string | 非必须 |  |  |
| ├─ discount | string | 非必须 |  |  |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ guide_title | string | 非必须 |  | 购买引导文本 |
| ├─ background_pic_url | string | 非必须 |  | 商家自定义会员卡背景图 |
获取付费会员等级卡列表
基本信息
Path： /api/h5app/wxapp/vipgrades/newlist
Method： GET
接口描述：
获取付费会员等级卡列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ lv_type | string | 非必须 |  | 等级类型 |
| ├─ default_grade | string | 非必须 |  | 是否默认等级 |
| ├─ is_disabled | string | 非必须 |  | 是否禁用 |
| ├─ background_pic_url | string | 非必须 |  | 会员卡背景图 |
| ├─ description | string | 非必须 |  | 简单介绍 |
| ├─ price_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  | 名称 |
| ├─ price | string | 非必须 |  | 价格 |
| ├─ day | string | 非必须 |  | 生日日期 |
| ├─ desc | string | 非必须 |  | 描述 |
| ├─ privileges | object | 非必须 |  |  |
| ├─ discount | string | 非必须 |  | 折扣值 |
| ├─ discount_desc | string | 非必须 |  | 描述 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ guide_title | string | 非必须 |  | 购买引导文本 |
| ├─ is_default | string | 非必须 |  | 是否是默认 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ currency | string | 非必须 |  | 货币类型 |
| ├─ title | string | 非必须 |  | 货币描述 |
| ├─ symbol | string | 非必须 |  | 货币符号 |
| ├─ rate | string | 非必须 |  | 货币汇率(与人民币) |
| ├─ is_default | string | 非必须 |  | 是否默认货币 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
获取付费会员等级卡列表
基本信息
Path： /api/h5app/wxapp/vipgrades/list
Method： GET
接口描述：
获取付费会员等级卡列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ vip_grade_id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ default_grade | string | 非必须 |  | 是否默认等级 |
| ├─ is_disabled | string | 非必须 |  | 是否禁用 |
| ├─ background_pic_url | string | 非必须 |  | 商家自定义会员卡背景图 |
| ├─ description | string | 非必须 |  | 详细说明 |
| ├─ price_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  | 名称 |
| ├─ price | string | 非必须 |  | 价格 |
| ├─ day | string | 非必须 |  | 有效期 |
| ├─ desc | string | 非必须 |  | 描述 |
| ├─ privileges | object | 非必须 |  |  |
| ├─ discount | string | 非必须 |  |  |
| ├─ discount_desc | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ guide_title | string | 非必须 |  | 购买引导文本 |
| ├─ is_default | string | 非必须 |  | 是否默认 |
我的优惠券列表
基本信息
Path： /api/h5app/wxapp/user/getUserCardList
Method： GET
接口描述：
我的优惠券列表
请求参数
Query
参数名称
是否必须
示例
备注
| status
| 否
|
| 状态 1:未使用 2:已使用 3:已过期
| page
| 否
|
| page
| pageSize
| 否
|
| limit
返回数据
名称类型是否必须默认值备注其他信息
|   |  | 非必须 |  |  |
获取兑换卡券使用信息
基本信息
Path： /api/h5app/wxapp/user/exchangeCardInfo
Method： GET
接口描述：
获取兑换卡券使用信息
请求参数
Query
参数名称
是否必须
示例
备注
| user_card_id
| 是
|
| 用户领取兑换卡券id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ distributor_info | object | 非必须 |  | 兑换店铺信息 |
| ├─ barcode_url | string | 非必须 |  | base64条形码 |
| ├─ qrcode_url | string | 非必须 |  | base64二维码图片 |
获取卡券列表
基本信息
Path： /api/h5app/wxapp/getCardList
Method： GET
接口描述：
获取卡券列表信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| card_type
| 否
|
| 卡券类型 discount:折扣券;cash:代金券;new_gift:兑换券
| end_date
| 否
|
| 结束时间
| page_no
| 否
|
| 当前页数
| page_size
| 否
|
| 返回列表的数量，可选，默认 20, 取值在 1 到 20 之间
| distributor_id
| 否
|
| 店铺ID
| card_id
| 否
|
| 卡券id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总条数 |
| ├─ pagers | object | 非必须 |  |  |
| ├─ total | integer | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，可选值有，discount:折扣券;cash:代金券;gift:兑换券 |
| ├─ brand_name | string | 非必须 |  | 商户名称 |
| ├─ logo_url | string | 非必须 |  | 卡券商户 logo |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ notice | string | 非必须 |  | 卡券使用提醒 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ date_type | string | 非必须 |  | 有效期的类型 |
| ├─ begin_date | integer | 非必须 |  | 有效期开始时间 |
| ├─ end_date | integer | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ service_phone | string | 非必须 |  | 客服电话 |
| ├─ center_title | string | 非必须 |  | 卡券顶部居中的按钮，仅在卡券状态正常(可以核销)时显示 |
| ├─ center_sub_title | string | 非必须 |  | 显示在入口下方的提示语 |
| ├─ center_url | string | 非必须 |  | 顶部居中的url |
| ├─ custom_url_name | string | 非必须 |  | 自定义跳转外链的入口名字 |
| ├─ custom_url | string | 非必须 |  | 自定义跳转的URL |
| ├─ custom_url_sub_title | string | 非必须 |  | 显示在入口右侧的提示语 |
| ├─ promotion_url_name | string | 非必须 |  | 营销场景的自定义入口名称 |
| ├─ promotion_url | string | 非必须 |  | 营销场景的自定义入口url |
| ├─ promotion_url_sub_title | string | 非必须 |  | 营销入口右侧的提示语 |
| ├─ get_limit | string | 非必须 |  | 每人可领券的数量限制 |
| ├─ use_limit | string | 非必须 |  | 每人可核销的数量限制 |
| ├─ can_share | string | 非必须 |  | 卡券领取页面是否可分享 |
| ├─ can_give_friend | string | 非必须 |  | 卡券是否可转赠 |
| ├─ abstract | string | 非必须 |  | 封面摘要 |
| ├─ icon_url_list | string | 非必须 |  | 封面图片 |
| ├─ text_image_list | string | 非必须 |  | 图文列表 |
| ├─ time_limit | string | 非必须 |  | 使用时段限制 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ quantity | string | 非必须 |  | 卡券数量 |
| ├─ use_all_shops | string | 非必须 |  | 是否适用所有门店 |
| ├─ rel_shops_ids | string | 非必须 |  | 适用的门店 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ use_scenes | string | 非必须 |  | 核销场景。可选值有，ONLINE:线上商城(兑换券不可使用);QUICK:快捷买单(兑换券不可使用);SWEEP:门店支付(扫码核销);SELF:到店支付(自助核销) |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ self_consume_code | string | 非必须 |  | 自助核销验证码 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ card_code | string | 非必须 |  |  |
| ├─ card_rule_code | string | 非必须 |  |  |
| ├─ get_num | integer | 非必须 |  |  |
| ├─ use_num | integer | 非必须 |  |  |
| ├─ user_get_num | integer | 非必须 |  |  |
| ├─ numNull | integer | 非必须 |  |  |
获取卡券详情
基本信息
Path： /api/h5app/wxapp/getCardDetail/{cardId}
Method： GET
接口描述：
获取卡券详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| card_id
|
| 卡券id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，可选值有，discount:折扣券;cash:代金券;gift:兑换券 |
| ├─ brand_name | string | 非必须 |  | 商户名称 |
| ├─ logo_url | string | 非必须 |  | 卡券商户 logo |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ notice | string | 非必须 |  | 卡券使用提醒 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ date_type | string | 非必须 |  | 有效期的类型 |
| ├─ begin_date | integer | 非必须 |  | 有效期开始时间 |
| ├─ end_date | integer | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ service_phone | string | 非必须 |  | 客服电话 |
| ├─ center_title | string | 非必须 |  | 卡券顶部居中的按钮，仅在卡券状态正常(可以核销)时显示 |
| ├─ center_sub_title | string | 非必须 |  | 显示在入口下方的提示语 |
| ├─ center_url | string | 非必须 |  | 顶部居中的url |
| ├─ custom_url_name | string | 非必须 |  | 自定义跳转外链的入口名字 |
| ├─ custom_url | string | 非必须 |  | 自定义跳转的URL |
| ├─ custom_url_sub_title | string | 非必须 |  | 显示在入口右侧的提示语 |
| ├─ promotion_url_name | string | 非必须 |  | 营销场景的自定义入口名称 |
| ├─ promotion_url | string | 非必须 |  | 营销场景的自定义入口url |
| ├─ promotion_url_sub_title | string | 非必须 |  | 营销入口右侧的提示语 |
| ├─ get_limit | string | 非必须 |  | 每人可领券的数量限制 |
| ├─ use_limit | string | 非必须 |  | 每人可核销的数量限制 |
| ├─ can_share | string | 非必须 |  | 卡券领取页面是否可分享 |
| ├─ can_give_friend | string | 非必须 |  | 卡券是否可转赠 |
| ├─ abstract | string | 非必须 |  | 封面摘要 |
| ├─ icon_url_list | string | 非必须 |  | 封面图片 |
| ├─ text_image_list | string | 非必须 |  | 图文列表 |
| ├─ time_limit | string | 非必须 |  | 使用时段限制 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ quantity | string | 非必须 |  | 卡券数量 |
| ├─ use_all_shops | string | 非必须 |  | 是否适用所有门店 |
| ├─ rel_shops_ids | string | 非必须 |  | 适用的门店 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ use_scenes | string | 非必须 |  | 核销场景。可选值有，ONLINE:线上商城(兑换券不可使用);QUICK:快捷买单(兑换券不可使用);SWEEP:门店支付(扫码核销);SELF:到店支付(自助核销) |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ self_consume_code | string | 非必须 |  | 自助核销验证码 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ card_code | string | 非必须 |  |  |
| ├─ card_rule_code | string | 非必须 |  |  |
| ├─ get_num | integer | 非必须 |  |  |
| ├─ use_num | integer | 非必须 |  |  |
| ├─ user_get_num | integer | 非必须 |  |  |
| ├─ numNull | integer | 非必须 |  |  |
获取用户已领取的优惠券列表
基本信息
Path： /api/h5app/wxapp/user/newGetCardList
Method： GET
接口描述：
获取用户已领取的优惠券列表
请求参数
Query
参数名称
是否必须
示例
备注
| amount
| 否
|
| 使用优惠券之前的订单金额
| items
| 否
|
| 使用优惠券券的商品
| code
| 否
|
| 优惠券的 code 码
| card_id
| 否
|
| 指定优惠券card_id
| shop_id
| 否
|
| 门店 shop_id 号
| item_id
| 否
|
| 商品id集
| page_no
| 否
|
| page
| page_size
| 否
|
| limit
| use_platform
| 否
|
| 可选值为：picker
| page_type
| 否
|
| 优惠券适用平台 mall 线上商城专用 or store门店专用
| use_scenes
| 否
|
| 核销场景。可选值有，ONLINE:线上商城(兑换券不可使用);QUICK:快捷买单(兑换券不可使用);SWEEP:门店支付(扫码核销);SELF:到店支付(自助核销)
| distributor_id
| 否
|
| 店铺id
| is_checkout
| 否
|
| iscrossborder
| 否
|
| 是否跨境
| isShopScreen
| 否
|
| 是否门店大屏
| cxdid
| 否
|
| 促销单ID
返回数据
名称类型是否必须默认值备注其他信息
|   |  | 非必须 |  |  |
获取用户已领取的优惠券列表
基本信息
Path： /api/h5app/wxapp/user/getCardList
Method： GET
接口描述：
获取用户已领取的优惠券列表
请求参数
Query
参数名称
是否必须
示例
备注
| amount
| 否
|
| 使用优惠券之前的订单金额
| code
| 否
|
| 优惠券的 code 码
| use_scenes
| 否
|
| 可被核销的方式
| card_id
| 否
|
| 指定优惠券card_id
| shop_id
| 否
|
| 微信门店 id 号
| page
| 否
|
| page
| page_size
| 否
|
| limit
| use_platform
| 否
|
| 优惠券适用平台（mall:线上商城专用, store:门店专用）
| status
| 否
|
| 用户领取的优惠券使用状态{1:未使用,2:已核销,3:已转赠,5:已过期,6:作废}
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | id |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ card_id | string | 非必须 |  | 微信用户领取的卡券 id |
| ├─ code | string | 非必须 |  | 卡券code序列号 |
| ├─ status | string | 非必须 |  | 用户领取的优惠券使用状态{1:未使用,2:已核销,3:已转赠,5:已过期,6:作废} |
| ├─ card_type | string | 非必须 |  | 优惠券类型,可选值有 discount:折扣券，cash:代金券，gift:兑换券 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ use_condition | object | 非必须 |  |  |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ rel_shops_ids | string | 非必须 |  | 门店shop_id;线下门店时,必填 |
| ├─ is_give_by_friend | string | 非必须 |  | 是否为转赠领取 |
| ├─ old_code | string | 非必须 |  | 转赠之后,旧的 code 序列号 |
| ├─ get_outer_str | string | 非必须 |  | 领取场景值 |
| ├─ consume_source | string | 非必须 |  | 核销来源 |
| ├─ location_name | string | 非必须 |  | 核销卡券的门店名称 |
| ├─ staff_open_id | string | 非必须 |  | 卡券核销员 |
| ├─ verify_code | string | 非必须 |  | 自助核销的验证码 |
| ├─ remark_amount | string | 非必须 |  | 自助核销时备注金额 |
| ├─ consume_outer_str | string | 非必须 |  | 核销渠道 |
| ├─ trans_id | string | 非必须 |  | 微信支付交易订单号,买单核销专用 |
| ├─ fee | string | 非必须 |  | 实付金额,买单核销专用 |
| ├─ original_fee | string | 非必须 |  | 应付金额,买单核销专用 |
| ├─ location_id | string | 非必须 |  | 当前卡券核销的门店ID |
| ├─ friend_open_id | string | 非必须 |  | 转赠卡券时接收方 open_id |
| ├─ is_return_back | string | 非必须 |  | 转赠时是否退回 |
| ├─ is_chat_room | string | 非必须 |  | 是否群转赠 |
| ├─ source_type | string | 非必须 |  | 卡券来源类型，可选值有 local:本地卡券,wechat:微信卡券 |
| ├─ use_scenes | string | 非必须 |  | 可被核销的方式 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台 mall:线上商城专用, store:门店专用 |
| ├─ rel_item_ids | string | 非必须 |  | 使用商品 |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ rel_distributor_ids | string | 非必须 |  | 使用店铺 |
| ├─ get_date | string | 非必须 |  | 优惠券获取时间 |
| ├─ salesperson_id | string | 非必须 |  | 导购id |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ rel_category_ids | string | 非必须 |  | 可使用的类目 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ use_limited | string | 非必须 |  | 是否可以多次使用,仅记录无业务 |
| ├─ remain_times | string | 非必须 |  | 剩余使用次数,仅记录无业务 |
| ├─ use_all_items | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ distributor_info | string | 非必须 |  |  |
| ├─ use_all_distributor | string | 非必须 |  | 是否是全部店铺 |
| ├─ coupon | object | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  | 微信用户领取的卡券 id |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ code | string | 非必须 |  | 卡券code序列号 |
| ├─ card_type | string | 非必须 |  | 卡券类型 |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ storeList | string | 非必须 |  |  |
| ├─ ifall | string | 非必须 |  |  |
| ├─ count | string | 非必须 |  | 总条数 |
获取用户已领取的优惠券详情
基本信息
Path： /api/h5app/wxapp/user/newGetCardDetail
Method： GET
接口描述：
获取用户已领取的优惠券详情
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 否
|
| 优惠券的 code 码
| card_id
| 否
|
| 指定优惠券card_id
返回数据
名称类型是否必须默认值备注其他信息
|   |  | 非必须 |  |  |
获取用户已领取的优惠券详情
基本信息
Path： /api/h5app/wxapp/user/getCardDetail
Method： GET
接口描述：
获取用户已领取的优惠券详情
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 否
|
| 优惠券的 code 码
| card_id
| 否
|
| 指定优惠券card_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ detail | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | id |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ card_id | string | 非必须 |  | 微信用户领取的卡券 id |
| ├─ code | string | 非必须 |  | 卡券code序列号 |
| ├─ status | string | 非必须 |  | 用户领取的优惠券使用状态{1:未使用,2:已核销,3:已转赠,5:已过期,6:作废} |
| ├─ card_type | string | 非必须 |  | 优惠券类型,可选值有 discount:折扣券，cash:代金券，gift:兑换券 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ use_condition | object | 非必须 |  |  |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ rel_shops_ids | string | 非必须 |  | 门店shop_id;线下门店时,必填 |
| ├─ is_give_by_friend | string | 非必须 |  | 是否为转赠领取 |
| ├─ old_code | string | 非必须 |  | 转赠之后,旧的 code 序列号 |
| ├─ get_outer_str | string | 非必须 |  | 领取场景值 |
| ├─ consume_source | string | 非必须 |  | 核销来源 |
| ├─ location_name | string | 非必须 |  | 核销卡券的门店名称 |
| ├─ staff_open_id | string | 非必须 |  | 卡券核销员 |
| ├─ verify_code | string | 非必须 |  | 自助核销的验证码 |
| ├─ remark_amount | string | 非必须 |  | 自助核销时备注金额 |
| ├─ consume_outer_str | string | 非必须 |  | 核销渠道 |
| ├─ trans_id | string | 非必须 |  | 微信支付交易订单号,买单核销专用 |
| ├─ fee | string | 非必须 |  | 实付金额,买单核销专用 |
| ├─ original_fee | string | 非必须 |  | 应付金额,买单核销专用 |
| ├─ location_id | string | 非必须 |  | 当前卡券核销的门店ID |
| ├─ friend_open_id | string | 非必须 |  | 转赠卡券时接收方 open_id |
| ├─ is_return_back | string | 非必须 |  | 转赠时是否退回 |
| ├─ is_chat_room | string | 非必须 |  | 是否群转赠 |
| ├─ source_type | string | 非必须 |  | 卡券来源类型，可选值有 local:本地卡券,wechat:微信卡券 |
| ├─ use_scenes | string | 非必须 |  | 可被核销的方式 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台 mall:线上商城专用, store:门店专用 |
| ├─ rel_item_ids | string | 非必须 |  | 使用商品 |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ rel_distributor_ids | string | 非必须 |  | 使用店铺 |
| ├─ get_date | string | 非必须 |  | 优惠券获取时间 |
| ├─ salesperson_id | string | 非必须 |  | 导购id |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ rel_category_ids | string | 非必须 |  | 可使用的类目 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ use_limited | string | 非必须 |  | 是否可以多次使用,仅记录无业务 |
| ├─ remain_times | string | 非必须 |  | 剩余使用次数,仅记录无业务 |
| ├─ use_all_items | string | 非必须 |  |  |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ distributor_info | string | 非必须 |  |  |
| ├─ use_all_distributor | string | 非必须 |  | 是否是全部店铺 |
| ├─ coupon | object | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  | 微信用户领取的卡券 id |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ code | string | 非必须 |  | 卡券code序列号 |
| ├─ card_type | string | 非必须 |  | 卡券类型 |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ storeList | string | 非必须 |  |  |
| ├─ ifall | string | 非必须 |  |  |
| ├─ shop_list | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ wxShopId | string | 非必须 |  | 微信门店ID |
| ├─ mapPoiId | string | 非必须 |  | 从腾讯地图换取的位置点id |
| ├─ picList | string | 非必须 |  | 门店图片 |
| ├─ contractPhone | string | 非必须 |  | 联系电话 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ credential | string | 非必须 |  | 经营资质证件号 |
| ├─ companyName | string | 非必须 |  | 主体名字 |
| ├─ qualificationList | string | 非必须 |  | 相关证明材料 |
| ├─ cardId | string | 非必须 |  | 卡券id |
| ├─ status | string | 非必须 |  | 审核状态，1：审核成功，2：审核中，3：审核失败，4：管理员拒绝, 5: 无需审核 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ address | string | 非必须 |  | 腾讯地图门店地址 |
| ├─ category | string | 非必须 |  | 腾讯地图门店类目 |
| ├─ poiId | string | 非必须 |  | 门店id |
| ├─ errmsg | string | 非必须 |  | 审核失败原因 |
| ├─ auditId | string | 非必须 |  | 微信返回的审核id |
| ├─ resourceId | string | 非必须 |  | 资源包id |
| ├─ expiredAt | string | 非必须 |  | 过期时间 |
| ├─ isDefault | string | 非必须 |  | 是否是默认门店 |
| ├─ storeName | string | 非必须 |  | 腾讯地图的门店名称 |
| ├─ addType | string | 非必须 |  | 1,公众号主体；2,相关主体; 3,无主体 |
| ├─ country | string | 非必须 |  | 非中国国家名称 |
| ├─ city | string | 非必须 |  | 非中国门店所在城市 |
| ├─ isDomestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ isDirectStore | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ isOpen | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ distributorId | string | 非必须 |  | 门店所属店铺ID |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ card_info | object | 非必须 |  |  |
| ├─ card_id | string | 非必须 |  | 卡券ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ card_type | string | 非必须 |  | 卡券类型，可选值有，discount:折扣券;cash:代金券;gift:兑换券 |
| ├─ brand_name | string | 非必须 |  | 商户名称 |
| ├─ logo_url | string | 非必须 |  | 卡券商户 logo |
| ├─ title | string | 非必须 |  | 卡券名 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ notice | string | 非必须 |  | 卡券使用提醒 |
| ├─ description | string | 非必须 |  | 卡券使用说明 |
| ├─ date_type | string | 非必须 |  | 有效期的类型 |
| ├─ begin_date | integer | 非必须 |  | 有效期开始时间 |
| ├─ end_date | integer | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ service_phone | string | 非必须 |  | 客服电话 |
| ├─ center_title | string | 非必须 |  | 卡券顶部居中的按钮，仅在卡券状态正常(可以核销)时显示 |
| ├─ center_sub_title | string | 非必须 |  | 显示在入口下方的提示语 |
| ├─ center_url | string | 非必须 |  | 顶部居中的url |
| ├─ custom_url_name | string | 非必须 |  | 自定义跳转外链的入口名字 |
| ├─ custom_url | string | 非必须 |  | 自定义跳转的URL |
| ├─ custom_url_sub_title | string | 非必须 |  | 显示在入口右侧的提示语 |
| ├─ promotion_url_name | string | 非必须 |  | 营销场景的自定义入口名称 |
| ├─ promotion_url | string | 非必须 |  | 营销场景的自定义入口url |
| ├─ promotion_url_sub_title | string | 非必须 |  | 营销入口右侧的提示语 |
| ├─ get_limit | string | 非必须 |  | 每人可领券的数量限制 |
| ├─ use_limit | string | 非必须 |  | 每人可核销的数量限制 |
| ├─ can_share | string | 非必须 |  | 卡券领取页面是否可分享 |
| ├─ can_give_friend | string | 非必须 |  | 卡券是否可转赠 |
| ├─ abstract | string | 非必须 |  | 封面摘要 |
| ├─ icon_url_list | string | 非必须 |  | 封面图片 |
| ├─ text_image_list | string | 非必须 |  | 图文列表 |
| ├─ time_limit | string | 非必须 |  | 使用时段限制 |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣券打折额度（百分比) |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ quantity | string | 非必须 |  | 卡券数量 |
| ├─ use_all_shops | string | 非必须 |  | 是否适用所有门店 |
| ├─ rel_shops_ids | string | 非必须 |  | 适用的门店 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ use_scenes | string | 非必须 |  | 核销场景。可选值有，ONLINE:线上商城(兑换券不可使用);QUICK:快捷买单(兑换券不可使用);SWEEP:门店支付(扫码核销);SELF:到店支付(自助核销) |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ self_consume_code | string | 非必须 |  | 自助核销验证码 |
| ├─ use_platform | string | 非必须 |  | 优惠券适用平台（线上商城专用 or 门店专用） |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ card_code | string | 非必须 |  |  |
| ├─ card_rule_code | string | 非必须 |  |  |
| ├─ get_num | integer | 非必须 |  |  |
| ├─ use_num | integer | 非必须 |  |  |
| ├─ user_get_num | integer | 非必须 |  |  |
| ├─ numNull | integer | 非必须 |  |  |
| ├─ card_code | string | 非必须 |  |  |
获取等级列表
基本信息
Path： /api/h5app/wxapp/membercard/grades
Method： GET
接口描述：
获取等级列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ member_card_list | object [] | 非必须 |  | 会员等级列表 |
item 类型: object
| ├─ grade_id | string | 非必须 |  | 等级ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ default_grade | string | 非必须 |  | 是否默认等级 |
| ├─ background_pic_url | string | 非必须 |  | 商家自定义会员卡背景图 |
| ├─ promotion_condition | object | 非必须 |  |  |
| ├─ total_consumption | string | 非必须 |  | 升级条件 |
| ├─ privileges | object | 非必须 |  |  |
| ├─ discount | string | 非必须 |  |  |
| ├─ discount_desc | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ third_data | string | 非必须 |  | 第三方数据 |
| ├─ crm_open | string | 非必须 |  | crm开关 |
| ├─ vip_grade_list | object [] | 非必须 |  | 付费会员等级卡列表 |
item 类型: object
| ├─ vip_grade_id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ default_grade | string | 非必须 |  | 是否默认等级 |
| ├─ is_disabled | string | 非必须 |  | 是否禁用 |
| ├─ background_pic_url | string | 非必须 |  | 商家自定义会员卡背景图 |
| ├─ description | string | 非必须 |  | 详细说明 |
| ├─ price_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  | 名称 |
| ├─ price | string | 非必须 |  | 价格 |
| ├─ day | string | 非必须 |  | 有效期 |
| ├─ desc | string | 非必须 |  | 描述 |
| ├─ privileges | object | 非必须 |  |  |
| ├─ discount | string | 非必须 |  |  |
| ├─ discount_desc | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ guide_title | string | 非必须 |  | 购买引导文本 |
| ├─ is_default | string | 非必须 |  | 是否默认 |
购买付费会员折扣卡
基本信息
Path： /api/h5app/wxapp/vipgrades/buy
Method： POST
接口描述：
购买付费会员折扣卡
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店ID
| distributor_id
| 否
|
| 店铺ID
| vip_grade_id
| 是
|
| 付费会员折扣卡id
| card_type
| 是
|
| 折扣类型（monthly、quarter、year）
| pay_type
| 否
|
| 支付方式 wxpay(默认)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ appId | string | 非必须 |  | appId |
| ├─ timeStamp | string | 非必须 |  | 时间戳 |
| ├─ nonceStr | string | 非必须 |  | 随机字符串 |
| ├─ package | string | 非必须 |  | 扩展字符串 |
| ├─ signType | string | 非必须 |  | 签名方式 |
| ├─ paySign | string | 非必须 |  | 签名 |
| ├─ trade_info | object | 非必须 |  |  |
| ├─ order_id | string | 非必须 |  | 订单号 |
| ├─ trade_id | string | 非必须 |  | 交易号 |
| ├─ pay_fee | string | 非必须 |  | 支付金额 |
| ├─ total_fee | string | 非必须 |  | 总金额 |
分销推广
获取任务制佣金统计
基本信息
Path： /api/h5app/wxapp/promoter/taskBrokerage/count
Method： GET
接口描述：
获取任务制佣金统计
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| pageSize
| 是
|
| 每页的数量
| page
| 是
|
| 分页页数
| time_start
| 否
|
| 查询开始时间
| time_end
| 否
|
| 查询结束时间
| plan_date
| 否
|
| 账期时间
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 数据记录总条数 |
| ├─ list | object [] | 非必须 |  | 数据记录 |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ rebate_type | string | 非必须 |  | 返佣模式 |
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ total_fee | integer | 非必须 |  | 已完成的总销售额 |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ user_id | integer | 非必须 |  | 会员id |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ rebate_conf | string | 非必须 |  | 分销配置 |
| ├─ rebate_money | integer | 非必须 |  | 分销奖金 |
| ├─ finish_num | integer | 非必须 |  | 订单已完成数量 |
| ├─ wait_num | integer | 非必须 |  | 订单已支付，待完成数量 |
| ├─ close_num | integer | 非必须 |  | 订单已关闭数量，包含取消订单，售后订单 |
| ├─ plan_date | integer | 非必须 |  | 计划结算时间 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 修改时间 |
会员成为推广员
基本信息
Path： /api/h5app/wxapp/promoter
Method： POST
接口描述：
会员成为推广员
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | stirng | 非必须 |  |  |
删除推广员关联的商品
基本信息
Path： /api/h5app/wxapp/promoter/relgoods
Method： DELETE
接口描述：
删除推广员关联的商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| goods_id
| 是
|
| 关联的goods_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | stirng | 非必须 |  |  |
推广员佣金提现申请
基本信息
Path： /api/h5app/wxapp/promoter/cash_withdrawal
Method： POST
接口描述：
推广员佣金提现申请
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| money
| 否
|
| 提现金额
| pay_type
| 否
|
| 提现支付方式
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  | id |
| ├─ company_id | integer | 非必须 |  | company_id |
| ├─ user_id | string | 非必须 |  | 会员id |
| ├─ account_name | string | 非必须 |  | 提现账号姓名 |
| ├─ pay_account | string | 非必须 |  | 提现账号 微信为openid 支付宝为，支付账号 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ money | integer | 非必须 |  | 提现金额，以分为单位 |
| ├─ status | string | 非必须 |  | 提现状态 |
| ├─ remarks | string | 非必须 |  | 备注 |
| ├─ pay_type | string | 非必须 |  | 提现支付类型 |
| ├─ wxa_appid | string | 非必须 |  | 提现的小程序appid |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 修改时间 |
推广员佣金提现申请列表
基本信息
Path： /api/h5app/wxapp/promoter/cash_withdrawal
Method： GET
接口描述：
推广员佣金提现申请列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 分页
| pageSize
| 是
|
| 分页页码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ user_id | string | 非必须 |  | 推广员userId |
| ├─ pay_account | string | 非必须 |  | 提现账号 微信为openid 支付宝为，支付账号 |
| ├─ account_name | string | 非必须 |  | 提现账号姓名 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ money | integer | 非必须 |  | 提现金额，以分为单位 |
| ├─ status | string | 非必须 |  | 提现状态 |
| ├─ remarks | string | 非必须 |  | 备注 |
| ├─ pay_type | string | 非必须 |  | 提现支付类型 |
| ├─ wxa_appid | string | 非必须 |  | 提现的小程序appid |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ created_date | string | 非必须 |  |  |
推广员佣金统计
基本信息
Path： /api/h5app/wxapp/promoter/brokerage/count
Method： GET
接口描述：
推广员佣金统计
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ payedRebate | integer | 非必须 |  | 已提现 |
| ├─ itemTotalPrice | integer | 非必须 |  | 营业额 |
| ├─ cashWithdrawalRebate | integer | 非必须 |  | 可提现金额 |
| ├─ noCloseRebate | integer | 非必须 |  | 未结算金额 |
| ├─ rebateTotal | integer | 非必须 |  | 推广费总金额 |
| ├─ freezeCashWithdrawalRebate | integer | 非必须 |  | 冻结金额 |
| ├─ taskBrokerageItemTotalFee | integer | 非必须 |  | 任务商品总销售额 |
| ├─ orderNoCloseRebate | integer | 非必须 |  | 任务商品总销售额 |
| ├─ orderCloseRebate | integer | 非必须 |  | 任务商品总销售额 |
| ├─ orderRebate | integer | 非必须 |  | 任务商品总销售额 |
| ├─ orderTeamNoCloseRebate | integer | 非必须 |  |  |
| ├─ orderTeamCloseRebate | integer | 非必须 |  |  |
| ├─ orderTeamRebate | integer | 非必须 |  |  |
| ├─ limit_time | integer | 非必须 |  |  |
推广员返佣积分统计
基本信息
Path： /api/h5app/wxapp/promoter/brokerage/point_count
Method： GET
接口描述：
推广员佣金统计
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ grand_point_total | string | 必须 |  | 累计获得积分 |
| ├─ point_total | string | 必须 |  | 推广积分总额 |
| ├─ rebate_point | string | 必须 |  | 小店提成 |
| ├─ order_no_close_rebate | string | 必须 |  | 提成未确认积分 |
| ├─ order_close_rebate | string | 必须 |  | 提成已确认积分 |
| ├─ order_total | string | 必须 |  | 提成总额 |
| ├─ order_team_no_close_rebate | string | 必须 |  | 津贴未确认积分 |
| ├─ order_team_close_rebate | string | 必须 |  | 津贴已确认积分 |
| ├─ order_team_total | string | 必须 |  | 津贴总额 |
推广员首页数据
基本信息
Path： /api/h5app/wxapp/promoter/index
Method： GET
接口描述：
推广员首页数据
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ promoter_order_count | integer | 非必须 |  | 推广员订单数量 |
| ├─ promoter_grade_order_count | integer | 非必须 |  | 推广员团队订单 |
| ├─ itemTotalPrice | integer | 非必须 |  | 营业额 |
| ├─ cashWithdrawalRebate | integer | 非必须 |  | 可提现金额 |
| ├─ noCloseRebate | integer | 非必须 |  | 未结算金额 |
| ├─ rebateTotal | integer | 非必须 |  | 推广费总金额 |
| ├─ freezeCashWithdrawalRebate | integer | 非必须 |  | 冻结金额 |
| ├─ taskBrokerageItemTotalFee | integer | 非必须 |  | 任务商品总销售额 |
| ├─ isbuy_promoter | integer | 非必须 |  | 购买会员 |
| ├─ notbuy_promoter | integer | 非必须 |  | 未购买会员 |
| ├─ pointTotal | string | 非必须 |  | 推广积分 |
| ├─ taskBrokerageItemTotalPoint | string | 非必须 |  | 任务商品总积分 |
更新推广员信息
基本信息
Path： /api/h5app/wxapp/promoter
Method： PUT
接口描述：
更新推广员信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| alipay_name
| 否
|
| 提现支付宝姓名
| alipay_account
| 否
|
| 提现支付宝账号
| shop_name
| 否
|
| 推广员自定义店铺名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | stirng | 非必须 |  |  |
关联推广员关联的商品
基本信息
Path： /api/h5app/wxapp/promoter/relgoods
Method： POST
接口描述：
关联推广员关联的商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| goods_id
| 是
|
| 指定的关联的goods_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | stirng | 非必须 |  |  |
获取任务制佣金记录
基本信息
Path： /api/h5app/wxapp/promoter/taskBrokerage/logs
Method： GET
接口描述：
获取任务制佣金记录
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| pageSize
| 是
|
| 每页的数量
| page
| 是
|
| 分页页数
| plan_date
| 否
|
| 账期时间
| time_start
| 否
|
| 查询开始时间
| time_end
| 否
|
| 查询结束时间
| status
| 否
|
| 状态
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | string | 非必须 |  |  |
获取店招默认封面图
基本信息
Path： /api/h5app/wxapp/promoter/banner
Method： GET
接口描述：
获取店招默认封面图
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ banner_img | stirng | 非必须 |  |  |
获取推广二维码
基本信息
Path： /api/h5app/wxapp/brokerage/qrcode/info
Method： GET
接口描述：
获取推广二维码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ share_qrcode | string | 非必须 |  | 分享二维码 |
| ├─ share_uir | string | 非必须 |  | 分享链接 |
获取推广员2级下线
基本信息
Path： /api/h5app/wxapp/promoter/children
Method： GET
接口描述：
获取推广员2级下线
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
| page
|
| 是
|
| 分页
| pageSize
|
| 是
|
| 分页页码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | stirng | 非必须 |  |  |
获取推广员佣金列表
基本信息
Path： /api/h5app/wxapp/promoter/brokerages
Method： GET
接口描述：
获取推广员佣金列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| brokerage_source
| 否
|
| 提现支付宝姓名
| page
| 否
|
| 提现支付宝账号
| pageSize
| 否
|
| 推广员自定义店铺名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ close | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | string | 非必须 |  |  |
| ├─ noClose | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  |  |
| ├─ list | string | 非必须 |  |  |
获取推广员关联的商品
基本信息
Path： /api/h5app/wxapp/promoter/relgoods
Method： GET
接口描述：
获取推广员关联的商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页记录显示条数
| goods_id
| 是
|
| 指定关联的goods_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ goods_id | string | 非必须 |  | 商品id集合 |
获取推广员基本信息
基本信息
Path： /api/h5app/wxapp/promoter/info
Method： GET
接口描述：
获取推广员基本信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ grade_id | string | 非必须 |  | 等级id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ user_card_code | string | 非必须 |  | 会员卡号 |
| ├─ authorizer_appid | string | 非必须 |  | 公众号的appid |
| ├─ wxa_appid | string | 非必须 |  | 小程序的appid |
| ├─ source_id | string | 非必须 |  | 来源id |
| ├─ monitor_id | string | 非必须 |  | 监控页面id |
| ├─ latest_source_id | string | 非必须 |  | 最近来源id |
| ├─ latest_monitor_id | string | 非必须 |  | 最近监控页面id |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ created_year | string | 非必须 |  | 创建年份 |
| ├─ created_month | string | 非必须 |  | 创建月份 |
| ├─ created_day | string | 非必须 |  | 创建日期 |
| ├─ offline_card_code | string | 非必须 |  | 线下会员卡号 |
| ├─ inviter_id | string | 非必须 |  | 推荐人id |
| ├─ source_from | string | 非必须 |  | 来源类型 default默认 |
| ├─ password | string | 非必须 |  | 密码 |
| ├─ disabled | integer | 非必须 |  | 是否有效 |
| ├─ use_point | string | 非必须 |  | 是否可以使用积分 |
| ├─ remarks | string | 非必须 |  | 会员备注 |
| ├─ third_data | string | 非必须 |  | 第三方数据 |
| ├─ username | string | 非必须 |  | 昵称 |
| ├─ sex | string | 非必须 |  | 性别 |
| ├─ created_date | string | 非必须 |  | 创建时间 |
| ├─ id | string | 非必须 |  | ID |
| ├─ promoter_id | string | 非必须 |  |  |
| ├─ shop_name | string | 非必须 |  | 推广员自定义店铺名称 |
| ├─ alipay_name | string | 非必须 |  | 推广员提现的支付宝姓名 |
| ├─ shop_pic | string | 非必须 |  | 推广店铺封面 |
| ├─ brief | string | 非必须 |  | 推广店铺描述 |
| ├─ alipay_account | string | 非必须 |  | 推广员提现的支付宝账号 |
| ├─ pid | integer | 非必须 |  | 上级会员ID |
| ├─ shop_status | integer | 非必须 |  | 开店状态 0 未开店 1已开店 2申请中 3禁用 4申请审核拒绝  |
| ├─ reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ pmobile | string | 非必须 |  | 上级手机号 |
| ├─ grade_level | integer | 非必须 |  | 推广员等级 |
| ├─ is_promoter | integer | 非必须 |  | 是否为推广员 |
| ├─ is_buy | integer | 非必须 |  | 是否有购买记录 |
| ├─ children_count | integer | 非必须 |  |  |
| ├─ bind_date | string | 非必须 |  |  |
| ├─ promoter_grade_name | string | 非必须 |  |  |
| ├─ is_open_promoter_grade | string | 非必须 |  |  |
| ├─ nickname | string | 非必须 |  |  |
| ├─ headimgurl | string | 非必须 |  |  |
| ├─ selfInfo | string | 非必须 |  |  |
| ├─ isOpenShop | string | 非必须 |  |  |
| ├─ isOpenPopularize | string | 非必须 |  |  |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ isOpenPromoterInformation | string | 非必须 |  | 是否开启推广员信息 |
| ├─ shop_img | string | 非必须 |  | 小店图片 |
| ├─ share_title | string | 非必须 |  | 分享标题 |
| ├─ share_des | string | 非必须 |  | 分享描述 |
| ├─ applets_share_img | string | 非必须 |  | 小程序分享图片 |
| ├─ h5_share_img | string | 非必须 |  | h5/app/海报 分享图片 |
| ├─ headquarters_logo | string | 非必须 |  | 总部头像 |
| ├─ qrcode_bg_img | string | 非必须 |  | 分享二维码背景图片 |
获取推广员小程序码
基本信息
Path： /api/h5app/wxapp/promoter/qrcode
Method： GET
接口描述：
获取推广员小程序码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| path
| 否
|
| 需要跳转的地址，默认为首页
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ qrcode | string | 非必须 |  | 小程序码 |
获取设置虚拟店首页模板
基本信息
Path： /api/h5app/wxapp/promoter/custompage
Method： GET
接口描述：
获取设置虚拟店首页模板
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ custompage_template_id | stirng | 非必须 |  |  |
积分商城
扫条形码加入购物车
基本信息
Path： /api/h5app/wxapp/pointsmall/goods/scancodeAddcart
Method： POST
接口描述：
扫条形码加入购物车(暂时弃用)
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| barcode
| 否
|
| 商品条形码
| distributor_id
| 否
|
| 店铺或门店id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  |  |
| ├─ msg | string | 非必须 |  |  |
获取分类列表
基本信息
Path： /api/h5app/wxapp/pointsmall/goods/category
Method： GET
接口描述：
获取有商品的分类列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| is_main_category
| 否
|
| 是否为主类目 true:主类目 false:分类
| have_items
| 否
|
| 是否有商品的分类
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
获取分类子分类
基本信息
Path： /api/h5app/wxapp/goods/category/{cat_id}
Method： GET
接口描述：
获取分类子分类
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| cat_id
| 否
|
| 分类id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
获取商品列表
基本信息
Path： /api/h5app/wxapp/pointsmall/goods/items
Method： GET
接口描述：
获取商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 是
|
| 每页数量,最大不能超过50
| category
| 否
|
| 商品分类id
| approve_status
| 否
|
| 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售，only_show:前台仅展示;多个状态逗号分隔
| keywords
| 否
|
| 关键词搜索
| main_category
| 否
|
| 商品主类目id
| start_price
| 否
|
| 积分价格范围筛选-开始
| end_price
| 否
|
| 积分价格范围筛选-结束
| brand_id
| 否
|
| 品牌id
| item_type
| 否
|
| 商品类型，services：服务商品，normal: 普通商品
| goodsSort
| 否
|
| 排序 1:销量倒序 2:积分价格倒序 3:积分价格正序 4:上新
| is_default
| 否
|
| 是否默认商品 默认:true 如果传入false则查询所有sku数据 如果是true查询商品数据
| is_tdk
| 否
|
| 是否获取tdk信息，0不获取,1获取
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ point | integer | 非必须 |  | 积分价格 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ brand_list | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ attribute_id | string | 非必须 |  | Id |
| ├─ attribute_name | string | 非必须 |  | 名称 |
| ├─ attribute_sort | integer | 非必须 |  | 排序 |
| ├─ is_show | string | 非必须 |  | 是否用于筛选 |
| ├─ is_image | string | 非必须 |  | 否需要配置图片 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ currency | string | 非必须 |  | 币种 |
| ├─ title | string | 非必须 |  | 币种名称 |
| ├─ symbol | integer | 非必须 |  | 币种符号 |
| ├─ rate | string | 非必须 |  | 币种税率 |
| ├─ is_default | boolean | 非必须 |  | 是否默认 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
| ├─ tdk_data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ mate_description | string | 非必须 |  | 描述 |
| ├─ mate_keywords | string | 非必须 |  | 关键字 |
获取商品收藏情况
基本信息
Path： /api/h5app/wxapp/pointsmall/goods/items/{item_id}/fav
Method： GET
接口描述：
获取商品收藏情况
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ fav | boolean | 非必须 |  |  |
获取商品详情
基本信息
Path： /api/h5app/wxapp/pointsmall/goods/items/{item_id}
Method： GET
接口描述：
获取商品详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ point | integer | 非必须 |  | 积分价格 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ item_spec_desc | object | 非必须 |  |  |
| ├─ spec_id | integer | 非必须 |  |  |
format: int64
| ├─ spec_name | string | 非必须 |  | 规格名称 |
| ├─ is_image | string | 非必须 |  |  |
| ├─ spec_values | object [] | 非必须 |  |  |
item 类型: object
| ├─ spec_value_id | integer | 非必须 |  |  |
| ├─ spec_custom_value_name | string | 非必须 |  | 规格值自定义名称 |
| ├─ spec_value_name | integer | 非必须 |  | 规格值名称 |
| ├─ item_image_url | string | 非必须 |  | 商品图片地址数组 |
| ├─ spec_image_url | string | 非必须 |  | 规格图片地址数组 |
| ├─ spec_images | object [] | 非必须 |  |  |
item 类型: object
| ├─ spec_value_id | integer | 非必须 |  |  |
format: int64
| ├─ spec_custom_value_name | string | 非必须 |  | 自定义属性名称 |
| ├─ spec_value_name | string | 非必须 |  | 属性名称 |
| ├─ item_image_url | string | 非必须 |  | 商品图片 |
| ├─ spec_image_url | string | 非必须 |  | 规格图片 |
| ├─ spec_items | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | integer | 非必须 |  |  |
format: int64
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ store | string | 非必须 |  |  |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ point | integer | 非必须 |  | 积分价格 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ item_spec | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | integer | 非必须 |  | 商品id |
| ├─ spec_id | integer | 非必须 |  | 规格项id |
| ├─ spec_value_id | integer | 非必须 |  | 规格值id |
| ├─ spec_name | string | 非必须 |  | 规格项名称 |
| ├─ spec_custom_value_name | string | 非必须 |  | 规格值自定义名称 |
| ├─ spec_value_name | integer | 非必须 |  | 规格值名称 |
| ├─ item_image_url | string | 非必须 |  | 商品图片地址数组 |
| ├─ spec_image_url | string | 非必须 |  | 规格图片地址数组 |
| ├─ attribute_ids | string | 非必须 |  | 规格id集合 |
| ├─ attr_values_custom | string | 非必须 |  | 规格值id和名称对应数组 |
| ├─ item_total_store | string | 非必须 |  | 商品库存总和 |
| ├─ videos_url | string | 非必须 |  | 视频地址 |
| ├─ item_category_main | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ currency | string | 非必须 |  | 币种 |
| ├─ title | string | 非必须 |  | 币种名称 |
| ├─ symbol | integer | 非必须 |  | 币种符号 |
| ├─ rate | string | 非必须 |  | 币种税率 |
| ├─ is_default | boolean | 非必须 |  | 是否默认 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
获取指定等级分类列表
基本信息
Path： /api/h5app/wxapp/goods/categorylevel
Method： GET
接口描述：
获取指定等级分类列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| is_main_category
| 否
|
| 是否为主类目 true:主类目 false:分类 默认:false
| category_level
| 否
|
| 层级,从1开始
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ category_id | integer | 非必须 |  | 主类目id |
| ├─ category_name | string | 非必须 |  | 主类目名称 |
| ├─ label | integer | 非必须 |  | 标签 |
| ├─ parent_id | integer | 非必须 |  | 上级id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | boolean | 非必须 |  | 是否为主类目 |
| ├─ goods_params | string | 非必须 |  | 主类目下的属性数组 |
| ├─ goods_spec | string | 非必须 |  | 主类目下的规格数组 |
| ├─ category_level | integer | 非必须 |  | 类目层级,从1开始 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ level | integer | 非必须 |  | 层级,从0开始 |
获取猜你喜欢商品列表
基本信息
Path： /api/h5app/wxapp/pointsmall/lovely/goods/items
Method： GET
接口描述：
获取猜你喜欢商品列表,销量前10,排除当前商品
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| item_id
| 是
|
| 当前商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ brief | string | 非必须 |  | 简介 |
| ├─ pics | string | 非必须 |  | 图片地址数组 |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | integer | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 条形码 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售, only_show:前台仅展示 |
| ├─ cost_price | integer | 非必须 |  | 成本价（分） |
| ├─ market_price | integer | 非必须 |  | 市场价（分） |
| ├─ point | integer | 非必须 |  | 积分价格 |
| ├─ item_bn | string | 非必须 |  | 货品编码 |
| ├─ volume | string | 非必须 |  | 体积 |
| ├─ weight | string | 非必须 |  | 重量(kg) |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ goods_id | integer | 非必须 |  | 商品ID |
| ├─ default_item_id | integer | 非必须 |  | 默认skuid |
| ├─ brand_id | integer | 非必须 |  | 品牌id |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频地址 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ itemId | integer | 非必须 |  | 商品Id |
| ├─ itemName | integer | 非必须 |  | 商品名称 |
| ├─ itemBn | integer | 非必须 |  | 商品编号 |
| ├─ brand_list | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ attribute_id | string | 非必须 |  | Id |
| ├─ attribute_name | string | 非必须 |  | 名称 |
| ├─ attribute_sort | integer | 非必须 |  | 排序 |
| ├─ is_show | string | 非必须 |  | 是否用于筛选 |
| ├─ is_image | string | 非必须 |  | 否需要配置图片 |
| ├─ image_url | string | 非必须 |  | 图片地址 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | integer | 非必须 |  |  |
format: int64
| ├─ currency | string | 非必须 |  | 币种 |
| ├─ title | string | 非必须 |  | 币种名称 |
| ├─ symbol | integer | 非必须 |  | 币种符号 |
| ├─ rate | string | 非必须 |  | 币种税率 |
| ├─ is_default | boolean | 非必须 |  | 是否默认 |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
获取积分商城设置
基本信息
Path： /api/h5app/wxapp/pointsmall/setting
Method： GET
接口描述：
获取积分商城设置
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ pc_banner | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | pc端Banner图片地址 |
| ├─ screen | object | 非必须 |  |  |
| ├─ brand_openstatus | boolean | 非必须 |  | 筛选条件-品牌开启状态 |
| ├─ cat_openstatus | boolean | 非必须 |  | 筛选条件-分类开启状态 |
| ├─ point_openstatus | boolean | 非必须 |  | 筛选条件-积分开启状态 |
| ├─ point_section | string | 非必须 |  | 积分区间数组 |
| ├─ entrance | object | 非必须 |  |  |
| ├─ mobile_openstatus | boolean | 非必须 |  | 入口配置-移动端开启状态 |
| ├─ pc_openstatus | boolean | 非必须 |  | 入口配置-PC端开启状态 |
导购
导购员购物车扫码新增
基本信息
Path： /api/h5app/wxapp/salesperson/scancodeaddcart
Method： POST
接口描述：
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Content-Type
| application/x-www-form-urlencoded
| 是
|
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| is_accumulate
| 否
|
| 购物车数量更改方式，true:类增， false:覆盖
| distributor_id
| 是
|
| 导购所属店铺id
| company_id
| 是
|
| 企业id
| barcode
| 是
|
| 条形码
| salesperson_id
| 是
|
| 导购id
Body
参数名称
参数类型
是否必须
示例
备注
| is_accumulate
| text
| 是
|
| 购物车数量更改方式，true:类增， false:覆盖
| distributor_id
| text
| 是
|
| 导购所属店铺id
| company_id
| text
| 是
|
| 企业id
| barcode
| text
| 是
|
| 条形码
| salesperson_id
| text
| 是
|
| 导购id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ cart_id | string | 非必须 |  | 购物车ID |
| ├─ salesperson_id | string | 非必须 |  | 导购员id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 商品数量 |
| ├─ company_id | string | 非必须 |  | 企业id |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  | 店铺id |
会员发起投诉导购员
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/complaints
Method： POST
接口描述：
会员发起投诉导购员
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
Query
参数名称
是否必须
示例
备注
| complaints_content
| 是
|
| 投诉内容
| complaints_images
| 是
|
| 投诉图片URL地址
返回数据
名称类型是否必须默认值备注其他信息
|  id | string | 非必须 |  | 投诉ID |
|  user_id | string | 非必须 |  | 会员ID |
|  company_id | string | 非必须 |  | 商家ID |
|  user_name | string | 非必须 |  | 会员姓名 |
|  user_mobile | string | 非必须 |  | 会员手机号 |
|  saleman_id | string | 非必须 |  | 导购员ID |
|  saleman_name | string | 非必须 |  | 导购员姓名 |
|  saleman_avatar | string | 非必须 |  | 导购员头像URL |
|  saleman_mobile | string | 非必须 |  | 导购员手机号 |
|  distributor_id | string | 非必须 |  | 店铺ID |
|  saleman_distribution_name | string | 非必须 |  | 店铺名称 |
|  complaints_content | string | 非必须 |  | 投诉内容 |
|  complaints_images | string | 非必须 |  | 投诉图片地址 |
|  reply_status | string | 非必须 |  | 回复状态(0,1) |
|  reply_content | string | 非必须 |  | 回复内容(json编码) |
|  reply_time | string | 非必须 |  | 回复时间 |
|  reply_operator_id | string | 非必须 |  | 回复人ID |
|  reply_operator_name | string | 非必须 |  | 回复人姓名 |
|  reply_operator_mobile | string | 非必须 |  | 回复人手机号 |
|  created | string | 非必须 |  | 创建时间 |
|  updated | string | 非必须 |  | 更新时间 |
会员绑定与导购员之间的关系
基本信息
Path： /api/h5app/h5app/wxapp/usersalespersonrel
Method： POST
接口描述：
会员绑定与导购员之间的关系
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 是
|
| 导购员id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ success | string | 非必须 |  | 是否成功 |
会员获取导购员信息
基本信息
Path： /api/h5app/h5app/wxapp/salesperson
Method： GET
接口描述：
会员获取导购员信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ salesperson_id | string | 非必须 |  | 导购员ID |
| ├─ name | string | 非必须 |  | 导购员姓名 |
| ├─ mobile | string | 非必须 |  | 导购员手机 |
| ├─ created_time | string | 非必须 |  | 导购员创建时间 |
| ├─ salesperson_type | string | 非必须 |  | 导购员类型 |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ child_count | string | 非必须 |  | 导购员引入的会员数 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ shop_name | string | 非必须 |  | 门店名称 |
| ├─ number | string | 非必须 |  | 导购员编号 |
| ├─ friend_count | string | 非必须 |  | 导购员会员好友数 |
| ├─ avatar | string | 非必须 |  | 头像URL |
| ├─ work_userid | string | 非必须 |  | 企业微信userid |
| ├─ work_configid | string | 非必须 |  | 企业微信userid |
| ├─ work_qrcode_configid | string | 非必须 |  | 企业微信userid |
| ├─ role | string | 非必须 |  | 导购权限集合 |
| ├─ created | string | 非必须 |  | created |
| ├─ updated | string | 非必须 |  | updated |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 门店ID |
| ├─ distributor_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 分销商ID |
| ├─ store_type | string | 非必须 |  | store_type |
| ├─ distributor_id | string | 非必须 |  | 分销ID |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ distributor | object | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 店铺ID |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 店铺手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | LOGO图片地址 |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ child_count | string | 非必须 |  | child_count |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 国家行政区划编码组合，逗号隔开 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 区域 |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  | 省份 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  | 城市 |
| ├─ area | string | 非必须 |  | 地区 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ created | string | 非必须 |  | created |
| ├─ updated | string | 非必须 |  | updated |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | string | 非必须 |  | 平台服务费率 |
| ├─ store_address | string | 非必须 |  | 店铺地址 |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ phone | string | 非必须 |  | 手机号 |
| ├─ is_friend | string | 非必须 |  | is_friend |
| ├─ is_show | string | 非必须 |  | is_show |
会员获取导购员信息
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/nologin
Method： GET
接口描述：
会员获取导购员信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 是
|
| 导购员ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ salesperson_id | string | 非必须 |  | 导购员ID |
| ├─ name | string | 非必须 |  | 导购员姓名 |
| ├─ mobile | string | 非必须 |  | 导购员手机 |
| ├─ created_time | string | 非必须 |  | 导购员创建时间 |
| ├─ salesperson_type | string | 非必须 |  | 导购员类型 |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ child_count | string | 非必须 |  | 导购员引入的会员数 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ shop_id | string | 非必须 |  | 门店ID |
| ├─ shop_name | string | 非必须 |  | 门店名称 |
| ├─ number | string | 非必须 |  | 导购员编号 |
| ├─ friend_count | string | 非必须 |  | 导购员会员好友数 |
| ├─ avatar | string | 非必须 |  | 头像URL |
| ├─ work_userid | string | 非必须 |  | 企业微信userid |
| ├─ work_configid | string | 非必须 |  | 企业微信userid |
| ├─ work_qrcode_configid | string | 非必须 |  | 企业微信userid |
| ├─ role | string | 非必须 |  | 导购权限集合 |
| ├─ created | string | 非必须 |  | created |
| ├─ updated | string | 非必须 |  | updated |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 门店ID |
| ├─ distributor_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 分销商ID |
| ├─ store_type | string | 非必须 |  | store_type |
| ├─ distributor_id | string | 非必须 |  | 分销ID |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ distributor | object | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 店铺ID |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 店铺手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | LOGO图片地址 |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ child_count | string | 非必须 |  | child_count |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 国家行政区划编码组合，逗号隔开 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 区域 |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  | 省份 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  | 城市 |
| ├─ area | string | 非必须 |  | 地区 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ created | string | 非必须 |  | created |
| ├─ updated | string | 非必须 |  | updated |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | string | 非必须 |  | 平台服务费率 |
| ├─ store_address | string | 非必须 |  | 店铺地址 |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ phone | string | 非必须 |  | 手机号 |
| ├─ is_friend | string | 非必须 |  | is_friend |
| ├─ is_show | string | 非必须 |  | is_show |
会员获取投诉列表
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/complaintsList
Method： GET
接口描述：
会员获取投诉列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
Query
参数名称
是否必须
示例
备注
| pageSize
| 是
|
| 分页大小
| page
| 是
|
| 页码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 投诉ID |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 商家ID |
| ├─ user_name | string | 非必须 |  | 会员姓名 |
| ├─ user_mobile | string | 非必须 |  | 会员手机号 |
| ├─ saleman_id | string | 非必须 |  | 导购员ID |
| ├─ saleman_name | string | 非必须 |  | 导购员姓名 |
| ├─ saleman_avatar | string | 非必须 |  | 导购员头像URL |
| ├─ saleman_mobile | string | 非必须 |  | 导购员手机号 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ saleman_distribution_name | string | 非必须 |  | 店铺名称 |
| ├─ complaints_content | string | 非必须 |  | 投诉内容 |
| ├─ complaints_images | string | 非必须 |  | 投诉图片地址 |
| ├─ reply_status | string | 非必须 |  | 回复状态(0,1) |
| ├─ reply_content | string | 非必须 |  | 回复内容(json编码) |
| ├─ reply_time | string | 非必须 |  | 回复时间 |
| ├─ reply_operator_id | string | 非必须 |  | 回复人ID |
| ├─ reply_operator_name | string | 非必须 |  | 回复人姓名 |
| ├─ reply_operator_mobile | string | 非必须 |  | 回复人手机号 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 更新时间 |
会员获取投诉详情
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/complaintsDetail/{id}
Method： GET
接口描述：
会员获取投诉详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
路径参数
参数名称
示例
备注
| id
|
| 投诉id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 投诉ID |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 商家ID |
| ├─ user_name | string | 非必须 |  | 会员姓名 |
| ├─ user_mobile | string | 非必须 |  | 会员手机号 |
| ├─ saleman_id | string | 非必须 |  | 导购员ID |
| ├─ saleman_name | string | 非必须 |  | 导购员姓名 |
| ├─ saleman_avatar | string | 非必须 |  | 导购员头像URL |
| ├─ saleman_mobile | string | 非必须 |  | 导购员手机号 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ saleman_distribution_name | string | 非必须 |  | 店铺名称 |
| ├─ complaints_content | string | 非必须 |  | 投诉内容 |
| ├─ complaints_images | string | 非必须 |  | 投诉图片地址 |
| ├─ reply_status | string | 非必须 |  | 回复状态(0,1) |
| ├─ reply_content | string | 非必须 |  | 回复内容(json编码) |
| ├─ reply_time | string | 非必须 |  | 回复时间 |
| ├─ reply_operator_id | string | 非必须 |  | 回复人ID |
| ├─ reply_operator_name | string | 非必须 |  | 回复人姓名 |
| ├─ reply_operator_mobile | string | 非必须 |  | 回复人手机号 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 更新时间 |
修改购物车选中状态
基本信息
Path： /api/h5app/salesperson/cartupdate/checkstatus
Method： PUT
接口描述：
修改购物车选中状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| cart_id
| 是
|
| 购物车id，可传数组
| is_checked
| 是
|
| 是否选中 true:选中 false:取消选中
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | integer | 非必须 |  | 状态 1 成功 0 失败 |
关系延续埋点
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/relationshipcontinuity
Method： POST
接口描述：
关系延续埋点
请求参数
Query
参数名称
是否必须
示例
备注
| event_type
| 是
|
| 事件类型 [activeItemDetail 分享商品详情页],[activeSeedingDetail 分享种草详情页],[activeDiscountCoupon 分享优惠券],[activeCustomPage 分享自定义页面],[orderPaymentSuccess 订单支付成功]
| event_id
| 是
|
| 事件id, 是个多态，如果是导购模块则是导购id, 如果是订单模块则是订单id
| user_type
| 是
|
| 用户类型 [wechat: 微信用户],[enterpriseWeChat: 企业微信用户]
| user_id
| 是
|
| 基于用户类型来确定的user唯一标识，微信用户为unionid
| user_channel_type
| 否
|
| 用户的渠道类型
| country
| 否
|
| 用户所在的国家
| city
| 否
|
| 用户所在的市
| province
| 否
|
| 用户所在的省
| device_manufacturer
| 否
|
| 设备制造商, 例: Apple
| device_os
| 否
|
| 设备操作系统, 例: iOs、Android
| device_os_version
| 否
|
| 设备操作系统版本号, 例: 14.0
| device_id
| 否
|
| 设备的唯一id (UDID、IEMI)
| device_name
| 否
|
| 设备名称, 例: iPhone11
| path
| 否
|
| 事件来源路径, 例: /pages/index
| network_type
| 否
|
| 网络类型, 例: 4G
| params
| 否
|
| json内容，必要的记录参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 分享结果 |
大屏端签到验证
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/signinValid
Method： POST
接口描述：
description
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| token
| 是
|
| token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 扫码结果Code |
| ├─ msg | string | 非必须 |  | 扫码结果描述 |
完成导购任务分享
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/task/share
Method： POST
接口描述：
完成导购任务分享
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 是
|
| 导购id
| type
| 是
|
| items商品
| id
| 是
|
| id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 分享结果 |
会员查看与导购员之间的关系
基本信息
Path： /api/h5app/h5app/wxapp/usersalespersonrel
Method： GET
接口描述：
会员查看与导购员之间的关系
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorization
|
| 是
|
| jwt验证token
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 是
|
| 导购员id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ is_friend | string | 非必须 |  | 是否好友 |
| ├─ is_bind | string | 非必须 |  | 是否绑定 |
| ├─ salesperson_id | string | 非必须 |  | 导购员ID |
| ├─ name | string | 非必须 |  | 会员名 |
| ├─ mobile | string | 非必须 |  | 会员手机号 |
| ├─ created_time | string | 非必须 |  | 创建时间 |
| ├─ salesperson_type | string | 非必须 |  | 导购员类型 |
| ├─ company_id | string | 非必须 |  | 公司ID |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ child_count | string | 非必须 |  | 导购员引入的会员数 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ shop_name | string | 非必须 |  | 门店名称 |
| ├─ number | string | 非必须 |  | 导购员编号 |
| ├─ friend_count | string | 非必须 |  | 导购员会员好友数 |
| ├─ avatar | string | 非必须 |  | 企业微信头像 |
| ├─ work_userid | string | 非必须 |  | 企业微信userid |
| ├─ work_configid | string | 非必须 |  | 企业微信userid |
| ├─ work_qrcode_configid | string | 非必须 |  | 企业微信userid |
| ├─ role | string | 非必须 |  | 导购权限集合 |
| ├─ created | string | 非必须 |  | created |
| ├─ updated | string | 非必须 |  | updated |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 门店id |
| ├─ distributor_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 店铺ID |
| ├─ store_type | string | 非必须 |  | store_type |
| ├─ distributor_id | string | 非必须 |  | 经销商ID |
| ├─ bound | string | 非必须 |  | 是否绑定导购 |
| ├─ bound_salesperson | string | 非必须 |  | 绑定导购ID |
导购员购物车新增
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/cartdataadd
Method： GET
接口描述：
导购员购物车新增
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| item_id
| 是
|
| 商品item_id
| num
| 是
|
| 商品数量
| is_accumulate
| 否
|
| 购物车数量更改方式，true:类增， false:覆盖
| is_checked
| 否
|
| 是否选中，true:是， false:否
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ cart_id | string | 非必须 |  | 购物车ID |
| ├─ salesperson_id | string | 非必须 |  | 导购员id |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 商品数量 |
| ├─ company_id | string | 非必须 |  | 企业id |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  | 店铺id |
扫条形码加入购物车
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/scancodeAddcart
Method： POST
接口描述：
扫条形码加入购物车
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| barcode
| 是
|
| 条形码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ msg | string | 非必须 |  | 加购结果 |
提交子任务参数
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/subtask/post
Method： POST
接口描述：
导购端分享到商城后，提交子任务参数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| subtask_id
| 是
|
| 子任务ID
| distributor_id
| 否
|
| 门店ID
| shop_code
| 否
|
| 门店编号，门店ID不存在必填
| employee_number
| 是
|
| 员工工号
| item_id
| 否
|
| 商品ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 分享结果 |
获取会员订单列表
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/crmorderlist
Method： GET
接口描述：
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| pmcode
| 否
|
| 会员卡号
| start_date
| 是
| 20220101
| 查询开始时间 格式：20220101
| end_date
| 是
| 20220121
| 查询结束时间 格式：20220101
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ pmcode | string | 必须 |  | 会员卡号 |
| ├─ date | string | 必须 |  | 销售日期 |
| ├─ nos | string | 必须 |  | 销售单号 |
| ├─ now_real | string | 必须 |  | 结算金额 |
| ├─ dbno | string | 必须 |  | 下单店铺 |
| ├─ salescode | string | 必须 |  | 接待店员 |
| ├─ discprice | string | 必须 |  | 折扣金额 |
| ├─ orderType | number | 必须 |  | 订单类型 0 正常 1 换货 2 退货 3 赠送 4 商场卡现金点货 17 唯品会 |
| ├─ number | number | 必须 |  | 数量 |
获取会员订单详情
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/crmorderdetail
Method： GET
接口描述：
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| order_no
| 否
|
| 订单号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ pmcode | string | 非必须 |  | 会员卡号 |
| ├─ date | string | 非必须 |  | 销售日期 |
| ├─ nos | string | 非必须 |  | 销售单号 |
| ├─ now_real | string | 非必须 |  | 结算金额 |
| ├─ dbno | string | 非必须 |  | 下单店铺 |
| ├─ salescode | string | 非必须 |  | 接待店员 |
| ├─ discprice | string | 非必须 |  | 折扣金额 |
| ├─ orderLines | object [] | 非必须 |  |  |
item 类型: object
| ├─ productCode | string | 必须 |  | 货号 |
| ├─ color | string | 必须 |  | 商品颜色 |
| ├─ size | string | 必须 |  | 商品尺寸 |
| ├─ number | number | 必须 |  | 数量 |
| ├─ price | string | 必须 |  | 价格 |
| ├─ productName | string | 必须 |  | 商品名称 |
获取导购员促销单
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/salesPromotion
Method： GET
接口描述：
获取导购员促销单
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ valid_cart | object [] | 非必须 |  |  |
item 类型: object
| ├─ shop_name | string | 非必须 |  | 门店名称  |
| ├─ address | string | 非必须 |  | 店铺地址  |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ shop_id | string | 非必须 |  | 店铺ID，如果为0则表示总部 |
| ├─ cart_total_price | string | 非必须 |  | 商品总金额，以分为单位 |
| ├─ item_fee | string | 非必须 |  | 商品金额，以分为单位 |
| ├─ cart_total_num | string | 非必须 |  | 商品数量 |
| ├─ cart_total_count | string | 非必须 |  | 总金额，以分为单位 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 应付总金额,以分为单位 |
| ├─ member_discount | string | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_id | string | 非必须 |  | 购物车ID  |
| ├─ salesperson_id | string | 非必须 |  | 导购员id  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 购买商品数量 |
| ├─ company_id | string | 非必须 |  | 公司id，company_id为0的时候表示通用 |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  |  店铺id  |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ shop_id | string | 非必须 |  | 门店id  |
| ├─ is_last_price | string | 非必须 |  | 是否最终价格 |
| ├─ price | string | 非必须 |  | 商品价格,单位为‘分’  |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ brief | string | 非必须 |  |  简洁的描述  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ item_name | string | 非必须 |  | 商品名称  |
| ├─ pics | string | 非必须 |  |  商品图片  |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级  |
| ├─ goods_id | string | 非必须 |  |  产品ID  |
| ├─ user_id | string | 非必须 |  | 用户id  |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ type | string | 非必须 |  | 类型 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ origincountry_name | string | 非必须 |  | 产地国名称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国国旗 |
| ├─ full_gift_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 赠品ID |
| ├─ promotions | object [] | 非必须 |  |  |
item 类型: object
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ marketing_type | string | 非必须 |  | 促销类型 | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠 |
| ├─ rel_marketing_id | string | 非必须 |  | 关联其他营销id |
| ├─ marketing_name | string | 非必须 |  | 营销活动名称 |
| ├─ marketing_desc | string | 非必须 |  | 营销活动描述 |
| ├─ start_time | string | 非必须 |  | 权益开始时间  |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ release_time | string | 非必须 |  | 活动发布时间 |
| ├─ used_platform | string | 非必须 |  | 适用平台: 0:全场可用,1:只用于pc端,2:小程序端,3:h5端 | 0 商家全场可用|1 只能用于pc|2 只能用于wap|3 只能用于app, 使用平台 |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 | 适用范围: 1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ use_shop | string | 非必须 |  | 适用店铺: 0:全场可用,1:指定店铺可用 |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 适用店铺ID |
| ├─ valid_grade | string | 非必须 |  | 会员级别集合 |
| ├─ condition_type | string | 非必须 |  | 营销条件标准 quantity:按总件数, totalfee:按总金额 |
| ├─ condition_value | object [] | 非必须 |  |  |
item 类型: object
| ├─ full | string | 非必须 |  | 满额条件 |
| ├─ minus | string | 非必须 |  | 折扣 |
| ├─ canjoin_repeat | string | 非必须 |  | 是否上不封顶 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 | 0 包邮|1 商品 |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ check_status | string | 非必须 |  | 促销状态: non-reviewed:未审核,pending:待审核,agree:审核通过,refuse:已拒绝,cancel:已取消,overdue:已过期 |
| ├─ reason | string | 非必须 |  | 原因  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ is_increase_purchase | string | 非必须 |  | 开启加价购，满赠时启用 |
| ├─ company_id | string | 非必须 |  |  公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |   修改时间 |
| ├─ ad_pic | string | 非必须 |  |  活动广告图  |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ in_proportion | string | 非必须 |  | 是否按比例多次赠送 |
| ├─ usedCount | string | 非必须 |  | 使用次数 |
| ├─ condition_rules | string | 非必须 |  | 规则描述 |
| ├─ start_date | string | 非必须 |  | 开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ last_seconds | string | 非必须 |  | 倒计时 |
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ activity_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ type | string | 非必须 |  | 类型 |
| ├─ id | string | 非必须 |  | 活动ID |
| ├─ rule | string | 非必须 |  | 活动规则 |
| ├─ info | string | 非必须 |  | 活动信息 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ activity_type | string | 非必须 |  | 活动类型 | 活动类型 full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购,group拼团,seckill秒杀,package打包,limited_time_sale限时特惠 |
| ├─ used_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ used_activity_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 使用的活动ID |
| ├─ activity_grouping | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 购物车ID |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ activity_id | string | 非必须 |  | 活动ID  |
| ├─ activity_tag | string | 非必须 |  | 活动标签 |
| ├─ condition_rules | string | 非必须 |  | 活动描述 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ vipgrade_guide_title | object | 非必须 |  |  |
| ├─ guide_title_desc | string | 非必须 |  | 开通vip的引导文本 |
| ├─ gift_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ discount_desc | object | 非必须 |  |  |
| ├─ type | string | 非必须 |  | 促销类型 |
| ├─ id | string | 非必须 |  | 促销活动ID |
| ├─ rule | string | 非必须 |  | 促销规则 |
| ├─ info | string | 非必须 |  | 促销规则描述 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ max_limit | string | 非必须 |  | 可参与次数 |
| ├─ activity_id | string | 非必须 |  | 活动ID  |
| ├─ gifts | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ item_name | string | 非必须 |  | 商品名称  |
| ├─ price | string | 非必须 |  | 价格,单位为‘分’  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ gift_num | string | 非必须 |  | 赠品数量 |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ without_return | string | 非必须 |  | 退货无需退回赠品 |
| ├─ filter_full | string | 非必须 |  | 赠品满足所需条件 |
| ├─ item_spec_desc | string | 非必须 |  |  商品规格描述 |
| ├─ company_id | string | 非必须 |  | 公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |  修改时间 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  |  销售额 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  | 返佣金额,单位为‘分’ |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 返佣设置 |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 消费积分  |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  |  商品id |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码  |
| ├─ brief | string | 非必须 |  |  简洁的描述  |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  |  排序  |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  |  商品是否为默认商品  |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID | 默认商品id |
| ├─ distributor_id | string | 非必须 |  | 门店id, 0是所有门店 |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 | 有效期的类型 | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间  |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  |  税率, 百分之～/100  |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 | 审核状态，其中0为审核成功，1为审核失败，2为审核中, 3为待提交审核 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 1 拉新分润 2 推广提成 3 货款 4 补贴 | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) | 分佣计算方式 | 分佣计算方式 0商品不设置默认分润,1按照比例分润,2按照填写金额分润 | 分润类型 1 总部分润 2 自营门店分润 3 加盟门店分润 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  | 类型 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 货号 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | string | 非必须 |  | 主类目ID |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 标签 |
| ├─ item_spec | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ spec_id | string | 非必须 |  | 规格ID |
| ├─ spec_value_id | string | 非必须 |  | 规格值ID |
| ├─ spec_name | string | 非必须 |  | 规格名称 |
| ├─ spec_custom_value_name | string | 非必须 |  | 自定义规格值 |
| ├─ spec_value_name | string | 非必须 |  | 规格值 |
| ├─ item_image_url | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ spec_image_url | string | 非必须 |  | 规格图片url |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ activity_item_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 活动商品ID |
| ├─ plus_buy_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ discount_desc | object | 非必须 |  |  |
| ├─ type | string | 非必须 |  | 活动类型 |
| ├─ id | string | 非必须 |  | 活动ID |
| ├─ rule | string | 非必须 |  | 活动规则 |
| ├─ info | string | 非必须 |  | 活动介绍 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ max_limit | string | 非必须 |  | 可参与次数 |
| ├─ plus_price | string | 非必须 |  | 加价购金额 |
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ plus_buy_items | object | 非必须 |  |  |
| ├─ 5445 | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | 商品ID |
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ item_name | string | 非必须 |  | 商品名称 | 商品标题 | 订单标题 |
| ├─ price | string | 非必须 |  | 商品价格 | 价格,单位为‘分’  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ gift_num | string | 非必须 |  | 赠品数量 |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ without_return | string | 非必须 |  | 退货无需退回赠品 |
| ├─ filter_full | string | 非必须 |  | 赠品满足所需条件 |
| ├─ item_spec_desc | string | 非必须 |  | 产品规格描述 | 商品规格描述 |
| ├─ company_id | string | 非必须 |  | 公司id | 公司ID |  | 企业id | 商户id | 企业ID | 公司company id | company_id | 公司_ID | 公司Id | 公司 company id | 企业company id | 商家id | 公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  | 修改时间 |
| ├─ plus_price | string | 非必须 |  | 加价购金额 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  | 商品销量 | 销量 | 销售额 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  | 单个分销金额，以分为单位 | 推广商品 1已选择 0未选择 2申请加入 3拒绝 | 返佣金额,单位为‘分’ |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 返佣设置 |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 提现积分 | 积分个数 | 积分 | 消费积分 | 积分兑换价格 | 商品总积分 |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  | 商品集合ID | 产品ID | 商品ID | 关联商品id | 商品id |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码 | 商品编号 |
| ├─ brief | string | 非必须 |  | 图片简介 | 简洁的描述 | 推广店铺描述 |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 地区id(DC2Type:json_array) | 地区编号集合(DC2Type:json_array) | 国家行政区划编码组合，逗号隔开 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  | 商品排序 | 文章排序 | 排序 | 商品属性排序，越大越在前 | 排序，数字越大越靠前 |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  | 是否默认货币 | 门店id | 默认地址, 1:是。2:不是 | 商品是否为默认商品 | 购买引导文本 | 是否是默认门店 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID | 默认商品id |
| ├─ distributor_id | string | 非必须 |  | 分销商id | 店铺id | 经销商ID |  | 上线店铺ID | 关联店铺 | 店铺id,为0时表示该商品为商城商品，否则为店铺自有商品 | 店铺ID | 拉新门店id | 店铺ID, 多个逗号隔开 | 门店id, 0是所有门店 | 门店id | 门店ID | 门店所属店铺ID |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 | 有效期的类型 | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 | 会员到期时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  | 税率 | 税率, 百分之～/100 | 商品税率 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 | 审核状态，其中0为审核成功，1为审核失败，2为审核中, 3为待提交审核 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 1 拉新分润 2 推广提成 3 货款 4 补贴 | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) | 分佣计算方式 | 分佣计算方式 0商品不设置默认分润,1按照比例分润,2按照填写金额分润 | 分润类型 1 总部分润 2 自营门店分润 3 加盟门店分润 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  | 打印机类型 yilianyun 易连云 | type 1全部数据 2平台数据 3非平台数据 | 商品类型，0普通，1跨境商品，可扩展 | 订单类型，0普通订单,1跨境订单,....其他 | 营销类型: shop:店铺额外积分,birthday:会员生日,item:商品额外积分 | 公告类型。可选值有 notice-公告;helper-店主助手 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 货号 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | string | 非必须 |  | 主类目ID |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 标签 |
| ├─ activity_item_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 活动商品ID |
| ├─ invalid_cart | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_id | string | 非必须 |  | 购物车ID | ID |
| ├─ salesperson_id | string | 非必须 |  | 导购员id | 导购id | 导购员 | 导购员ID | 店铺管理员id | 门店人员ID |
| ├─ item_id | string | 非必须 |  | 商品id | 商品ID | 商品 | 筛选id(按item_type区分为商品ID,标签ID等) | 关联货品id | 限购活动商品id | 活动商品id | 关联商品id | 秒杀活动商品id | 评论id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 售后数量 | 社区人数 | 限购参加活动次数 | 商品数量 | 购买商品数量 | 数值属性值，例如买了50个次卡，就是填50；赠送了10个经验，就是填10 | 发货数量 | 销售数量 | 预约数量 |
| ├─ company_id | string | 非必须 |  | 公司id | 公司ID |  | 企业id | 商户id | 企业ID | 公司company id | company_id | 公司_ID | 公司Id | 公司 company id | 企业company id | 商家id | 公司id，company_id为0的时候表示通用 |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  | 分销商id | 店铺id | 经销商ID |  | 上线店铺ID | 关联店铺 | 店铺id,为0时表示该商品为商城商品，否则为店铺自有商品 | 店铺ID | 拉新门店id | 店铺ID, 多个逗号隔开 | 门店id, 0是所有门店 | 门店id | 门店ID | 门店所属店铺ID |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ shop_id | string | 非必须 |  | 门店id | 店铺id | 门店ID | 店铺ID，如果为0则表示总部 |  | 店铺id 或者 社区id | 公司门店 id | 公司id |
| ├─ is_check_store | string | 非必须 |  | 是否检查过库存 |
获取导购员购物车
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/cartdatalist
Method： GET
接口描述：
获取导购员购物车
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| user_id
| 否
|
| 会员id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ valid_cart | object [] | 非必须 |  |  |
item 类型: object
| ├─ shop_name | string | 非必须 |  | 门店名称  |
| ├─ address | string | 非必须 |  | 店铺地址  |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ shop_id | string | 非必须 |  | 店铺ID，如果为0则表示总部 |
| ├─ cart_total_price | string | 非必须 |  | 商品总金额，以分为单位 |
| ├─ item_fee | string | 非必须 |  | 商品金额，以分为单位 |
| ├─ cart_total_num | string | 非必须 |  | 商品数量 |
| ├─ cart_total_count | string | 非必须 |  | 总金额，以分为单位 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位 |
| ├─ total_fee | string | 非必须 |  | 应付总金额,以分为单位 |
| ├─ member_discount | string | 非必须 |  | 会员折扣金额，以分为单位 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_id | string | 非必须 |  | 购物车ID  |
| ├─ salesperson_id | string | 非必须 |  | 导购员id  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 购买商品数量 |
| ├─ company_id | string | 非必须 |  | 公司id，company_id为0的时候表示通用 |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  |  店铺id  |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ shop_id | string | 非必须 |  | 门店id  |
| ├─ is_last_price | string | 非必须 |  | 是否最终价格 |
| ├─ price | string | 非必须 |  | 商品价格,单位为‘分’  |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ total_fee | string | 非必须 |  | 订单金额，以分为单位  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ brief | string | 非必须 |  |  简洁的描述  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ item_name | string | 非必须 |  | 商品名称  |
| ├─ pics | string | 非必须 |  |  商品图片  |
| ├─ item_spec_desc | string | 非必须 |  | 商品规格描述 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级  |
| ├─ goods_id | string | 非必须 |  |  产品ID  |
| ├─ user_id | string | 非必须 |  | 用户id  |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ type | string | 非必须 |  | 类型 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ origincountry_name | string | 非必须 |  | 产地国名称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国国旗 |
| ├─ full_gift_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 赠品ID |
| ├─ promotions | object [] | 非必须 |  |  |
item 类型: object
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ marketing_type | string | 非必须 |  | 促销类型 | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购 | 营销类型: full_discount:满折,full_minus:满减,full_gift:满赠 |
| ├─ rel_marketing_id | string | 非必须 |  | 关联其他营销id |
| ├─ marketing_name | string | 非必须 |  | 营销活动名称 |
| ├─ marketing_desc | string | 非必须 |  | 营销活动描述 |
| ├─ start_time | string | 非必须 |  | 权益开始时间  |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ release_time | string | 非必须 |  | 活动发布时间 |
| ├─ used_platform | string | 非必须 |  | 适用平台: 0:全场可用,1:只用于pc端,2:小程序端,3:h5端 | 0 商家全场可用|1 只能用于pc|2 只能用于wap|3 只能用于app, 使用平台 |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 | 适用范围: 1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ use_shop | string | 非必须 |  | 适用店铺: 0:全场可用,1:指定店铺可用 |
| ├─ shop_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 适用店铺ID |
| ├─ valid_grade | string | 非必须 |  | 会员级别集合 |
| ├─ condition_type | string | 非必须 |  | 营销条件标准 quantity:按总件数, totalfee:按总金额 |
| ├─ condition_value | object [] | 非必须 |  |  |
item 类型: object
| ├─ full | string | 非必须 |  | 满额条件 |
| ├─ minus | string | 非必须 |  | 折扣 |
| ├─ canjoin_repeat | string | 非必须 |  | 是否上不封顶 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ free_postage | string | 非必须 |  | 是否免邮 | 0 包邮|1 商品 |
| ├─ promotion_tag | string | 非必须 |  | 促销标签 |
| ├─ check_status | string | 非必须 |  | 促销状态: non-reviewed:未审核,pending:待审核,agree:审核通过,refuse:已拒绝,cancel:已取消,overdue:已过期 |
| ├─ reason | string | 非必须 |  | 原因  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ is_increase_purchase | string | 非必须 |  | 开启加价购，满赠时启用 |
| ├─ company_id | string | 非必须 |  |  公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |   修改时间 |
| ├─ ad_pic | string | 非必须 |  |  活动广告图  |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ in_proportion | string | 非必须 |  | 是否按比例多次赠送 |
| ├─ usedCount | string | 非必须 |  | 使用次数 |
| ├─ condition_rules | string | 非必须 |  | 规则描述 |
| ├─ start_date | string | 非必须 |  | 开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ last_seconds | string | 非必须 |  | 倒计时 |
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ activity_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ type | string | 非必须 |  | 类型 |
| ├─ id | string | 非必须 |  | 活动ID |
| ├─ rule | string | 非必须 |  | 活动规则 |
| ├─ info | string | 非必须 |  | 活动信息 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ activity_type | string | 非必须 |  | 活动类型 | 活动类型 full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购,group拼团,seckill秒杀,package打包,limited_time_sale限时特惠 |
| ├─ used_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ used_activity_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 使用的活动ID |
| ├─ activity_grouping | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 购物车ID |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ activity_id | string | 非必须 |  | 活动ID  |
| ├─ activity_tag | string | 非必须 |  | 活动标签 |
| ├─ condition_rules | string | 非必须 |  | 活动描述 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ vipgrade_guide_title | object | 非必须 |  |  |
| ├─ guide_title_desc | string | 非必须 |  | 开通vip的引导文本 |
| ├─ gift_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ discount_desc | object | 非必须 |  |  |
| ├─ type | string | 非必须 |  | 促销类型 |
| ├─ id | string | 非必须 |  | 促销活动ID |
| ├─ rule | string | 非必须 |  | 促销规则 |
| ├─ info | string | 非必须 |  | 促销规则描述 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ max_limit | string | 非必须 |  | 可参与次数 |
| ├─ activity_id | string | 非必须 |  | 活动ID  |
| ├─ gifts | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ item_name | string | 非必须 |  | 商品名称  |
| ├─ price | string | 非必须 |  | 价格,单位为‘分’  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ gift_num | string | 非必须 |  | 赠品数量 |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ without_return | string | 非必须 |  | 退货无需退回赠品 |
| ├─ filter_full | string | 非必须 |  | 赠品满足所需条件 |
| ├─ item_spec_desc | string | 非必须 |  |  商品规格描述 |
| ├─ company_id | string | 非必须 |  | 公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |  修改时间 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  |  销售额 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  | 返佣金额,单位为‘分’ |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 返佣设置 |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 消费积分  |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  |  商品id |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码  |
| ├─ brief | string | 非必须 |  |  简洁的描述  |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  |  排序  |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  |  商品是否为默认商品  |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID | 默认商品id |
| ├─ distributor_id | string | 非必须 |  | 门店id, 0是所有门店 |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 | 有效期的类型 | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间  |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  |  税率, 百分之～/100  |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 | 审核状态，其中0为审核成功，1为审核失败，2为审核中, 3为待提交审核 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 1 拉新分润 2 推广提成 3 货款 4 补贴 | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) | 分佣计算方式 | 分佣计算方式 0商品不设置默认分润,1按照比例分润,2按照填写金额分润 | 分润类型 1 总部分润 2 自营门店分润 3 加盟门店分润 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  | 类型 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 货号 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | string | 非必须 |  | 主类目ID |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 标签 |
| ├─ item_spec | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ spec_id | string | 非必须 |  | 规格ID |
| ├─ spec_value_id | string | 非必须 |  | 规格值ID |
| ├─ spec_name | string | 非必须 |  | 规格名称 |
| ├─ spec_custom_value_name | string | 非必须 |  | 自定义规格值 |
| ├─ spec_value_name | string | 非必须 |  | 规格值 |
| ├─ item_image_url | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ spec_image_url | string | 非必须 |  | 规格图片url |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ activity_item_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 活动商品ID |
| ├─ plus_buy_activity | object [] | 非必须 |  |  |
item 类型: object
| ├─ discount_desc | object | 非必须 |  |  |
| ├─ type | string | 非必须 |  | 活动类型 |
| ├─ id | string | 非必须 |  | 活动ID |
| ├─ rule | string | 非必须 |  | 活动规则 |
| ├─ info | string | 非必须 |  | 活动介绍 |
| ├─ discount_fee | string | 非必须 |  | 订单优惠金额，以分为单位  |
| ├─ max_limit | string | 非必须 |  | 可参与次数 |
| ├─ plus_price | string | 非必须 |  | 加价购金额 |
| ├─ activity_id | string | 非必须 |  | 活动ID   |
| ├─ plus_buy_items | object | 非必须 |  |  |
| ├─ 5445 | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | 商品ID |
| ├─ marketing_id | string | 非必须 |  | 促销id  |
| ├─ item_id | string | 非必须 |  | 商品id  |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品  |
| ├─ item_name | string | 非必须 |  | 商品名称 | 商品标题 | 订单标题 |
| ├─ price | string | 非必须 |  | 商品价格 | 价格,单位为‘分’  |
| ├─ store | string | 非必须 |  | 商品库存  |
| ├─ gift_num | string | 非必须 |  | 赠品数量 |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 图片url |
| ├─ without_return | string | 非必须 |  | 退货无需退回赠品 |
| ├─ filter_full | string | 非必须 |  | 赠品满足所需条件 |
| ├─ item_spec_desc | string | 非必须 |  | 产品规格描述 | 商品规格描述 |
| ├─ company_id | string | 非必须 |  | 公司id | 公司ID |  | 企业id | 商户id | 企业ID | 公司company id | company_id | 公司_ID | 公司Id | 公司 company id | 企业company id | 商家id | 公司id，company_id为0的时候表示通用 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  | 修改时间 |
| ├─ plus_price | string | 非必须 |  | 加价购金额 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  | 商品销量 | 销量 | 销售额 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  | 单个分销金额，以分为单位 | 推广商品 1已选择 0未选择 2申请加入 3拒绝 | 返佣金额,单位为‘分’ |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 返佣设置 |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 提现积分 | 积分个数 | 积分 | 消费积分 | 积分兑换价格 | 商品总积分 |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  | 商品集合ID | 产品ID | 商品ID | 关联商品id | 商品id |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码 | 商品编号 |
| ├─ brief | string | 非必须 |  | 图片简介 | 简洁的描述 | 推广店铺描述 |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 地区id(DC2Type:json_array) | 地区编号集合(DC2Type:json_array) | 国家行政区划编码组合，逗号隔开 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  | 商品排序 | 文章排序 | 排序 | 商品属性排序，越大越在前 | 排序，数字越大越靠前 |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  | 是否默认货币 | 门店id | 默认地址, 1:是。2:不是 | 商品是否为默认商品 | 购买引导文本 | 是否是默认门店 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID | 默认商品id |
| ├─ distributor_id | string | 非必须 |  | 分销商id | 店铺id | 经销商ID |  | 上线店铺ID | 关联店铺 | 店铺id,为0时表示该商品为商城商品，否则为店铺自有商品 | 店铺ID | 拉新门店id | 店铺ID, 多个逗号隔开 | 门店id, 0是所有门店 | 门店id | 门店ID | 门店所属店铺ID |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 | 有效期的类型 | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 分佣计算方式 | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 | 会员到期时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  | 税率 | 税率, 百分之～/100 | 商品税率 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 | 跨境订单审核状态 approved成功 processing审核中 rejected审核拒绝 | 审核状态，其中0为审核成功，1为审核失败，2为审核中, 3为待提交审核 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 1 拉新分润 2 推广提成 3 货款 4 补贴 | 分润类型, 默认为0配置分润,1主类目分润,2商品指定分润(比例),3商品指定分润(金额) | 分佣计算方式 | 分佣计算方式 0商品不设置默认分润,1按照比例分润,2按照填写金额分润 | 分润类型 1 总部分润 2 自营门店分润 3 加盟门店分润 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  | 打印机类型 yilianyun 易连云 | type 1全部数据 2平台数据 3非平台数据 | 商品类型，0普通，1跨境商品，可扩展 | 订单类型，0普通订单,1跨境订单,....其他 | 营销类型: shop:店铺额外积分,birthday:会员生日,item:商品额外积分 | 公告类型。可选值有 notice-公告;helper-店主助手 |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 货号 |
| ├─ companyId | string | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | string | 非必须 |  | 主类目ID |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 标签 |
| ├─ activity_item_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 活动商品ID |
| ├─ invalid_cart | object [] | 非必须 |  |  |
item 类型: object
| ├─ cart_id | string | 非必须 |  | 购物车ID | ID |
| ├─ salesperson_id | string | 非必须 |  | 导购员id | 导购id | 导购员 | 导购员ID | 店铺管理员id | 门店人员ID |
| ├─ item_id | string | 非必须 |  | 商品id | 商品ID | 商品 | 筛选id(按item_type区分为商品ID,标签ID等) | 关联货品id | 限购活动商品id | 活动商品id | 关联商品id | 秒杀活动商品id | 评论id |
| ├─ package_items | string | 非必须 |  | 关联商品id集合 |
| ├─ num | string | 非必须 |  | 售后数量 | 社区人数 | 限购参加活动次数 | 商品数量 | 购买商品数量 | 数值属性值，例如买了50个次卡，就是填50；赠送了10个经验，就是填10 | 发货数量 | 销售数量 | 预约数量 |
| ├─ company_id | string | 非必须 |  | 公司id | 公司ID |  | 企业id | 商户id | 企业ID | 公司company id | company_id | 公司_ID | 公司Id | 公司 company id | 企业company id | 商家id | 公司id，company_id为0的时候表示通用 |
| ├─ is_checked | string | 非必须 |  | 购物车是否选中 |
| ├─ distributor_id | string | 非必须 |  | 分销商id | 店铺id | 经销商ID |  | 上线店铺ID | 关联店铺 | 店铺id,为0时表示该商品为商城商品，否则为店铺自有商品 | 店铺ID | 拉新门店id | 店铺ID, 多个逗号隔开 | 门店id, 0是所有门店 | 门店id | 门店ID | 门店所属店铺ID |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ shop_id | string | 非必须 |  | 门店id | 店铺id | 门店ID | 店铺ID，如果为0则表示总部 |  | 店铺id 或者 社区id | 公司门店 id | 公司id |
| ├─ is_check_store | string | 非必须 |  | 是否检查过库存 |
获取导购店铺列表
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/distributorlist
Method： GET
接口描述：
获取导购店铺列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 页数
| pageSize
| 是
|
| 每页数量
| store_type
| 是
|
| 店铺类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ salesperson_id | string | 非必须 |  | 导购员ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ store_type | string | 非必须 |  | 店铺类型 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ distributor_id | string | 非必须 |  | 店铺ID |
| ├─ shop_logo | string | 非必须 |  | 店铺Logo图片地址 |
| ├─ hour | string | 非必须 |  | 营业时间 |
获取导购签到二维码
基本信息
Path： /api/h5app/h5app/wxapp/salesperson/signinQrcode
Method： GET
接口描述：
获取导购签到二维码
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 否
|
| 导购员ID
| type
| 是
|
| 操作类型: signin/signout
| distributor_id
| 是
|
| 分销商ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ base64Image | string | 非必须 |  | base64编码图片 |
| ├─ access_token | string | 非必须 |  | access_token |
获取导购购物车商品数量
基本信息
Path： /api/h5app/wxapp/salesperson/cartcount
Method： GET
接口描述：
获取导购购物车商品数量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 数据集合 |
| ├─ cart_count | integer | 非必须 |  | 购物车数量 |
| ├─ item_count | integer | 非必须 |  | 商品数量 |
验证导购员的店铺id是否有效
基本信息
Path： /api/h5app/wxapp/salesperson/distributor/is_valid
Method： GET
接口描述：
验证导购员的店铺id是否有效
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| salesperson_id
| 是
|
| 导购id
| distributor_id
| 是
|
| 店铺id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 校验结果 |
报名
报名提交
基本信息
Path： /api/h5app/h5app/wxapp/registrationSubmit
Method： POST
接口描述：
报名提交
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| activity_id
| 是
|
| 活动id
| formdata[content]
| 是
|
| 报名内容(json)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ record_id | string | 非必须 |  | 记录id |
| ├─ activity_id | string | 非必须 |  | 活动ID |
| ├─ user_id | string | 非必须 |  | 用户id  |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ wxapp_appid | string | 非必须 |  | 会员小程序appid |
| ├─ open_id | string | 非必须 |  | 用户open_id |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ content | object [] | 非必须 |  |  |
item 类型: object
| ├─ title | string | 非必须 |  | 名称 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ formdata | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id  |
| ├─ field_title | string | 非必须 |  | 表单项标题(中文描述) |
| ├─ field_name | string | 非必须 |  | 表单项英文名称(英文或拼音描述),唯一标示 |
| ├─ form_element | string | 非必须 |  | 表单元素,text:文本,textarea:文本域,select:选择框,radio:单选,checkbox:多选框,date:日期选择,time:时间选择,area:地区地址选择, image:图片上传,number:纯数字 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ options | string | 非必须 |  | 表单元素为选择类时选择项（json）当form_element in (select, radio, checkbox)时，此项必填 |
| ├─ answer | string | 非必须 |  | 回答内容 |
| ├─ reason | string | 非必须 |  | 审核不通过原因 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  |  修改时间 |
| ├─ company_id | string | 非必须 |  | 公司id |
获取所有记录的日期列表
基本信息
Path： /api/h5app/h5app/wxapp/selfform/physical/datelist
Method： GET
接口描述：
获取所有记录的日期列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 页码
| pageSize
| 是
|
| 单页数量
| form_type
| 是
|
| 表单类型(默认为physical:体测报告表单)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ record_date | string | 非必须 |  | 记录提交日期 |
| ├─ record_date_str | string | 非必须 |  | 日期 |
| ├─ total_count | string | 非必须 |  | 总数 |
获取指定报名日志
基本信息
Path： /api/h5app/h5app/wxapp/registrationRecordList
Method： GET
接口描述：
获取指定报名日志
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| activity_id
| 是
|
| 活动ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ record_id | string | 非必须 |  | 记录id |
| ├─ activity_id | string | 非必须 |  | 活动ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ mobile | string | 非必须 |  | 用户手机号 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ content | object [] | 非必须 |  |  |
item 类型: object
| ├─ title | string | 非必须 |  | 活动名称 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ formdata | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id  |
| ├─ field_title | string | 非必须 |  | 表单项标题(中文描述) |
| ├─ field_name | string | 非必须 |  | 表单项英文名称(英文或拼音描述),唯一标示 |
| ├─ form_element | string | 非必须 |  | 表单元素,text:文本,textarea:文本域,select:选择框,radio:单选,checkbox:多选框,date:日期选择,time:时间选择,area:地区地址选择, image:图片上传,number:纯数字 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ options | string | 非必须 |  | 表单元素为选择类时选择项（json）当form_element in (select, radio, checkbox)时，此项必填 |
| ├─ answer | string | 非必须 |  | 回答内容 |
| ├─ reason | string | 非必须 |  | 审核不通过原因 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ wxapp_appid | string | 非必须 |  | 会员小程序appid |
| ├─ open_id | string | 非必须 |  | 用户open_id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ created_date | string | 非必须 |  | 创建时间 |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ start_date | string | 非必须 |  | 开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间  |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ is_sms_notice | string | 非必须 |  | 是否短信通知 |
| ├─ is_wxapp_notice | string | 非必须 |  | 是否小程序模板通知 |
| ├─ create_date | string | 非必须 |  | 创建时间 |
获取指定报名日志
基本信息
Path： /api/h5app/h5app/wxapp/registrationRecordInfo
Method： GET
接口描述：
获取指定报名日志
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| record_id
| 是
|
| 记录ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 报名活动信息 |
| ├─ record_id | string | 非必须 |  | 记录id |
| ├─ activity_id | string | 非必须 |  | 活动ID |
| ├─ user_id | string | 非必须 |  | 用户id |
| ├─ mobile | string | 非必须 |  | 用户手机号 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ content | object [] | 非必须 |  |  |
item 类型: object
| ├─ title | string | 非必须 |  | 活动名称 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ formdata | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id  |
| ├─ field_title | string | 非必须 |  | 表单项标题(中文描述) |
| ├─ field_name | string | 非必须 |  | 表单项英文名称(英文或拼音描述),唯一标示 |
| ├─ form_element | string | 非必须 |  | 表单元素,text:文本,textarea:文本域,select:选择框,radio:单选,checkbox:多选框,date:日期选择,time:时间选择,area:地区地址选择, image:图片上传,number:纯数字 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ options | string | 非必须 |  | 表单元素为选择类时选择项（json）当form_element in (select, radio, checkbox)时，此项必填 |
| ├─ answer | string | 非必须 |  | 回答内容 |
| ├─ reason | string | 非必须 |  | 审核不通过原因 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ wxapp_appid | string | 非必须 |  | 会员小程序appid |
| ├─ open_id | string | 非必须 |  | 用户open_id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ created_date | string | 非必须 |  | 创建时间 |
| ├─ activity_name | string | 非必须 |  | 活动名称  |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ start_date | string | 非必须 |  | 开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间  |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ is_sms_notice | string | 非必须 |  | 是否短信通知 |
| ├─ is_wxapp_notice | string | 非必须 |  | 是否小程序模板通知 |
| ├─ create_date | string | 非必须 |  | 创建时间 |
获取指定报名活动
基本信息
Path： /api/h5app/h5app/wxapp/registrationActivity
Method： GET
接口描述：
获取指定报名活动
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| activity_id
| 是
|
| 活动id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 活动状态 |
| ├─ activity_info | object | 非必须 |  |  |
| ├─ activity_id | string | 非必须 |  | 活动ID |
| ├─ temp_id | string | 非必须 |  | 表单模板id |
| ├─ activity_name | string | 非必须 |  | 活动名称 |
| ├─ start_time | string | 非必须 |  | 活动开始时间 |
| ├─ end_time | string | 非必须 |  | 活动结束时间 |
| ├─ join_limit | string | 非必须 |  | 可参与次数 |
| ├─ is_sms_notice | string | 非必须 |  | 是否短信通知 |
| ├─ is_wxapp_notice | string | 非必须 |  | 是否小程序模板通知 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ formdata | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tem_name | string | 非必须 |  | 表单模板名称 |
| ├─ status | string | 非必须 |  | 状态 |
| ├─ form_style | string | 非必须 |  | 表单关键指数, single:单页问卷, multiple:多页问卷 |
| ├─ header_link_title | string | 非必须 |  | 头部文字 |
| ├─ header_title | string | 非必须 |  | 头部文字内容 |
| ├─ bottom_title | string | 非必须 |  | 表单关键指数 |
| ├─ key_index | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | key_index |
| ├─ tem_type | string | 非必须 |  | 表单模板类型；ask_answer_paper：问答考卷，basic_entry：基础录入 |
| ├─ content | object [] | 非必须 |  |  |
item 类型: object
| ├─ title | string | 非必须 |  | 标题 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ formdata | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ field_title | string | 非必须 |  | 表单项标题(中文描述) |
| ├─ field_name | string | 非必须 |  | 表单项英文名称(英文或拼音描述),唯一标示 |
| ├─ form_element | string | 非必须 |  | 表单元素,text:文本,textarea:文本域,select:选择框,radio:单选,checkbox:多选框,date:日期选择,time:时间选择,area:地区地址选择, image:图片上传,number:纯数字 |
| ├─ status | string | 非必须 |  | 自行更改字段描述 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_required | string | 非必须 |  | 是否必填 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ options | string | 非必须 |  | 表单元素为选择类时选择项（json）当form_element in (select, radio, checkbox)时，此项必填 |
获取指定时间段内的数据统计数据
基本信息
Path： /api/h5app/h5app/wxapp/selfform/statisticalAnalysis
Method： GET
接口描述：
获取指定时间段内的数据统计数据
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| days
| 是
|
| 天数
| user_id
| 是
|
| 用户ID
| timeChoosed
| 是
|
| 日期(Ymd)
| form_type
| 否
|
| 表单类型(physical)
| shop_id
| 否
|
| 店铺ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ fieldname | string | 非必须 |  | 字段名 |
| ├─ fieldkey | string | 非必须 |  | 字段Key |
| ├─ fieldvalue | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 字段值 |
| ├─ thisweek | string | 非必须 |  | 本周数据 |
| ├─ lastweek | string | 非必须 |  | 上周数据 |
| ├─ keyindex | object [] | 非必须 |  |  |
item 类型: object
| ├─ fieldvalue | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 字段值 |
| ├─ fieldname | string | 非必须 |  | 字段名 |
| ├─ fieldkey | string | 非必须 |  | 字段Key |
| ├─ thisweek | string | 非必须 |  | 本周数据 |
| ├─ lastweek | string | 非必须 |  | 上周数据 |
模板
会员中心分享信息
基本信息
Path： /api/h5app/wxapp/memberCenterShare/getInfo
Method： GET
接口描述：
会员中心分享信息
请求参数
路径参数
参数名称
示例
备注
| company_id
|
| 公司id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  | 数据集合 |
| ├─ theme_member_center_share_id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  | 公司id |
| ├─ share_title | string | 非必须 |  | 分享标题 |
| ├─ share_description | string | 非必须 |  | 分享描述 |
| ├─ share_pic_wechatapp | string | 非必须 |  | 分享图片小程序 |
| ├─ share_pic_h5 | string | 非必须 |  | 分享图片h5 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 最后修改时间 |
小程序模板设置信息
基本信息
Path： /api/h5app/h5app/wxapp/pagestemplate/setInfo
Method： GET
接口描述：
小程序模板设置信息
请求参数
Query
参数名称
是否必须
示例
备注
| company_id
| 是
|
| company_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | integer | 非必须 |  |  |
| ├─ company_id | integer | 非必须 |  |  |
| ├─ index_type | integer | 非必须 |  |  |
| ├─ is_enforce_sync | integer | 非必须 |  |  |
| ├─ is_open_recommend | integer | 非必须 |  |  |
| ├─ is_open_wechatapp_location | integer | 非必须 |  |  |
| ├─ is_open_scan_qrcode | integer | 非必须 |  |  |
小程序模板详情
基本信息
Path： /api/h5app/h5app/wxapp/pagestemplate/detail
Method： GET
接口描述：
小程序模板详情
请求参数
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 店铺id
| weapp_pages
| 否
|
| 小程序页面类型
| template_name
| 是
|
| 模板名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ content | string | 非必须 |  |  |
| ├─ tabBar | string | 非必须 |  |  |
小程序模板详情
基本信息
Path： /api/h5app/h5app/wxapp/pagestemplate/shopDetail
Method： GET
接口描述：
小程序模板详情
请求参数
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 店铺id
| template_name
| 是
|
| 模板名称
| weapp_pages
| 否
|
| 小程序页面类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ template_name | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
| ├─ page_name | string | 非必须 |  |  |
| ├─ params | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
| ├─ base | object | 非必须 |  |  |
| ├─ padded | string | 非必须 |  |  |
| ├─ config | object | 非必须 |  |  |
| ├─ fixTop | string | 非必须 |  |  |
| ├─ scanCode | string | 非必须 |  |  |
| ├─ config | object [] | 非必须 |  |  |
item 类型: object
| ├─ name | string | 非必须 |  |  |
| ├─ base | object | 非必须 |  |  |
| ├─ padded | string | 非必须 |  |  |
| ├─ config | object | 非必须 |  |  |
| ├─ fixTop | string | 非必须 |  |  |
| ├─ scanCode | string | 非必须 |  |  |
开屏广告信息
基本信息
Path： /api/h5app/h5app/wxapp/openscreenad
Method： GET
接口描述：
开屏广告信息
请求参数
路径参数
参数名称
示例
备注
| company_id
|
| 公司id
返回数据
名称类型是否必须默认值备注其他信息
|   |  | 非必须 |  |  |
获取pc模板头尾部
基本信息
Path： /api/h5app/h5app/wxapp/pctemplate/getHeaderOrFooter
Method： GET
接口描述：
获取pc模板头尾部
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page_name
| 是
|
| 页面名称
| company_id
| 是
|
| 公司编号
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ company_id | int | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
| ├─ params | string | 非必须 |  |  |
| ├─ theme_pc_template_content_id | int | 非必须 |  |  |
| ├─ theme_pc_template_id | int | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
获取pc模板页面内容
基本信息
Path： /api/h5app/h5app/wxapp/pctemplate/getTemplateContent
Method： GET
接口描述：
获取pc模板页面内容
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| theme_pc_template_id
| 是
|
| 主题PC模板ID
| company_id
| 是
|
| 公司编号
返回数据
名称类型是否必须默认值备注其他信息
|  data | array [] | 非必须 |  |  |
item 类型: array
| ├─  |  | 非必须 |  |  |
| ├─ config | string | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
获取全局tdk设置信息
基本信息
Path： /api/h5app/h5app/wxapp/pagestemplate/getTdk
Method： GET
接口描述：
获取全局tdk设置信息
请求参数
Query
参数名称
是否必须
示例
备注
| company_id
| 是
|
| company_id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  |  |
| ├─ mate_description | string | 非必须 |  |  |
| ├─ mate_keywords | string | 非必须 |  |  |
| ├─ update_time | string | 非必须 |  | 更新时间 |
微信
获取小程序分享配置信息
基本信息
Path： /api/h5app/h5app/wxapp/share/setting
Method： GET
接口描述：
获取小程序分享配置信息
请求参数
Query
参数名称
是否必须
示例
备注
| shareindex
| 是
|
| 分享类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ desc | string | 非必须 |  | 描述 |
| ├─ imageUrl | string | 非必须 |  | 图片网址 |
小程序oauth授权登录
基本信息
Path： /api/h5app/h5app/wxapp/oauthlogin
Method： GET
接口描述：
小程序oauth授权登录
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 是
|
| 登录时获取的 code
| appid
| 是
|
| 小程序唯一标识
返回数据
成功返回结构
小程序oauth授权登录确认
基本信息
Path： /api/h5app/h5app/wxapp/oauth/login/authorize
Method： GET
接口描述：
小程序oauth授权登录确认
请求参数
Query
参数名称
是否必须
示例
备注
| token
| 是
|
| 扫码获取的token
| code
| 是
|
| 登录时获取的 code
| appid
| 是
|
| 小程序唯一标识
| status
| 是
|
| 小程序确认授权 1 取消授权 0
返回数据
成功返回结构
小程序静默授权获取openid和unionid
基本信息
Path： /api/h5app/h5app/wxapp/getopenid
Method： POST
接口描述：
小程序静默授权获取openid和unionid
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| code
| 是
|
| 登录时获取的 code
| appid
| 是
|
| 小程序唯一标识
返回数据
成功返回结构
根据share_id获取参数
基本信息
Path： /api/h5app/wxapp/getbyshareid
Method： GET
接口描述：
根据share_id获取参数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| share_id
| 是
|
| 分享id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
第三方预登录
基本信息
Path： /api/h5app/h5app/wxapp/prelogin
Method： GET
接口描述：
第三方预登录
请求参数
Query
参数名称
是否必须
示例
备注
| code
| 是
|
| 登录时获取的 code
| appid
| 是
|
| 第三方appid
返回数据
成功返回结构
获取小程序会员中心配置信息
基本信息
Path： /api/h5app/h5app/wxapp/membercenter/setting
Method： GET
接口描述：
获取小程序会员中心配置信息
请求参数
Query
参数名称
是否必须
示例
备注
| template_name
| 是
|
| 配置的小程序模版名称
| version
| 否
|
| 配置规则名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ params | object | 非必须 |  |  |
| ├─ data | object | 非必须 |  |  |
| ├─ ziti_order | string | 非必须 |  |  |
| ├─ ext_info | string | 非必须 |  |  |
| ├─ group | string | 非必须 |  |  |
| ├─ boost_activity | string | 非必须 |  |  |
| ├─ boost_order | string | 非必须 |  |  |
| ├─ complaint | string | 非必须 |  |  |
| ├─ activity | string | 非必须 |  |  |
| ├─ recharge | string | 非必须 |  |  |
| ├─ member_code | string | 非必须 |  |  |
获取小程序公共配置信息
基本信息
Path： /api/h5app/h5app/wxapp/common/setting
Method： GET
接口描述：
获取小程序公共配置信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| type
|
| 客服类型 backend frontend
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ youshu | object | 非必须 |  |  |
| ├─ merchant_id | string | 非必须 |  | 腾讯有数merchant_id |
| ├─ app_id | string | 非必须 |  | 腾讯有数app_id |
| ├─ app_secret | string | 非必须 |  | 腾讯有数app_secret |
| ├─ sandbox_app_id | string | 非必须 |  | 腾讯有数app_id，沙箱 |
| ├─ sandbox_app_secret | string | 非必须 |  | 腾讯有数app_secret，沙箱 |
| ├─ weapp_name | string | 非必须 |  | 小程序名称 |
| ├─ weapp_app_id | string | 非必须 |  | 小程序appid |
| ├─ distributor_param_status | string | 非必须 |  | 是否带门店参数 true:开启 false:关闭 |
小程序oauth授权登录状态获取 pc接口
基本信息
Path： /api/h5app/h5app/wxapp/oauth/login/valid
Method： GET
接口描述：
小程序oauth授权登录状态获取 pc接口
请求参数
Query
参数名称
是否必须
示例
备注
| token
| 是
|
| 扫码获取的token
| code
| 是
|
| 登录时获取的 code
| appid
| 是
|
| 小程序唯一标识
| status
| 是
|
| 小程序确认授权 1 取消授权 0
返回数据
成功返回结构
获取小程序订阅消息模板列表
基本信息
Path： /api/h5app/h5app/wxapp/newtemplate
Method： GET
接口描述：
获取小程序订阅消息模板列表
请求参数
Query
参数名称
是否必须
示例
备注
| source_type
| 是
|
| 发起订阅类型
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ template_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
获取小程序购物车提醒配置信息
基本信息
Path： /api/h5app/h5app/wxapp/cartremind/setting
Method： GET
接口描述：
获取小程序购物车提醒配置信息
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ is_open | boolean | 非必须 |  | 是否开启 |
| ├─ remind_content | string | 非必须 |  | 提醒内容 |
获取小程序页面配置信息
基本信息
Path： /api/h5app/h5app/wxapp/pageparams/setting
Method： GET
接口描述：
获取小程序页面配置信息
请求参数
Query
参数名称
是否必须
示例
备注
| template_name
| 是
|
| 配置的小程序模版名称
| version
| 否
|
| 配置的小程序模版名称
| name
| 否
|
| 配置规则名称
| page_name
| 否
|
| 页面名称
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ template_name | string | 非必须 |  | 模板名称 |
| ├─ company_id | string | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ page_name | string | 非必须 |  | 页面名称 |
| ├─ params | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
| ├─ data | object [] | 非必须 |  |  |
item 类型: object
| ├─ primary | string | 非必须 |  |  |
| ├─ accent | string | 非必须 |  |  |
| ├─ marketing | string | 非必须 |  |  |
| ├─ config | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 自行更改字段描述 |
获取小程序首页营销文章
基本信息
Path： /api/h5app/h5app/wxa/promotion/articles
Method： GET
接口描述：
获取小程序首页营销文章
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| authorizer-appid
|
| 是
|
| 小程序appid(小程序访问此参必填)
Query
参数名称
是否必须
示例
备注
| company_id
| 否
|
| 公司company_id(h5app端必填)
| template_name
| 是
|
| 配置的小程序模版名称
| name
| 否
|
| 配置规则名称
| page_name
| 是
|
| 页面名称
返回数据
成功返回结构
获取小程序首页营销文章详情
基本信息
Path： /api/h5app/h5app/wxa/promotion/articles/info
Method： GET
接口描述：
获取小程序首页营销文章详情
请求参数
Query
参数名称
是否必须
示例
备注
| template_name
| 是
|
| 配置的小程序模版名称
| name
| 是
|
| 配置规则名称
| index
| 是
|
| 文章index
返回数据
成功返回结构
获取授权跳转地址
基本信息
Path： /api/h5app/h5app/wxapp/oauth/getredirecturl
Method： GET
接口描述：
获取授权跳转地址
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ redirect_url | string | 非必须 |  |  |
获取静默登录openid
基本信息
Path： /api/h5app/h5app/wxapp/oauth/getopenid
Method： GET
接口描述：
获取静默登录openid
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ open_id | string | 非必须 |  |  |
预约
用户提交预约数据
基本信息
Path： /api/h5app/wxapp/reservation
Method： POST
接口描述：
用户提交预约数据
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  |  |
获取可用预约项目
基本信息
Path： /api/h5app/wxapp/can/reservation/rights
Method： GET
接口描述：
获取可用预约项目
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的pageSize参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ rights_id | integer | 非必须 |  | 权益Id |
| ├─ can_reservation | string | 非必须 |  | 是否可预约 0:不可预约 1:可预约 |
| ├─ rights_name | string | 非必须 |  | 权益标题 |
| ├─ rights_subname | string | 非必须 |  | 权益子标题 |
| ├─ total_num | string | 非必须 |  | 服务商品原始总次数,0标示无限制 |
| ├─ total_consum_num | string | 非必须 |  | 总消耗次数 |
| ├─ start_time | string | 非必须 |  | 权益开始时间 |
| ├─ end_time | string | 非必须 |  | 权益结束时间 |
| ├─ order_id | string | 非必须 |  | 订单编号 |
| ├─ label_infos | object [] | 非必须 |  | 权益的物料信息json结构 |
item 类型: object
| ├─ label_id | integer | 非必须 |  | 服务商品id |
| ├─ label_name | string | 非必须 |  | 服务商品名称 |
| ├─ rights_from | string | 非必须 |  | 权益来源 |
| ├─ mobile | string | 非必须 |  | 会员手机号 |
| ├─ status | string | 非必须 |  | 权益状态; valid:有效的, expire:过期的; invalid:失效的 |
| ├─ is_not_limit_num | integer | 非必须 |  | 限制核销次数,1:不限制；2:限制 |
获取可预约的日期
基本信息
Path： /api/h5app/wxapp/reservation/dateDay
Method： GET
接口描述：
获取可预约的具体日期
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| endDate
| 否
|
| 权益截止日期 时间戳
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ date | string | 非必须 |  | 日期 |
| ├─ date_day | string | 非必须 |  | 日期 |
| ├─ date_week | string | 非必须 |  | 星期 |
| ├─ timestamp | string | 非必须 |  | 时间戳 |
获取可预约的时段
基本信息
Path： /api/h5app/wxapp/reservation/timelist
Method： GET
接口描述：
获取可预约的具体时段,排班情况和每个时段的预约状态
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| shopId
| 是
|
| 门店id
| dateDay
| 是
|
| 日期
| labelId
| 是
|
| 服务项目id
| rightsId
| 否
|
| 权益ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ begin_time | string | 非必须 |  | 开始时间 |
| ├─ end_time | string | 非必须 |  | 结束时间 |
| ├─ status | integer | 非必须 |  | 状态 0:不可预约 1:可预约 |
获取指定项目的预约量
基本信息
Path： /api/h5app/wxapp/reservation/getCount
Method： GET
接口描述：
获取指定项目的预约量
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| rights_id
| 否
|
| 权益id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ total_count | string | 非必须 |  |  |
获取资源位列表信息
基本信息
Path： /api/h5app/wxapp/resource/level
Method： GET
接口描述：
获取资源位列表信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店id
| material_id
| 否
|
| 服务项目id
| work_date
| 否
|
| 具体日期
| page
| 否
|
| 页码
| pageSize
| 否
|
| 每页数据量
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  |  |
获取资源位详情
基本信息
Path： /api/h5app/wxapp/resource/timeList
Method： GET
接口描述：
获取资源位详情
请求参数
Query
参数名称
是否必须
示例
备注
| shop_id
| 否
|
| 门店id
| label_id
| 否
|
| 服务项目id
| date_day
| 否
|
| 具体日期
| resource_level_id
| 否
|
| 资源位Id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | string | 非必须 |  |  |
获取预约记录列表
基本信息
Path： /api/h5app/wxapp/reservation/recordlist
Method： GET
接口描述：
获取该用户的预约记录列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 否
|
| 登录token(小程序端必填)
| Authorization
|
| 是
|
| JWT验证token(h5app必填)
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的pageSize参数是0，那么按默认值20处理
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ recordId | integer | 非必须 |  | Id |
| ├─ shopId | integer | 非必须 |  | 门店ID |
| ├─ shopName | string | 非必须 |  | 门店名称 |
| ├─ agreementDate | string | 非必须 |  | 约定日期 |
| ├─ toShopTime | integer | 非必须 |  | 到店时间(时间戳) |
| ├─ beginTime | string | 非必须 |  | 到店时间(时刻字符串) |
| ├─ endTime | string | 非必须 |  | 约定结束时刻(时刻字符串) |
| ├─ status | string | 非必须 |  | 预约状态。可选值有 cancel-取消;-to_the_shop-已到店;-not_to_shop-未到店;-success-预约成功;-system-系统占位; |
| ├─ num | integer | 非必须 |  | 预约数量 |
| ├─ user_name | string | 非必须 |  | 用户名 |
| ├─ sex | integer | 非必须 |  | 用户性别 1:男 2:女 |
| ├─ mobile | string | 非必须 |  | 预约人手机号 |
| ├─ resourceLevelId | integer | 非必须 |  | 资源位id |
| ├─ resourceLevelName | integer | 非必须 |  | 资源位名称 |
| ├─ rightsId | integer | 非必须 |  | 服务商品id |
| ├─ rightsName | string | 非必须 |  | 服务商品名称 |
| ├─ labelId | string | 非必须 |  | 物料Id |
| ├─ labelName | string | 非必须 |  | 物料名称 |
积分
积分列表
基本信息
Path： /api/h5app/wxapp/point/member
Method： GET
接口描述：
一年以内的会员积分记录列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page_no
| 否
|
| 页码 default:1
| page_size
| 否
|
| 条数 default:10
| outin_type
| 否
|
| 类型 outcome:支出 income:收入
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ company_id | string | 非必须 |  | 企业Id |
| ├─ id | string | 非必须 |  | 自增Id |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ income | integer | 非必须 |  | 收入 |
| ├─ outcome | integer | 非必须 |  | 支出 |
| ├─ point | integer | 非必须 |  | 增加或减少的积分数 |
| ├─ journal_type | integer | 非必须 |  | 积分交易类型，1:注册送积分 2.推荐送分 3.充值返积分 4.推广注册返积分 5.积分换购 6.储值兑换积分 7.订单返积分 8.会员等级返佣 9.取消订处理积分 10.售后处理积分 11.大转盘抽奖送积分 12:管理员手动调整积分 |
| ├─ outin_type | string | 非必须 |  | 类型 out:支出 in:收入 |
| ├─ point_desc | string | 非必须 |  | 积分描述 |
| ├─ order_id | string | 非必须 |  | 订单编号 |
| ├─ created | string | 非必须 |  | 创建时间 时间戳 |
| ├─ updated | string | 非必须 |  | 更新时间 时间戳 |
获取积分信息
基本信息
Path： /api/h5app/wxapp/point/member/info
Method： GET
接口描述：
获取积分统计信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ user_id | string | 非必须 |  | 会员ID |
| ├─ company_id | string | 非必须 |  | 企业ID |
| ├─ point | string | 非必须 |  | 现有积分数 |
获取积分规则信息
基本信息
Path： /api/h5app/wxapp/point/rule
Method： GET
接口描述：
获取积分规则信息
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ name | string | 非必须 |  | 积分名 |
推广管理
佣金提现申请
基本信息
Path： /api/h5app/wxapp/cash_withdrawal
Method： POST
接口描述：
佣金提现申请
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| money
| 是
|
| 提现金额
返回数据
"成功返回结构"
获取提现申请列表
基本信息
Path： /api/h5app/wxapp/cash_withdrawals
Method： GET
接口描述：
获取提现申请列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| pageSize
| 是
|
| 每页的数量
| page
| 是
|
| 分页页数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ distributor_id | stirng | 非必须 |  |  |
| ├─ distributor_name | stirng | 非必须 |  |  |
| ├─ money | stirng | 非必须 |  |  |
| ├─ status | stirng | 非必须 |  |  |
店铺
获取店铺标签列表
基本信息
Path： /api/h5app/wxapp/distributor_tag/list
Method： GET
接口描述：
获取店铺标签列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 必须 |  |  |
item 类型: object
| ├─ total_count | string | 必须 | 3 | 自行更改字段描述 |
| ├─ list | object [] | 必须 |  |  |
item 类型: object
| ├─ tag_id | string | 必须 | 1 | 店铺标签的id |
| ├─ company_id | string | 必须 | 1 | 公司的company_id |
| ├─ tag_name | string | 必须 |  | 标签名字 |
| ├─ tag_color | string | 必须 |  | 标签颜色 |
| ├─ font_color | string | 必须 |  | 标签中字体的颜色 |
| ├─ description | string | 必须 |  | 标签的详情 |
| ├─ tag_icon | string | 必须 |  | 标签的icon |
| ├─ front_show | string | 必须 |  | 是否需要展示到小程序端【0 不展示】【1 展示】 |
| ├─ created | string | 必须 | 1605182300 | 创建时间 |
| ├─ updated | string | 必须 | 1605182300 | 更新时间 |
关联店铺标签
基本信息
Path： /api/h5app/distributor/reltag
Method： POST
接口描述：
关联店铺标签
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| tag_ids
| 是
|
| tagId
| item_ids
| 否
|
| itemId
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | integer | 非必须 |  |  |
大屏广告接口
基本信息
Path： /api/h5app/wxapp/distributor/advertisements
Method： GET
接口描述：
大屏广告接口
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 经销商ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 自行更改字段描述 |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ thumb_img | string | 非必须 |  | 缩略图 |
| ├─ media_url | string | 非必须 |  | (图片/视频)地址 |
| ├─ release_time | string | 非必须 |  | 发布时间 |
| ├─ release_status | string | 非必须 |  | 状态 |
| ├─ created | string | 非必须 |  |  |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ media_type | string | 非必须 |  | 类型 |
| ├─ media | object | 非必须 |  |  |
| ├─ url | string | 非必须 |  |  |
| ├─ type | string | 非必须 |  |  |
| ├─ thumb_img | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ media | object [] | 非必须 |  |  |
item 类型: object
| ├─ url | string | 非必须 |  |  |
| ├─ type | string | 非必须 |  |  |
新增店铺标签
基本信息
Path： /api/h5app/distributor/tag
Method： POST
接口描述：
新增店铺标签
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| tag_name
| 是
|
| 标签名称
| description
| 否
|
| 标签描述
| tag_color
| 否
|
| 标签颜色
| font_color
| 否
|
| 标签文字颜色
| front_show
| 否
|
| 前台是否显示 0 不显示 1 显示
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tag_name | string | 非必须 |  | 标签名称 |
| ├─ tag_color | string | 非必须 |  | 标签颜色 |
| ├─ font_color | string | 非必须 |  | 字体颜色 |
| ├─ description | string | 非必须 |  | 申请描述 |
| ├─ tag_icon | string | 非必须 |  | 标签icon |
| ├─ front_show | string | 非必须 |  | 前台是否显示 0 否 1 是 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
更新店铺标签
基本信息
Path： /api/h5app/distributor/tag/{tagId}
Method： PUT
接口描述：
更新店铺标签
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| tagId
|
| tag_id
Query
参数名称
是否必须
示例
备注
| tag_name
| 是
|
| 标签名称
| description
| 否
|
| 标签描述
| font_color
| 否
|
| 标签文字颜色
| tag_color
| 否
|
| 标签颜色
| front_show
| 否
|
| 前台是否显示 0 不显示 1 显示
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tag_name | string | 非必须 |  | 标签名称 |
| ├─ tag_color | string | 非必须 |  | 标签颜色 |
| ├─ font_color | string | 非必须 |  | 字体颜色 |
| ├─ description | string | 非必须 |  | 描述 |
| ├─ tag_icon | string | 非必须 |  | 标签icon |
| ├─ front_show | string | 非必须 |  | 前台是否显示 0 否 1 是 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
申请店铺入驻
基本信息
Path： /api/h5app/distributor
Method： POST
接口描述：
申请店铺入驻
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| name
| 是
|
| 经销商的名称
| contact
| 是
|
| 联系人
| mobile
| 是
|
| 经销商手机号
| is_delivery
| 否
|
| 是否支持配送
| is_ziti
| 否
|
| 是否支持自提
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ distributor_id | stirng | 非必须 |  |  |
| ├─ name | stirng | 非必须 |  |  |
| ├─ shop_code | stirng | 非必须 |  |  |
| ├─ address | stirng | 非必须 |  |  |
| ├─ mobile | stirng | 非必须 |  |  |
| ├─ shop_id | integer | 非必须 |  |  |
| ├─ contact | stirng | 非必须 |  |  |
获取图片验证码
基本信息
Path： /api/h5app/wxapp/distributor/image/code
Method： GET
接口描述：
获取图片验证码
请求参数
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ imageToken | string | 非必须 |  | 图片token |
| ├─ imageData | string | 非必须 |  | base64图片信息 |
获取店铺信息
基本信息
Path： /api/h5app/wxapp/distributor/getDistributorInfo
Method： GET
接口描述：
获取指定店铺信息或者默认店铺信息
请求参数
Query
参数名称
是否必须
示例
备注
| company_id
| 是
|
| company_id
| distributor_id
| 否
|
| 店铺id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 店铺手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ child_count | integer | 非必须 |  |  |
| ├─ is_default | integer | 非必须 |  | 门店id |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ is_domestic | integer | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | integer | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  |  |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ created | integer | 非必须 |  |  |
| ├─ updated | integer | 非必须 |  |  |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | integer | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | integer | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | string | 非必须 |  | 平台服务费率 |
| ├─ store_address | string | 非必须 |  |  |
| ├─ store_name | string | 非必须 |  |  |
| ├─ phone | string | 非必须 |  |  |
获取店铺列表
基本信息
Path： /api/h5app/wxapp/distributor/list
Method： GET
接口描述：
获取店铺列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| lat
| 否
|
| 纬度
| lng
| 否
|
| 经度
| page
| 否
|
| 页数
| pageSize
| 否
|
| 每页条数
| company_id
| 否
|
| 公司id
| name
| 否
|
| 店铺名称
| province
| 否
|
| 筛选的省份
| city
| 否
|
| 筛选的城市
| area
| 否
|
| 筛选的区域
| type
| 否
|
| 查询类型, [0 正常流程] [1 基于省市区过滤] [2 基于默认收货地址强制定位]
| card_id
| 否
|
| 卡券id, 返回适用的所有店铺列表
| sort_type
| 否
|
| 排序类型【0 根据添加时间倒序】【1 根据距离排序，由近到远】【2 根据距离排序，由远到近】【3 根据店铺销量排序，由高到低】【4 根据店铺销量排序，由低到高】
| distributor_tag_id
| 否
|
| 店铺标签的id，支持多个，如果是多个需要用逗号隔开
| is_ziti
| 否
|
| 是否支持自提【null 不筛选】【0 不支持自提】【1 支持自提】
| is_delivery
| 否
|
| 是否支持快递【null 不筛选】【0 不支持快递】【1 支持快递】
| is_dada
| 否
|
| 是否支持同城配【null 不筛选】【0 不支持同城配】【1 支持同城配】
| show_discount
| 否
|
| 是否展示优惠券信息【0 不展示】【1 展示】
| show_marketing_activity
| 否
|
| 是否展示满减满赠等活动信息【0 不展示】【1 展示】
| show_score
| 否
|
| 是否展示评分【0 不展示】【1 展示】
| show_items
| 否
|
| 是否展示商品【0 不展示】【1 展示】
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ is_recommend | integer | 非必须 | 0 | 判断是否是推荐门店， 0为附近门店不是推荐门店，1为推荐门店 |
| ├─ total_count | string | 非必须 | 9 | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ distributor_id | string | 非必须 | 105 | 店铺id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ mobile | string | 非必须 | 17621716237 | 电话 |
| ├─ address | string | 非必须 | 徐汇区 | 地址 |
| ├─ name | string | 非必须 | 普天信息产业园 | 名称 |
| ├─ created | string | 非必须 | 1608012760 | 创建时间 |
| ├─ updated | string | 非必须 | 1610533984 | 更新时间 |
| ├─ is_valid | string | 非必须 | true |  |
| ├─ province | string | 非必须 | 上海市 | 省 |
| ├─ city | string | 非必须 | 上海市 | 市 |
| ├─ area | string | 非必须 | 徐汇区 | 区县 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 | 310000 | 地区码 |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 | 上海市 | 地区名称 |
| ├─ contact | string | 非必须 | wuqiong  |  |
| ├─ child_count | string | 非必须 | 0 |  |
| ├─ shop_id | string | 非必须 | 0 | shop_id |
| ├─ is_default | string | 非必须 | true | 是否默认 |
| ├─ is_ziti | string | 非必须 | true | 是否自提 |
| ├─ lng | string | 非必须 | 121.43687 | 经度 |
| ├─ lat | string | 非必须 | 31.18826 | 纬度 |
| ├─ hour | string | 非必须 | 08:00-21:00 |  |
| ├─ auto_sync_goods | string | 非必须 | false | 自动同步商品 |
| ├─ logo | string | 非必须 | null | logo |
| ├─ banner | string | 非必须 | null | banner |
| ├─ is_audit_goods | string | 非必须 | false | 是否审核商品 |
| ├─ is_delivery | string | 非必须 | true |  |
| ├─ shop_code | string | 非必须 | 1234567 | shop_code |
| ├─ review_status | string | 非必须 | 0 |  |
| ├─ source_from | string | 非必须 | 1 |  |
| ├─ distributor_self | string | 非必须 | 0 |  |
| ├─ is_distributor | string | 非必须 | true | 是否门店 |
| ├─ contract_phone | string | 非必须 | 17621716237 | 电话 |
| ├─ is_domestic | string | 非必须 | 1 |  |
| ├─ is_direct_store | string | 非必须 | 1 | 是否直营店 |
| ├─ wechat_work_department_id | string | 非必须 | 0 |  |
| ├─ regionauth_id | string | 非必须 | 1 |  |
| ├─ is_open | string | 非必须 | false |  |
| ├─ rate | string | 非必须 |  |  |
| ├─ distance | string | 非必须 | 0 | 距离 |
| ├─ store_address | string | 非必须 | 上海市徐汇区徐汇区 | 地址 |
| ├─ store_name | string | 非必须 | 普天信息产业园 | 名称 |
| ├─ phone | string | 非必须 | 17621716237 | 手机号 |
| ├─ distance_show | string | 非必须 | 0 | 距离显示 |
| ├─ distance_unit | string | 非必须 | m | 距离单位 |
| ├─ tagList | object [] | 非必须 |  | 店铺标签信息 |
item 类型: object
| ├─ tag_id | integer | 必须 | 1 | 店铺标签id |
| ├─ tag_name | string | 必须 |  | 店铺标签的名字 |
| ├─ tag_color | string | 必须 |  | 店铺标签的颜色 |
| ├─ font_color | string | 必须 |  | 店铺标签的字体颜色 |
| ├─ tag_icon | string | 必须 |  | 店铺标签的图片 |
| ├─ discountCardList | object [] | 非必须 |  | 店铺优惠券 |
item 类型: object
| ├─ card_id | integer | 必须 | 1 | 优惠券id |
| ├─ card_type | string | 必须 |  | 优惠券类型【discount 折扣券】【cash 代金券】【gift 兑换券】【new_gift 兑换券(新)】 |
| ├─ title | string | 必须 |  | 优惠券名称 |
| ├─ color | string | 必须 |  | 优惠券颜色 |
| ├─ date_type | string | 必须 |  | 有效期的类型【DATE_TYPE_FIX_TIME_RANGE 指定日期范围内】【DATE_TYPE_FIX_TERM 领取后的固定天数】 |
| ├─ begin_date | string | 必须 |  | 开始时间（时间戳），当date_type为DATE_TYPE_FIX_TERM时，begin_date为领取后在第几天之后才生效，值为2时则为领取后的2天后才生效 |
| ├─ end_date | string | 必须 |  | 结束时间（时间戳），当date_type为DATE_TYPE_FIX_TERM时，end_date为该优惠券的统一过期时间，如果值为0表示不存在过期时间 |
| ├─ fixed_term | string | 必须 |  | date_type为DATE_TYPE_FIX_TERM时，优惠券被领取后的有效天数 |
| ├─ quantity | integer | 必须 |  | 卡券发放的数量 |
| ├─ discount | integer | 必须 |  | 卡券的折扣额度，带百分比，值为34表示34%，但在后台营销中的优惠券管理里的折扣额度的值是 (100-34) |
| ├─ least_cost | integer | 必须 |  | 优惠券的使用条件，需要满多少才可用（金额的单位：分） |
| ├─ most_cost | integer | 必须 |  | 代金券最高消费限额（金额的单位：分） |
| ├─ reduce_cost | integer | 必须 |  | 满减券的减免金额（金额的单位：分） |
| ├─ get_limit | integer | 必须 |  | 领券的数量限制 |
| ├─ receive | integer | 必须 |  | 是否前台直接领取【0 否】【1 是】 |
| ├─ marketingActivityList | object [] | 非必须 |  | 店铺满折满减满赠营销活动 |
item 类型: object
| ├─ marketing_id | integer | 必须 | 1 | 活动id |
| ├─ marketing_type | string | 必须 |  | 活动类型【full_discount 满折】【full_minus 满减】【full_gift 满赠】【self_select 任选优惠】【plus_price_buy 加价购】【member_preference 会员优先购】 |
| ├─ marketing_name | string | 必须 |  | 活动名称 |
| ├─ condition_type | string | 必须 |  | 促销规则的类型【quantity 按总件数】【totalfee 按总金额】 |
| ├─ condition_value | string | 必须 |  | 促销规则 |
| ├─ promotion_tag | string | 必须 |  | 促销标签 |
| ├─ valid_grade | string | 必须 |  | 会员级别集合 |
| ├─ join_limit | integer | 必须 |  | 可参与次数 |
| ├─ start_time | integer | 必须 |  | 促销开始的时间（时间戳） |
| ├─ end_time | integer | 必须 |  | 促销结束的时间（时间戳） |
| ├─ canjoin_repeat | integer | 必须 |  | 促销活动是否上不封顶【0 封顶】【1 不封顶】 |
| ├─ use_shop | integer | 必须 |  | 适用店铺【0 全场可用】【1 指定店铺可用】 |
| ├─ in_proportion | integer | 必须 |  | 满赠活动中，是否按比例赠送【0 否】【1 是】 |
| ├─ scoreList | object [] | 非必须 |  | 店铺的评分信息 |
item 类型: object
| ├─ avg_star | string | 必须 | 5.0 | 平均分，保留1位小数 |
| ├─ default | integer | 必须 | 1 | 该店铺是否有人评分【0 否】【1 是】 |
| ├─ itemList | object [] | 非必须 |  | 店铺的商品信息 |
item 类型: object
| ├─ item_id | integer | 必须 | 1 | 商品id |
| ├─ item_name | string | 必须 |  | 商品名称 |
| ├─ price | integer | 必须 |  | 销售价,单位为‘分’ |
| ├─ market_price | integer | 必须 |  | 原价,单位为‘分’ |
| ├─ store | integer | 必须 |  | 库存 |
| ├─ pics | string | 必须 |  | 封面 |
| ├─ tagList | object [] | 非必须 |  | 店铺的所有标签 |
item 类型: object
| ├─ tag_id | integer | 必须 | 1 | 店铺标签id |
| ├─ tag_name | string | 必须 |  | 店铺标签的名字 |
| ├─ tag_color | string | 必须 |  | 店铺标签的颜色 |
| ├─ font_color | string | 必须 |  | 店铺标签的字体颜色 |
| ├─ tag_icon | string | 必须 |  | 店铺标签的图片 |
| ├─ default_address | object | 非必须 |  |  |
| ├─ address_id | string | 非必须 | 415 | 地址id |
| ├─ company_id | string | 非必须 | 1 | 公司id |
| ├─ user_id | string | 非必须 | 20264 | 用户id |
| ├─ username | string | 非必须 | 张三 | 名称 |
| ├─ telephone | string | 非必须 | 18890908989 | 手机号码 |
| ├─ area | string | 非必须 | null | 地区 |
| ├─ province | string | 非必须 | 广东省 | 省 |
| ├─ city | string | 非必须 | 广州市 | 市 |
| ├─ county | string | 非必须 | 海珠区 | 区 |
| ├─ adrdetail | string | 非必须 | 新港中路397号 | 详细地址 |
| ├─ postalCode | string | 非必须 | 510000 | 邮编 |
| ├─ is_def | string | 非必须 | true | 是否默认地址 |
| ├─ created | string | 非必须 | 1598846042 |  |
| ├─ updated | string | 非必须 | 1598846042 | 修改时间 |
| ├─ third_data | string | 非必须 | null | 百胜等第三方返回的数据 |
| ├─ lat | string | 非必须 |  | 经度 |
| ├─ lng | string | 非必须 |  | 纬度 |
获取店铺售后地址
基本信息
Path： /api/h5app/wxapp/distributor/aftersaleaddress
Method： GET
接口描述：
根据店铺id获取店铺售后地址
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 否
|
| 店铺id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ address | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ address_id | string | 非必须 |  | 地址id |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions_id | string | 非必须 |  | 地区编号集合(DC2Type:json_array) |
| ├─ regions | string | 非必须 |  | 省市区合集(DC2Type:json_array) |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ contact | string | 非必须 |  | 联系人 |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ post_code | string | 非必须 |  | 邮政编码 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ is_default | string | 非必须 |  | 默认地址, 1:是。2:不是 |
| ├─ distributor_info | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ contract_phone | string | 非必须 |  | 联系电话 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ child_count | string | 非必须 |  |  |
| ├─ is_default | string | 非必须 |  | 是否默认货币 |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 地区id |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ rate | string | 非必须 |  |  |
获取店铺总店
基本信息
Path： /api/h5app/wxapp/distributor/self
Method： GET
接口描述：
获取店铺总店
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 店铺id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 电话 |
| ├─ address | string | 非必须 |  | 地址 |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ created | string | 非必须 |  | 创建时间 |
| ├─ updated | string | 非必须 |  | 更新时间 |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区县 |
| ├─ regions_id | string [] | 非必须 |  | 地区id |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  | 地区名称 |
| ├─ contact | string | 非必须 |  |  |
| ├─ child_count | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | shop_id |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ is_ziti | string | 非必须 |  | 是否自提 |
| ├─ lng | string | 非必须 |  | 经度 |
| ├─ lat | string | 非必须 |  | 纬度 |
| ├─ hour | string | 非必须 |  |  |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步商品 |
| ├─ logo | string | 非必须 |  | logo |
| ├─ banner | string | 非必须 |  | banner |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核商品 |
| ├─ is_delivery | string | 非必须 |  |  |
| ├─ shop_code | string | 非必须 |  | shop_code |
| ├─ review_status | string | 非必须 |  |  |
| ├─ source_from | string | 非必须 |  |  |
| ├─ distributor_self | string | 非必须 |  |  |
| ├─ is_distributor | string | 非必须 |  | 是否门店 |
| ├─ contract_phone | string | 非必须 |  | 电话 |
| ├─ is_domestic | string | 非必须 |  |  |
| ├─ is_direct_store | string | 非必须 |  | 是否直营店 |
| ├─ wechat_work_department_id | string | 非必须 |  |  |
| ├─ regionauth_id | string | 非必须 |  |  |
| ├─ is_open | string | 非必须 |  |  |
| ├─ rate | string | 非必须 |  |  |
| ├─ distance | string | 非必须 |  | 距离 |
| ├─ store_address | string | 非必须 |  | 地址 |
| ├─ store_name | string | 非必须 |  | 名称 |
| ├─ phone | string | 非必须 |  | 手机号 |
| ├─ distance_show | string | 非必须 |  | 距离显示 |
| ├─ distance_unit | string | 非必须 |  | 距离单位 |
删除店铺标签详情
基本信息
Path： /api/h5app/distributor/tag/{tagId}
Method： DELETE
接口描述：
删除店铺标签详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| tagId
|
| 标签id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  | 自行更改字段描述 |
获取店铺标签列表
基本信息
Path： /api/h5app/distributor/tag
Method： GET
接口描述：
获取店铺标签列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 页码
| pageSize
| 是
|
| 每页长度
| tag_name
| 否
|
| 标签名字
| front_show
| 否
|
| 是否前台展示【null 不作为筛选条件】【0 前台不显示】【1 前台显示】
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ tag_id | string | 非必须 |  | 标签id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tag_name | string | 非必须 |  | 标签名称 |
| ├─ tag_color | string | 非必须 |  | 标签颜色 |
| ├─ font_color | string | 非必须 |  | 字体颜色 |
| ├─ description | string | 非必须 |  | 描述 |
| ├─ tag_icon | string | 非必须 |  | 标签icon |
| ├─ front_show | string | 非必须 |  | 前台是否显示 0 否 1 是 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
获取店铺标签详情
基本信息
Path： /api/h5app/distributor/tag/{tagId}
Method： GET
接口描述：
获取店铺标签详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| tag_id
|
| 标签id
| tagId
|
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tag_name | string | 非必须 |  | 标签名称 |
| ├─ tag_color | string | 非必须 |  | 标签颜色 |
| ├─ font_color | string | 非必须 |  | 字体颜色 |
| ├─ description | string | 非必须 |  | 描述 |
| ├─ tag_icon | string | 非必须 |  | 标签icon |
| ├─ front_show | string | 非必须 |  | 前台是否显示 0 否 1 是 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
获取店铺统计
基本信息
Path： /api/h5app/wxapp/distributor/count
Method： GET
接口描述：
获取店铺统计
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ cashWithdrawalRebate | stirng | 非必须 |  |  |
| ├─ freezeCashWithdrawalRebate | stirng | 非必须 |  |  |
| ├─ itemTotalPrice | stirng | 非必须 |  |  |
| ├─ noCloseRebate | stirng | 非必须 |  |  |
| ├─ rebateTotal | stirng | 非必须 |  |  |
获取店铺详情
基本信息
Path： /api/h5app/wxapp/distributor
Method： GET
接口描述：
获取此案普详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ address | string | 非必须 |  | 具体地址 |
| ├─ name | string | 非必须 |  | 名称 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ contract_phone | string | 非必须 |  | 联系电话 |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ contact | string | 非必须 |  | 联系人 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ child_count | string | 非必须 |  |  |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ regionauth_id | string | 非必须 |  | 地区id |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ rate | string | 非必须 |  |  |
| ├─ store_address | string | 非必须 |  |  |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ phone | string | 非必须 |  |  |
| ├─ config | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
获取店铺配送方式
基本信息
Path： /api/h5app/wxapp/distributor/deliverytype
Method： GET
接口描述：
获取店铺配送方式
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 店铺id
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ delivery_name | stirng | 非必须 |  |  |
| ├─ delivery_type | stirng | 非必须 |  |  |
获取所店铺有列表
基本信息
Path： /api/h5app/wxapp/distributor/alllist
Method： GET
接口描述：
获取所有店铺列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
| name
| 否
|
| 店铺名称
| province
| 否
|
| 店铺所在省
| city
| 否
|
| 店铺所在市
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 自行更改字段描述 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ mobile | string | 非必须 |  | 手机号 |
| ├─ address | string | 非必须 |  | 地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ is_valid | string | 非必须 |  | 是否有效 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ child_count | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  | 门店id |
| ├─ is_default | string | 非必须 |  | 是否是默认门店 |
| ├─ is_ziti | string | 非必须 |  | 是否支持自提 |
| ├─ lng | string | 非必须 |  | 地图纬度 |
| ├─ lat | string | 非必须 |  | 地图经度 |
| ├─ hour | string | 非必须 |  | 营业时间，格式11:11-12:12 |
| ├─ auto_sync_goods | string | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ is_audit_goods | string | 非必须 |  | 是否审核店铺商品 |
| ├─ is_delivery | string | 非必须 |  | 是否支持配送 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ review_status | string | 非必须 |  | 入驻审核状态，0未审核，1已审核 |
| ├─ source_from | string | 非必须 |  | 店铺来源，1管理端添加，2小程序申请入驻 |
| ├─ distributor_self | string | 非必须 |  | 是否是总店配置 |
| ├─ is_distributor | string | 非必须 |  | 是否是主店铺 |
| ├─ contract_phone | string | 非必须 |  | 联系电话 |
| ├─ is_domestic | string | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | string | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ wechat_work_department_id | string | 非必须 |  | 企业微信的部门ID |
| ├─ regionauth_id | string | 非必须 |  | 地区id | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启 1:开启,0:关闭 |
| ├─ rate | string | 非必须 |  |  |
| ├─ distance | string | 非必须 |  |  |
| ├─ store_address | string | 非必须 |  |  |
| ├─ store_name | string | 非必须 |  | 店铺名称 |
| ├─ phone | string | 非必须 |  |  |
| ├─ distance_show | string | 非必须 |  |  |
| ├─ distance_unit | string | 非必须 |  |  |
获取手机短信验证码
基本信息
Path： /api/h5app/wxapp/distributor/sms/code
Method： GET
接口描述：
获取手机短信验证码
请求参数
Query
参数名称
是否必须
示例
备注
| type
| 是
|
| 验证码类型 login 登录验证码
| mobile
| 是
|
| 手机号
| yzm
| 是
|
| 图片验证码的值
| token
| 是
|
| 图片验证码token
| company_id
| 是
|
| 企业id
| distributor_id
| 否
|
| 店铺id
返回数据
名称类型是否必须默认值备注其他信息
|  error | object | 非必须 |  |  |
| ├─ message | string | 非必须 |  | 提示信息 |
| ├─ status_code | string | 非必须 |  | 错误码 |
获取首页轮播图
基本信息
Path： /api/h5app/wxapp/distributor/slider
Method： GET
接口描述：
获取首页轮播图
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 经销商ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ slide_id | string | 非必须 |  | 轮播id |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ sub_title | string | 非必须 |  | 副标题 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ style_params | object | 非必须 |  |  |
| ├─ content | string | 非必须 |  | 内容 |
| ├─ current | string | 非必须 |  |  |
| ├─ dot | string | 非必须 |  |  |
| ├─ dotColor | string | 非必须 |  |  |
| ├─ dotCover | string | 非必须 |  |  |
| ├─ dotLocation | string | 非必须 |  |  |
| ├─ interval | string | 非必须 |  |  |
| ├─ numNavShape | string | 非必须 |  |  |
| ├─ padded | string | 非必须 |  |  |
| ├─ rounded | string | 非必须 |  |  |
| ├─ shape | string | 非必须 |  |  |
| ├─ spacing | string | 非必须 |  |  |
| ├─ image_list | object [] | 非必须 |  |  |
item 类型: object
| ├─ url | string | 非必须 |  |  |
| ├─ desc | string | 非必须 |  |  |
| ├─ id | string | 非必须 |  |  |
| ├─ desc_status | string | 非必须 |  | 图片描述状态11 |
| ├─ distributor_id | string | 非必须 |  | 店铺id |
逆地址解析
基本信息
Path： /api/h5app/wxapp/distributor/areainfo
Method： GET
接口描述：
根据经纬度，逆地址解析
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ nation | string | 非必须 |  | 国家 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市  |
| ├─ district | string | 非必须 |  | 区（县） |
| ├─ street | string | 非必须 |  | 街道 |
| ├─ street_number | string | 非必须 |  |  |
验证店铺id是否有效
基本信息
Path： /api/h5app/wxapp/distributor/is_valid
Method： GET
接口描述：
验证店铺id是否有效
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| JWT验证token
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| lng
| 否
|
| 当前位置经度
| lat
| 否
|
| 当前位置纬度
| distributor_id
| 否
|
| 店铺id
| show_score
| 否
|
| 是否展示评分【0 不展示】【1 展示】
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  |  |
| ├─ shop_id | string | 非必须 |  |  |
| ├─ is_distributor | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ mobile | string | 非必须 |  |  |
| ├─ address | string | 非必须 |  |  |
| ├─ name | string | 非必须 |  |  |
| ├─ auto_sync_goods | string | 非必须 |  |  |
| ├─ logo | string | 非必须 |  |  |
| ├─ contract_phone | string | 非必须 |  |  |
| ├─ banner | string | 非必须 |  |  |
| ├─ contact | string | 非必须 |  |  |
| ├─ is_valid | string | 非必须 |  |  |
| ├─ lng | string | 非必须 |  |  |
| ├─ lat | string | 非必须 |  |  |
| ├─ child_count | string | 非必须 |  |  |
| ├─ is_default | string | 非必须 |  |  |
| ├─ is_audit_goods | string | 非必须 |  |  |
| ├─ is_ziti | string | 非必须 |  |  |
| ├─ regions_id | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ is_domestic | string | 非必须 |  |  |
| ├─ is_direct_store | string | 非必须 |  |  |
| ├─ province | string | 非必须 |  |  |
| ├─ is_delivery | string | 非必须 |  |  |
| ├─ city | string | 非必须 |  |  |
| ├─ area | string | 非必须 |  |  |
| ├─ hour | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ shop_code | string | 非必须 |  |  |
| ├─ wechat_work_department_id | string | 非必须 |  |  |
| ├─ distributor_self | string | 非必须 |  |  |
| ├─ regionauth_id | string | 非必须 |  |  |
| ├─ is_open | string | 非必须 |  |  |
| ├─ rate | string | 非必须 |  |  |
| ├─ store_address | string | 非必须 |  |  |
| ├─ store_name | string | 非必须 |  |  |
| ├─ phone | string | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ old_valid | string | 非必须 |  |  |
| ├─ scoreList | object [] | 非必须 |  | 店铺的评分信息 |
item 类型: object
| ├─ avg_star | string | 必须 | 5.0 | 平均分，保留1位小数 |
| ├─ default | integer | 必须 | 1 | 该店铺是否有人评分【0 否】【1 是】 |
验证短信验证码
基本信息
Path： /api/h5app/wxapp/distributor/sms/code
Method： POST
接口描述：
验证短信验证码
请求参数
Query
参数名称
是否必须
示例
备注
| distributor_id
| 否
|
| 店铺id
| vcode
| 否
|
| 验证码
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ cardId | string | 非必须 |  |  |
商品
获取商品收藏情况
基本信息
Path： /api/h5app/wxapp/goods/items/{item_id}/fav
Method： GET
接口描述：
获取商品收藏情况（暂时作废）
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ status | boolean | 非必须 |  |  |
扫条形码加入购物车
基本信息
Path： /api/h5app/wxapp/goods/scancodeAddcart
Method： POST
接口描述：
扫条形码加入购物车
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| barcode
| 否
|
| 商品条形码
| distributor_id
| 否
|
| 店铺或门店id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | string | 非必须 |  |  |
| ├─ msg | string | 非必须 |  |  |
获取分类列表
基本信息
Path： /api/h5app/wxapp/goods/category
Method： GET
接口描述：
获取分类列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| is_main_category
| 否
|
| 是否主目录
| distributor_id
| 否
|
| 分销商id
| only_top
| 是
|
| 仅一级类目
| regionauth_id
| 是
|
| 区域ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 商品分类id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  |  |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 商品分类等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 商品分类id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  |  |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 商品分类等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 商品分类id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  |  |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string | 非必须 |  | 商品参数 |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 商品分类等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
获取商品价格、库存等参数
基本信息
Path： /api/h5app/wxapp/goods/itemExtAttribute/{item_id}
Method： GET
接口描述：
获取商品价格、库存等参数
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
Query
参数名称
是否必须
示例
备注
| goods_id
| 否
|
| 产品ID，多规格商品不同规格的goods_id是一样的
| distributor_id
| 否
|
| 门店ID
| isShopScreen
| 否
|
| 是否大屏显示
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ store | string | 非必须 |  | 库存 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ goods_id | string | 非必须 |  | 商品集合ID |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ regions_id | string | 非必须 |  |  |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ tax_rate | string | 非必须 |  | 税率 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  |  |
| ├─ item_main_cat_id | string | 非必须 |  |  |
| ├─ spec_pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ item_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ item_spec_desc | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ spec_images | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ spec_items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ attribute_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ distributor_sale_status | string | 非必须 |  |  |
| ├─ item_total_store | string | 非必须 |  |  |
| ├─ cross_border_tax | string | 非必须 |  | 商品跨境税费 |
| ├─ activity_type | string | 非必须 |  | 活动类型 full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购,group拼团,seckill秒杀,package打包,limited_time_sale限时特惠 |
| ├─ is_vip_grade | string | 非必须 |  |  |
| ├─ member_price | string | 非必须 |  |  |
| ├─ promotion_activity | string | 非必须 |  |  |
| ├─ promoter_price | string | 非必须 |  |  |
| ├─ rate_status | string | 非必须 |  |  |
获取商品会员价
基本信息
Path： /api/h5app/wxapp/goods/memberprice/{item_id}
Method： GET
接口描述：
获取商品会员价
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | string | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  |  |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 积分 |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  | 商品集合ID |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编码 |
| ├─ brief | string | 非必须 |  |  |
| ├─ price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  | 是否默认 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品id |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE: 指定日期范围内，DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ item_category | string | 非必须 |  | 商品主类目 |
| ├─ rebate_type | string | 非必须 |  | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  | 税率, 百分之～/100 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  | 分润类型 |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  |  |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  |  |
| ├─ consumeType | string | 非必须 |  |  |
| ├─ itemName | string | 非必须 |  |  |
| ├─ itemBn | string | 非必须 |  |  |
| ├─ companyId | string | 非必须 |  |  |
| ├─ item_main_cat_id | string | 非必须 |  |  |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ memberGrade | object | 非必须 |  |  |
| ├─ vipGrade | object | 非必须 |  |  |
| ├─ 1 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ mprice | string | 非必须 |  |  |
| ├─ 2 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ lv_type | string | 非必须 |  | 等级类型,可选值有 vip:普通vip;svip:进阶vip |
| ├─ mprice | string | 非必须 |  |  |
| ├─ grade | object | 非必须 |  |  |
| ├─ 4 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ mprice | string | 非必须 |  |  |
| ├─ 8 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ mprice | string | 非必须 |  |  |
| ├─ 26 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ mprice | string | 非必须 |  |  |
| ├─ 27 | object | 非必须 |  |  |
| ├─ vip_grade_id | string | 非必须 |  | 付费会员卡等级ID |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ mprice | string | 非必须 |  |  |
获取商品分享的数据
基本信息
Path： /api/h5app/wxapp/goods/share/items/{item_id}
Method： GET
接口描述：
获取商品分享的数据
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ brief | string | 非必须 |  | 商品简介 |
| ├─ price | string | 非必须 |  | 销售价 单位：分 |
| ├─ pics | string | 非必须 |  | 图片数组 包含字段 url:图片链接 isCode:是否生成分享码(bool) |
获取商品列表
基本信息
Path： /api/h5app/wxapp/goods/items
Method： GET
接口描述：
获取商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 是
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| distributor_id
| 否
|
| 店铺ID
| item_id
| 否
|
| 商品ID
| goods_id
| 否
|
| 产品ID，多规格商品不同规格的goods_id是一样的
| promoter_shop_id
| 否
|
| 分销店铺ID
| promoter_onsale
| 否
|
| 是否开启分销
| item_name
| 否
|
| 商品名称
| keywords
| 否
|
| 搜索关键词
| main_category
| 否
|
| 主类目ID
| tag_id
| 否
|
| 标签ID
| item_params[][attribute_id]
| 否
|
| 商品属性
| item_params[][attribute_value_id]
| 否
|
| 商品属性值
| regions_id
| 否
|
| 地区ID,逗号分隔
| start_price
| 否
|
| 最小金额
| end_price
| 否
|
| 最大金额
| brand_id
| 否
|
| 品牌ID
| item_type
| 否
|
| 商品类型
| goodsSort
| 否
|
| 排序方式
| is_default
| 否
|
| 是只获取否默认商品
| is_tdk
| 否
|
| 是否获取tdk信息，0不获取,1获取
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 商品总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | integer | 非必须 |  | 商品ID |
| ├─ item_type | string | 非必须 |  | 商品类型 |
| ├─ consume_type | string | 非必须 |  | 核销类型 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | integer | 非必须 |  | 商品库存 |
| ├─ barcode | string | 非必须 |  | 条形吗 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 |
| ├─ rebate | integer | 非必须 |  | 推广商品 1已选择 0未选择 2申请加入 3拒绝 |
| ├─ rebate_conf | string | 非必须 |  | 分佣计算方式 |
| ├─ cost_price | integer | 非必须 |  | 成本价 |
| ├─ is_point | boolean | 非必须 |  | 是否积分兑换 |
| ├─ point | integer | 非必须 |  | 积分个数 |
| ├─ item_source | string | 非必须 |  | 品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | integer | 非必须 |  | 产品ID |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ brief | string | 非必须 |  | 简洁的描述 |
| ├─ price | integer | 非必须 |  | 销售价 |
| ├─ market_price | integer | 非必须 |  | 原价 |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | number | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | integer | 非必须 |  | 商品排序 |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | integer | 非必须 |  | 默认商品ID |
| ├─ pics | string [] | 非必须 |  | 图片 |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ item_category | integer | 非必须 |  | 商品主类目 |
| ├─ weight | number | 非必须 |  | 商品重量 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ origincountry_id | integer | 非必须 |  | 产地国id |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ itemId | integer | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 商品编号 |
| ├─ companyId | integer | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ is_can_sale | boolean | 非必须 |  | 是否在本店可售 |
| ├─ goods_can_sale | boolean | 非必须 |  | 商品是否可售，有一个sku可售，那么商品就可售 |
| ├─ promoter_price | string | 非必须 |  | 预计返佣金金额 |
| ├─ promoter_point | string | 非必须 |  | 预计返佣金积分 |
| ├─ commission_type | string | 非必须 |  | 分佣返回类型： money 金额 point 积分 |
| ├─ type_labels | object [] | 非必须 |  |  |
item 类型: object
| ├─ itemId | integer | 非必须 |  | 商品ID |
| ├─ labelId | integer | 非必须 |  | 数值属性ID |
| ├─ labelName | string | 非必须 |  | 数值属性名称 |
| ├─ numType | string | 非必须 |  | 会员数值属性类型，plus：加，minux：减，multiple：乘 |
| ├─ num | integer | 非必须 |  | 数值属性值，例如买了50个次卡，就是填50；赠送了10个经验，就是填10 |
| ├─ companyId | integer | 非必须 |  | 公司ID |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ limitTime | integer | 非必须 |  | 有效期，例如30天 |
| ├─ labelPrice | integer | 非必须 |  | 价格,单位为‘分’ |
| ├─ isNotLimitNum | integer | 非必须 |  | 限制核销次数,1:不限制；2:限制 |
| ├─ origincountry_name | string | 非必须 |  | 产地国家名称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国家图标 |
| ├─ distributor_info | object | 非必须 |  |  |
| ├─ distributor_id | integer | 非必须 |  | 店铺ID |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ mobile | string | 非必须 |  | 店铺手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions_id | string [] | 非必须 |  | 国家行政区划编码组合 |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ regions | string [] | 非必须 |  | 地区名称组合 |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ child_count | integer | 非必须 |  | child_count |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ is_default | integer | 非必须 |  | 默认店铺 |
| ├─ is_ziti | boolean | 非必须 |  | 是否支持自提 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ auto_sync_goods | boolean | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ is_audit_goods | boolean | 非必须 |  | 是否审核店铺商品 |
| ├─ is_delivery | boolean | 非必须 |  | 是否支持配送 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ review_status | boolean | 非必须 |  | 入驻审核状态，0未审核，1已审核 |
| ├─ source_from | integer | 非必须 |  | 店铺来源，1管理端添加，2小程序申请入驻 |
| ├─ distributor_self | integer | 非必须 |  | 是否是总店配置 |
| ├─ is_distributor | boolean | 非必须 |  | 是否是主店铺 |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ is_domestic | integer | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | integer | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ wechat_work_department_id | integer | 非必须 |  | 企业微信的部门ID |
| ├─ regionauth_id | integer | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | integer | 非必须 |  | 平台服务费率 |
| ├─ select_tags_list | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ brand_list | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 品牌总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ attribute_id | integer | 非必须 |  | 商品属性id |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ shop_id | integer | 非必须 |  | 店铺ID，如果为0则表示总部 |
| ├─ attribute_type | string | 非必须 |  | 商品属性类型 |
| ├─ attribute_name | string | 非必须 |  | 商品属性名称 |
| ├─ attribute_memo | string | 非必须 |  | 商品属性备注 |
| ├─ attribute_sort | integer | 非必须 |  | 商品属性排序，越大越在前 |
| ├─ distributor_id | integer | 非必须 |  | 店铺ID |
| ├─ is_show | integer | 非必须 |  | 是否用于筛选 |
| ├─ is_image | integer | 非必须 |  | 属性是否需要配置图片 |
| ├─ image_url | string | 非必须 |  | 图片 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ attribute_code | string | 非必须 |  | oms 规格编码 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | 货币汇率ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ currency | string | 非必须 |  | 货币英文缩写 |
| ├─ title | string | 非必须 |  | 货币描述 |
| ├─ symbol | string | 非必须 |  | 货币符号 |
| ├─ rate | string | 非必须 |  | 货币汇率(与人民币) |
| ├─ is_default | string | 非必须 |  | 是否默认货币 |
| ├─ use_platform | string | 非必须 |  | 适用端 |
| ├─ tdk_data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ mate_description | string | 非必须 |  | 描述 |
| ├─ mate_keywords | string | 非必须 |  | 关键字 |
检查是否可以分享
基本信息
Path： /api/h5app/wxapp/goods/checkshare/items
Method： GET
接口描述：
检查当前会员是否可以分享
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ status | boolean | 非必须 |  | 状态 |
| ├─ msg | string | 非必须 |  | 分享限制提示语 |
| ├─ page | string | 非必须 |  | 提示后跳转页面路径 |
获取商品详情
基本信息
Path： /api/h5app/wxapp/goods/items/{item_id}
Method： GET
接口描述：
获取商品详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
路径参数
参数名称
示例
备注
| item_id
|
| 商品id
Query
参数名称
是否必须
示例
备注
| goods_id
| 否
|
| 产品ID，多规格商品不同规格的goods_id是一样的
| distributor_id
| 否
|
| 门店ID
| isShopScreen
| 否
|
| 是否大屏显示
| is_tdk
| 否
|
| 是否获取tdk信息，0不获取,1获取
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ item_id | string | 非必须 |  | 商品id |
| ├─ item_type | string | 非必须 |  | 商品类型，services：服务商品，normal: 普通商品 |
| ├─ consume_type | string | 非必须 |  | 核销类型，every：每个物料都要核销(例如3个物料要核销3次)，all：所有物料作为一个整体核销一次(例如3个物料只需要核销1次) |
| ├─ is_show_specimg | string | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | string | 非必须 |  | 库存 |
| ├─ barcode | string | 非必须 |  | 商品条形码 |
| ├─ sales | string | 非必须 |  | 商品销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 onsale 前台可销售，offline_sale可线下销售，instock 不可销售 |
| ├─ rebate | string | 非必须 |  | 单个分销金额，以分为单位 |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ cost_price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ is_point | string | 非必须 |  | 是否积分兑换 true可以 false不可以 |
| ├─ point | string | 非必须 |  | 积分 |
| ├─ item_source | string | 非必须 |  | 商品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | string | 非必须 |  | 商品集合ID |
| ├─ brand_id | string | 非必须 |  | 品牌id |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ brief | string | 非必须 |  |  |
| ├─ price | string | 非必须 |  | 价格,单位为‘分’ |
| ├─ market_price | string | 非必须 |  | 原价,单位为‘分’ |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | string | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  |  |
| ├─ brand_logo | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ templates_id | string | 非必须 |  | 运费模板id |
| ├─ is_default | string | 非必须 |  | 是否默认货币 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | string | 非必须 |  | 默认商品ID |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ enable_agreement | string | 非必须 |  | 开启购买协议 |
| ├─ date_type | string | 非必须 |  |  |
| ├─ item_category | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ rebate_type | string | 非必须 |  | 返佣模式 |
| ├─ weight | string | 非必须 |  | 商品重量 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ tax_rate | string | 非必须 |  | 税率 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ video_type | string | 非必须 |  | 视频类型 local:本地视频 tencent:腾讯视频 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ purchase_agreement | string | 非必须 |  | 购买协议 |
| ├─ intro | string | 非必须 |  | 图文详情 |
| ├─ audit_status | string | 非必须 |  | 审核状态 approved成功 processing审核中 rejected审核拒绝 |
| ├─ audit_reason | string | 非必须 |  | 审核拒绝原因 |
| ├─ is_gift | string | 非必须 |  | 是否为赠品 |
| ├─ is_package | string | 非必须 |  | 是否为打包产品 |
| ├─ profit_type | string | 非必须 |  |  |
| ├─ profit_fee | string | 非必须 |  | 分润金额,单位为分 冗余字段 |
| ├─ is_profit | string | 非必须 |  | 是否支持分润 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ origincountry_id | string | 非必须 |  | 产地国id |
| ├─ taxstrategy_id | string | 非必须 |  | 税费策略id |
| ├─ taxation_num | string | 非必须 |  | 计税单位份数 |
| ├─ type | string | 非必须 |  |  |
| ├─ item_en_name | string | 非必须 |  | 商品英文名称 |
| ├─ is_package_items | string | 非必须 |  | 是否组合商品 |
| ├─ tdk_content | string | 非必须 |  | tdk详情 |
| ├─ itemId | string | 非必须 |  |  |
| ├─ consumeType | string | 非必须 |  |  |
| ├─ itemName | string | 非必须 |  |  |
| ├─ itemBn | string | 非必须 |  |  |
| ├─ companyId | string | 非必须 |  |  |
| ├─ item_main_cat_id | string | 非必须 |  |  |
| ├─ type_labels | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ spec_pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ item_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ item_spec_desc | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ spec_images | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ spec_items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ attribute_ids | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ attr_values_custom | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ item_category_main | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 类目名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string | 非必须 |  | 商品参数 |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ item_category_info | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 类目名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父分类id,顶级为0 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ children | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 名称 |
| ├─ label | string | 非必须 |  | 地区名称 |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序，数字越大越靠前 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string | 非必须 |  | 商品参数 |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ level | string | 非必须 |  |  |
| ├─ videos_url | string | 非必须 |  |  |
| ├─ distributor_sale_status | string | 非必须 |  |  |
| ├─ item_total_store | string | 非必须 |  |  |
| ├─ distributor_info | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ origincountry_name | string | 非必须 |  | 产地国名称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国国旗 |
| ├─ cross_border_tax | string | 非必须 |  | 商品跨境税费 |
| ├─ activity_type | string | 非必须 |  | 活动类型 full_discount:满折,full_minus:满减,full_gift:满赠,self_select:任选优惠,plus_price_buy:加价购,group拼团,seckill秒杀,package打包,limited_time_sale限时特惠 |
| ├─ guide_title_desc | string | 非必须 |  |  |
| ├─ grade_name | string | 非必须 |  | 等级名称 |
| ├─ is_vip_grade | string | 非必须 |  |  |
| ├─ member_price | string | 非必须 |  |  |
| ├─ vipgrade_guide_title | object | 非必须 |  |  |
| ├─ vipgrade_desc | string | 非必须 |  |  |
| ├─ gradeDiscount | string | 非必须 |  |  |
| ├─ guide_title_desc | string | 非必须 |  |  |
| ├─ vipgrade_name | string | 非必须 |  |  |
| ├─ promotion_activity | string | 非必须 |  |  |
| ├─ promoter_price | string | 非必须 |  |  |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ currency | string | 非必须 |  | 货币类型 |
| ├─ title | string | 非必须 |  | 货币描述 |
| ├─ symbol | string | 非必须 |  | 货币符号 |
| ├─ rate | string | 非必须 |  | 货币汇率(与人民币) |
| ├─ is_default | string | 非必须 |  | 是否默认货币  |
| ├─ use_platform | string | 非必须 |  | 适用端。可选值为 service,normal |
| ├─ kaquan_list | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ pagers | object | 非必须 |  |  |
| ├─ total | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ card_id | string | 非必须 |  | 卡券id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ card_type | string | 非必须 |  | 卡券类型，可选值有，discount:折扣券;cash:代金券;gift:兑换券 |
| ├─ brand_name | string | 非必须 |  | 商户名称 |
| ├─ logo_url | string | 非必须 |  | 卡券商户 logo |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ color | string | 非必须 |  | 券颜色值 |
| ├─ notice | string | 非必须 |  | 卡券使用提醒,最大16汉字 |
| ├─ description | string | 非必须 |  | 描述 |
| ├─ date_type | string | 非必须 |  | 有效期的类型, DATE_TYPE_FIX_TIME_RANGE:指定日期范围内, DATE_TYPE_FIX_TERM:固定天数后 |
| ├─ begin_date | string | 非必须 |  | 有效期开始时间 |
| ├─ end_date | string | 非必须 |  | 有效期结束时间 | 会员到期时间 |
| ├─ fixed_term | string | 非必须 |  | 有效期的有效天数 |
| ├─ service_phone | string | 非必须 |  | 客服电话 |
| ├─ center_title | string | 非必须 |  | 卡券顶部居中的按钮，仅在卡券状态正常(可以核销)时显示 |
| ├─ center_sub_title | string | 非必须 |  | 显示在入口下方的提示语 |
| ├─ center_url | string | 非必须 |  | 顶部居中的url |
| ├─ custom_url_name | string | 非必须 |  | 自定义跳转外链的入口名字 |
| ├─ custom_url | string | 非必须 |  | 自定义跳转的URL |
| ├─ custom_url_sub_title | string | 非必须 |  | 显示在入口右侧的提示语 |
| ├─ promotion_url_name | string | 非必须 |  | 营销场景的自定义入口名称 |
| ├─ promotion_url | string | 非必须 |  | 营销场景的自定义入口url |
| ├─ promotion_url_sub_title | string | 非必须 |  | 营销入口右侧的提示语 |
| ├─ get_limit | string | 非必须 |  | 每人可领券的数量限制 |
| ├─ use_limit | string | 非必须 |  | 每人可核销的数量限制 |
| ├─ can_share | string | 非必须 |  | 卡券领取页面是否可分享 |
| ├─ can_give_friend | string | 非必须 |  | 卡券是否可转赠 |
| ├─ abstract | string | 非必须 |  | 封面摘要 |
| ├─ icon_url_list | string | 非必须 |  | 封面图片 |
| ├─ text_image_list | string | 非必须 |  | 图文列表(DC2Type:array) |
| ├─ time_limit | string | 非必须 |  | 使用时段限制(DC2Type:array) |
| ├─ gift | string | 非必须 |  | 兑换券兑换内容名称 |
| ├─ default_detail | string | 非必须 |  | 优惠券优惠详情 |
| ├─ discount | string | 非必须 |  | 折扣值 |
| ├─ least_cost | string | 非必须 |  | 代金券起用金额 |
| ├─ reduce_cost | string | 非必须 |  | 代金券减免金额 or 兑换券起用金额 |
| ├─ deal_detail | string | 非必须 |  | 团购券详情 |
| ├─ accept_category | string | 非必须 |  | 指定可用的商品类目,代金券专用 |
| ├─ reject_category | string | 非必须 |  | 指定不可用的商品类目,代金券专用 |
| ├─ object_use_for | string | 非必须 |  | 购买xx可用类型门槛，仅用于兑换 |
| ├─ can_use_with_other_discount | string | 非必须 |  | 是否可与其他优惠共享 |
| ├─ quantity | string | 非必须 |  | 卡券总库存 |
| ├─ use_all_shops | string | 非必须 |  | 是否适用所有门店 |
| ├─ rel_shops_ids | string | 非必须 |  | 适用的门店 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ use_scenes | string | 非必须 |  | 核销场景。可选值有，ONLINE:线上商城(兑换券不可使用);QUICK:快捷买单(兑换券不可使用);SWEEP:门店支付(扫码核销);SELF:到店支付(自助核销) |
| ├─ receive | string | 非必须 |  | 是否前台直接领取 |
| ├─ self_consume_code | string | 非必须 |  | 自助核销验证码 |
| ├─ use_platform | string | 非必须 |  |  |
| ├─ most_cost | string | 非必须 |  | 代金券最高消费限额 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ use_bound | string | 非必须 |  | 适用范围: 0:全场可用,1:指定商品可用,2:指定分类可用,3:指定商品标签可用,4:指定商品品牌可用 |
| ├─ tag_ids | string | 非必须 |  | 标签id集合 |
| ├─ brand_ids | string | 非必须 |  | 品牌id集合 |
| ├─ apply_scope | string | 非必须 |  | 适用范围 |
| ├─ card_code | string | 非必须 |  | 优惠券模板ID-第三方使用 |
| ├─ card_rule_code | string | 非必须 |  | 优惠券规则ID-第三方使用 |
| ├─ get_num | string | 非必须 |  | 被领取数量 |
| ├─ use_num | string | 非必须 |  |  |
| ├─ no_post | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ rate_status | string | 非必须 |  |  |
| ├─ recommend_items | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ tdk_data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ mate_description | string | 非必须 |  | 描述 |
| ├─ mate_keywords | string | 非必须 |  | 关键字 |
获取导购货架商品列表
基本信息
Path： /api/h5app/wxapp/goods/salesperson/items
Method： GET
接口描述：
获取导购货架商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| page
| 是
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 是
|
| 每页数量,最大不能超过50
| distributor_id
| 否
|
| 店铺ID
| keywords
| 否
|
| 搜索关键词
| category
| 否
|
| 分类ID，只查询当前分类
| item_type
| 否
|
| 商品类型 normal:普通商品 services:服务商品
| goodsSort
| 否
|
| 排序方式 1:销量倒序 2:价格倒序 3:价格正序 4:创建时间倒序
| is_default
| 否
|
| 是只获取否默认商品，默认true
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 商品总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | integer | 非必须 |  | 商品ID |
| ├─ item_type | string | 非必须 |  | 商品类型 |
| ├─ consume_type | string | 非必须 |  | 核销类型 |
| ├─ is_show_specimg | boolean | 非必须 |  | 详情页是否显示规格图片 |
| ├─ store | integer | 非必须 |  | 商品库存 |
| ├─ barcode | string | 非必须 |  | 条形吗 |
| ├─ sales | integer | 非必须 |  | 销量 |
| ├─ approve_status | string | 非必须 |  | 商品状态 |
| ├─ rebate | integer | 非必须 |  | 推广商品 1已选择 0未选择 2申请加入 3拒绝 |
| ├─ rebate_conf | string | 非必须 |  | 分佣计算方式 |
| ├─ cost_price | integer | 非必须 |  | 成本价 |
| ├─ is_point | boolean | 非必须 |  | 是否积分兑换 |
| ├─ point | integer | 非必须 |  | 积分个数 |
| ├─ item_source | string | 非必须 |  | 品来源:mall:主商城，distributor:店铺自有 |
| ├─ goods_id | integer | 非必须 |  | 产品ID |
| ├─ item_name | string | 非必须 |  | 商品名称 |
| ├─ item_unit | string | 非必须 |  | 商品计量单位 |
| ├─ item_bn | string | 非必须 |  | 商品编号 |
| ├─ brief | string | 非必须 |  | 简洁的描述 |
| ├─ price | integer | 非必须 |  | 销售价 |
| ├─ market_price | integer | 非必须 |  | 原价 |
| ├─ special_type | string | 非必须 |  | 商品特殊类型 drug 处方药 normal 普通商品 |
| ├─ goods_function | string | 非必须 |  | 商品功能 |
| ├─ goods_series | string | 非必须 |  | 商品系列 |
| ├─ volume | number | 非必须 |  | 商品体积 |
| ├─ goods_color | string | 非必须 |  | 商品颜色 |
| ├─ goods_brand | string | 非必须 |  | 商品品牌 |
| ├─ item_address_province | string | 非必须 |  | 产地省 |
| ├─ item_address_city | string | 非必须 |  | 产地市 |
| ├─ regions_id | string | 非必须 |  | 产地地区id |
| ├─ brand_logo | string | 非必须 |  | 品牌图片 |
| ├─ sort | integer | 非必须 |  | 商品排序 |
| ├─ templates_id | integer | 非必须 |  | 运费模板id |
| ├─ is_default | boolean | 非必须 |  | 商品是否为默认商品 |
| ├─ nospec | string | 非必须 |  | 商品是否为单规格 |
| ├─ default_item_id | integer | 非必须 |  | 默认商品ID |
| ├─ pics |  [] | 非必须 |  | 图片 |
| ├─  |  | 非必须 |  |  |
| ├─ distributor_id | integer | 非必须 |  | 店铺id |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ item_category | integer | 非必须 |  | 商品主类目 |
| ├─ weight | number | 非必须 |  | 商品重量 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ videos | string | 非必须 |  | 视频 |
| ├─ video_pic_url | string | 非必须 |  | 视频封面图 |
| ├─ origincountry_id | integer | 非必须 |  | 产地国id |
| ├─ type | integer | 非必须 |  | 商品类型，0普通，1跨境商品，可扩展 |
| ├─ itemId | integer | 非必须 |  | 商品ID |
| ├─ consumeType | string | 非必须 |  | 核销类型 |
| ├─ itemName | string | 非必须 |  | 商品名称 |
| ├─ itemBn | string | 非必须 |  | 商品编号 |
| ├─ companyId | integer | 非必须 |  | 公司ID |
| ├─ item_main_cat_id | integer | 非必须 |  | 商品主类目 |
| ├─ is_can_sale | boolean | 非必须 |  | 是否在本店可售 |
| ├─ goods_can_sale | boolean | 非必须 |  | 商品是否可售，有一个sku可售，那么商品就可售 |
| ├─ type_labels | object [] | 非必须 |  |  |
item 类型: object
| ├─ itemId | integer | 非必须 |  | 商品ID |
| ├─ labelId | integer | 非必须 |  | 数值属性ID |
| ├─ labelName | string | 非必须 |  | 数值属性名称 |
| ├─ numType | string | 非必须 |  | 会员数值属性类型，plus：加，minux：减，multiple：乘 |
| ├─ num | integer | 非必须 |  | 数值属性值，例如买了50个次卡，就是填50；赠送了10个经验，就是填10 |
| ├─ companyId | integer | 非必须 |  | 公司ID |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ limitTime | integer | 非必须 |  | 有效期，例如30天 |
| ├─ labelPrice | integer | 非必须 |  | 价格,单位为‘分’ |
| ├─ isNotLimitNum | integer | 非必须 |  | 限制核销次数,1:不限制；2:限制 |
| ├─ origincountry_name | string | 非必须 |  | 产地国家名称 |
| ├─ origincountry_img_url | string | 非必须 |  | 产地国家图标 |
| ├─ distributor_info | object | 非必须 |  |  |
| ├─ distributor_id | integer | 非必须 |  | 店铺ID |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ mobile | string | 非必须 |  | 店铺手机号 |
| ├─ address | string | 非必须 |  | 店铺地址 |
| ├─ name | string | 非必须 |  | 店铺名称 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ is_valid | string | 非必须 |  | 店铺是否有效 |
| ├─ province | string | 非必须 |  | 省 |
| ├─ city | string | 非必须 |  | 市 |
| ├─ area | string | 非必须 |  | 区 |
| ├─ regions_id |  [] | 非必须 |  | 国家行政区划编码组合 |
| ├─  |  | 非必须 |  |  |
| ├─ regions |  [] | 非必须 |  | 地区名称组合 |
| ├─  |  | 非必须 |  |  |
| ├─ contact | string | 非必须 |  | 联系人名称 |
| ├─ child_count | integer | 非必须 |  | child_count |
| ├─ shop_id | integer | 非必须 |  | 门店id |
| ├─ is_default | integer | 非必须 |  | 默认店铺 |
| ├─ is_ziti | boolean | 非必须 |  | 是否支持自提 |
| ├─ lng | string | 非必须 |  | 腾讯地图纬度 |
| ├─ lat | string | 非必须 |  | 腾讯地图经度 |
| ├─ hour | string | 非必须 |  | 营业时间 |
| ├─ auto_sync_goods | boolean | 非必须 |  | 自动同步总部商品 |
| ├─ logo | string | 非必须 |  | 店铺logo |
| ├─ banner | string | 非必须 |  | 店铺banner |
| ├─ is_audit_goods | boolean | 非必须 |  | 是否审核店铺商品 |
| ├─ is_delivery | boolean | 非必须 |  | 是否支持配送 |
| ├─ shop_code | string | 非必须 |  | 店铺号 |
| ├─ review_status | boolean | 非必须 |  | 入驻审核状态，0未审核，1已审核 |
| ├─ source_from | integer | 非必须 |  | 店铺来源，1管理端添加，2小程序申请入驻 |
| ├─ distributor_self | integer | 非必须 |  | 是否是总店配置 |
| ├─ is_distributor | boolean | 非必须 |  | 是否是主店铺 |
| ├─ contract_phone | string | 非必须 |  | 其他联系方式 |
| ├─ is_domestic | integer | 非必须 |  | 是否是中国国内门店 1:国内(包含港澳台),2:非国内 |
| ├─ is_direct_store | integer | 非必须 |  | 是否为直营店 1:直营店,2:非直营店 |
| ├─ wechat_work_department_id | integer | 非必须 |  | 企业微信的部门ID |
| ├─ regionauth_id | integer | 非必须 |  | 区域id |
| ├─ is_open | string | 非必须 |  | 是否开启分账 |
| ├─ rate | integer | 非必须 |  | 平台服务费率 |
| ├─ select_tags_list |  [] | 非必须 |  |  |
| ├─  |  | 非必须 |  |  |
| ├─ brand_list | object | 非必须 |  |  |
| ├─ total_count | integer | 非必须 |  | 品牌总数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ attribute_id | integer | 非必须 |  | 商品属性id |
| ├─ company_id | integer | 非必须 |  | 公司ID |
| ├─ shop_id | integer | 非必须 |  | 店铺ID，如果为0则表示总部 |
| ├─ attribute_type | string | 非必须 |  | 商品属性类型 |
| ├─ attribute_name | string | 非必须 |  | 商品属性名称 |
| ├─ attribute_memo | string | 非必须 |  | 商品属性备注 |
| ├─ attribute_sort | integer | 非必须 |  | 商品属性排序，越大越在前 |
| ├─ distributor_id | integer | 非必须 |  | 店铺ID |
| ├─ is_show | integer | 非必须 |  | 是否用于筛选 |
| ├─ is_image | integer | 非必须 |  | 属性是否需要配置图片 |
| ├─ image_url | string | 非必须 |  | 图片 |
| ├─ created | integer | 非必须 |  | 创建时间 |
| ├─ updated | integer | 非必须 |  | 更新时间 |
| ├─ attribute_code | string | 非必须 |  | oms 规格编码 |
| ├─ cur | object | 非必须 |  |  |
| ├─ id | string | 非必须 |  | 货币汇率ID |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ currency | string | 非必须 |  | 货币英文缩写 |
| ├─ title | string | 非必须 |  | 货币描述 |
| ├─ symbol | string | 非必须 |  | 货币符号 |
| ├─ rate | string | 非必须 |  | 货币汇率(与人民币) |
| ├─ is_default | string | 非必须 |  | 是否默认货币 |
| ├─ use_platform | string | 非必须 |  | 适用端 |
| ├─ tdk_data | object | 非必须 |  |  |
| ├─ title | string | 非必须 |  | 标题 |
| ├─ mate_description | string | 非必须 |  | 描述 |
| ├─ mate_keywords | string | 非必须 |  | 关键字 |
获取导购货架商品详情
基本信息
Path： /api/h5app/wxapp/goods/salesperson/itemsinfo
Method： GET
接口描述：
获取导购货架商品详情
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| x-wxapp-session
|
| 是
|
| 导购token，workwechatlogin返回的session3rd值
| salesperson-type
|
| 是
|
| 登陆类型
Query
参数名称
是否必须
示例
备注
| goods_id
| 否
|
| 当商品id
| item_id
| 是
|
| 货品id
返回数据
名称类型是否必须默认值备注其他信息
|  data | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  |  |
| ├─ brief | string | 非必须 |  |  |
| ├─ price | string | 非必须 |  |  |
| ├─ market_price | string | 非必须 |  |  |
| ├─ intro | string | 非必须 |  |  |
| ├─ pics | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
获取小店上架分类
基本信息
Path： /api/h5app/wxapp/goods/shopcategorylevel
Method： GET
接口描述：
获取小店上架分类
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 否
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| shop_user_id
| 否
|
| userId
| distributor_id
| 否
|
| 分销商id
| is_main_category
| 否
|
| 是否主目录
| category_level
| 否
|
| 等级
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  |  |
| ├─ category_id | string | 非必须 |  | 分类id |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ category_name | string | 非必须 |  | 分类名称 |
| ├─ label | string | 非必须 |  |  |
| ├─ parent_id | string | 非必须 |  | 父级id, 0为顶级 |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ path | string | 非必须 |  | 路径 |
| ├─ sort | string | 非必须 |  | 排序 |
| ├─ is_main_category | string | 非必须 |  | 是否为商品主类目 |
| ├─ goods_params | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ goods_spec | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ category_level | string | 非必须 |  | 分类等级 |
| ├─ image_url | string | 非必须 |  | 元素配图 |
| ├─ crossborder_tax_rate | string | 非必须 |  | 跨境税率，百分比，小数点2位 |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  | 修改时间 |
| ├─ category_code | string | 非必须 |  | 分类编码 |
获取小店上架商品列表
基本信息
Path： /api/h5app/wxapp/goods/shopitems
Method： GET
接口描述：
获取小店上架商品列表
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| page
| 否
|
| 当前页面,获取商品列表的初始偏移位置，从1开始计数
| pageSize
| 否
|
| 每页数量,最大不能超过50，并且如果传入的limit参数是0，那么按默认值20处理
| keywords
| 否
|
| 搜索关键字
| shop_user_id
| 否
|
| userId
| goodsSort
| 否
|
| 排序方式
| category_id
| 否
|
| 分类ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  |  |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ item_id | string | 非必须 |  |  |
| ├─ item_type | string | 非必须 |  |  |
| ├─ consume_type | string | 非必须 |  |  |
| ├─ is_show_specimg | string | 非必须 |  |  |
| ├─ store | string | 非必须 |  |  |
| ├─ barcode | string | 非必须 |  |  |
| ├─ sales | string | 非必须 |  |  |
| ├─ approve_status | string | 非必须 |  |  |
| ├─ rebate | string | 非必须 |  |  |
| ├─ rebate_conf | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ cost_price | string | 非必须 |  |  |
| ├─ is_point | string | 非必须 |  |  |
| ├─ point | string | 非必须 |  |  |
| ├─ item_source | string | 非必须 |  |  |
| ├─ goods_id | string | 非必须 |  |  |
| ├─ brand_id | string | 非必须 |  |  |
| ├─ item_name | string | 非必须 |  |  |
| ├─ item_unit | string | 非必须 |  |  |
| ├─ item_bn | string | 非必须 |  |  |
| ├─ brief | string | 非必须 |  |  |
| ├─ price | string | 非必须 |  |  |
| ├─ market_price | string | 非必须 |  |  |
| ├─ special_type | string | 非必须 |  |  |
| ├─ goods_function | string | 非必须 |  |  |
| ├─ goods_series | string | 非必须 |  |  |
| ├─ volume | string | 非必须 |  |  |
| ├─ goods_color | string | 非必须 |  |  |
| ├─ goods_brand | string | 非必须 |  |  |
| ├─ item_address_province | string | 非必须 |  |  |
| ├─ item_address_city | string | 非必须 |  |  |
| ├─ regions_id | string | 非必须 |  |  |
| ├─ brand_logo | string | 非必须 |  |  |
| ├─ sort | string | 非必须 |  |  |
| ├─ templates_id | string | 非必须 |  |  |
| ├─ is_default | string | 非必须 |  |  |
| ├─ nospec | string | 非必须 |  |  |
| ├─ default_item_id | string | 非必须 |  |  |
| ├─ pics | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
| ├─ distributor_id | string | 非必须 |  |  |
| ├─ company_id | string | 非必须 |  |  |
| ├─ enable_agreement | string | 非必须 |  |  |
| ├─ date_type | string | 非必须 |  |  |
| ├─ item_category | string | 非必须 |  |  |
| ├─ rebate_type | string | 非必须 |  |  |
| ├─ weight | string | 非必须 |  |  |
| ├─ begin_date | string | 非必须 |  |  |
| ├─ end_date | string | 非必须 |  |  |
| ├─ fixed_term | string | 非必须 |  |  |
| ├─ tax_rate | string | 非必须 |  |  |
| ├─ created | string | 非必须 |  |  |
| ├─ updated | string | 非必须 |  |  |
| ├─ video_type | string | 非必须 |  |  |
| ├─ videos | string | 非必须 |  |  |
| ├─ video_pic_url | string | 非必须 |  |  |
| ├─ audit_status | string | 非必须 |  |  |
| ├─ audit_reason | string | 非必须 |  |  |
| ├─ is_gift | string | 非必须 |  |  |
| ├─ is_package | string | 非必须 |  |  |
| ├─ profit_type | string | 非必须 |  |  |
| ├─ profit_fee | string | 非必须 |  |  |
| ├─ is_profit | string | 非必须 |  |  |
| ├─ crossborder_tax_rate | string | 非必须 |  |  |
| ├─ origincountry_id | string | 非必须 |  |  |
| ├─ taxstrategy_id | string | 非必须 |  |  |
| ├─ taxation_num | string | 非必须 |  |  |
| ├─ type | string | 非必须 |  |  |
| ├─ item_en_name | string | 非必须 |  |  |
| ├─ is_package_items | string | 非必须 |  |  |
| ├─ tdk_content | string | 非必须 |  |  |
| ├─ itemId | string | 非必须 |  |  |
| ├─ consumeType | string | 非必须 |  |  |
| ├─ itemName | string | 非必须 |  |  |
| ├─ itemBn | string | 非必须 |  |  |
| ├─ companyId | string | 非必须 |  |  |
| ├─ item_main_cat_id | string | 非必须 |  |  |
获取热门关键词
基本信息
Path： /api/h5app/wxapp/goods/keywords
Method： GET
接口描述：
获取热门关键词
请求参数
Headers
参数名称
参数值
是否必须
示例
备注
| Authorization
|
| 是
|
| JWT验证token
Query
参数名称
是否必须
示例
备注
| distributor_id
| 是
|
| 门店ID
返回数据
名称类型是否必须默认值备注其他信息
|  data | object | 非必须 |  |  |
| ├─ total_count | string | 非必须 |  | 总条数 |
| ├─ list | object [] | 非必须 |  |  |
item 类型: object
| ├─ id | string | 非必须 |  | 自行更改字段描述 |
| ├─ company_id | string | 非必须 |  | 公司id |
| ├─ distributor_id | string | 非必须 |  | 分销商id |
| ├─ content | string | 非必须 |  | 内容 |
| ├─ content | string [] | 非必须 |  |  |
item 类型: string
| ├─  |  | 非必须 |  |  |
Build by YMFE.