IconCreated with Sketch.

YAPI 接口文档

YApi
  • 基础接口
    • apple登陆
    • 主题类型
    • 获取个人中心菜单
    • 图片上传
    • 获取登录授权logo
    • 获取网站基础配置
    • 获取配置是否强制绑定手机号
    • 门店自提开启状态
    • 公众号支付回调
    • 小程序支付回调
    • 支付回调
    • 图片验证码
    • 获取发短信的code
    • 验证码发送
    • 手机号注册
    • 手机号验证码登录
    • 账号密码登陆
    • 手机号修改密码
    • 绑定手机号
    • 记录用户分享
    • 分享配置
    • 获取图片base64
    • 海报二维码
    • 优惠券列表_copy(已废弃)
    • 添加登录用户的访问记录
    • 用户关键字分享
    • 复制口令接口
  • 首页
    • 首页商品列表
    • 首页DIY数据
    • 获取底部导航
    • 优惠券列表
    • 今日优惠券弹窗
    • 首页产品的轮播图和产品信息(弃用)
    • 热门搜索关键字获取(弃用)
    • 首页获取拼团数据(弃用)
  • 文章
    • 最新文章(弃用)
    • 文章分类列表
    • 文章列表
    • 文章详情
    • 文章 热门列表
    • 文章 轮播列表
  • 商品
    • 产品分享二维码 推广员
    • 产品评价数量和好评度
    • 商品详情
    • 获取产品评论
    • 商品分类
    • 为你推荐
  • 优惠券
    • 优惠券列表
    • 我的优惠券
    • 批量领取优惠券
    • 新人优惠券
    • 领取优惠券
  • 签到
    • 签到
    • 签到列表
    • 签到列表(年月)
    • 签到用户信息
    • 签到配置
  • 秒杀
    • 秒杀产品时间区间
    • 秒杀产品列表
    • 秒杀产品详情
  • 拼团
    • 拼团列表
    • 拼团列表页轮播图
    • 拼团 开团
    • 拼团 取消开团
    • 拼团海报
    • 拼团产品详情
    • 获取拼团小程序二维码
    • 获取拼团海报详细信息
  • 预售
    • 预售列表
    • 预售商品详情
  • 砍价
    • 砍价产品详情
    • 开启砍价用户信息
    • 砍价列表(已参与)
    • 砍价 开启
    • 砍价 观看/分享/参与次数
    • 砍价取消
    • 砍价 帮助好友砍价
    • 砍价 砍掉金额
    • 砍价 砍价帮
    • 砍价 砍价帮总人数、剩余金额、进度条、已经砍掉的价格
    • 砍价海报
    • 获取砍价海报详细信息(废弃)
    • 砍价列表
  • 购物车
    • 商品规格(新)
    • 购物车 修改产品数量
    • 购物车 列表
    • 购物车 删除
    • 购物车 添加
    • 购物车 获取数量
    • 购物车修改(新)
    • 购物车重选
  • 积分商城
    • 兑换记录
    • 抽奖页面
    • 用户抽奖
    • 积分商品列表
    • 积分商品详情
    • 积分商城首页
    • 领取抽奖商品
  • 订单
    • 计算订单金额
    • 退款订单详情
    • 订单确认
    • 订单创建
    • 订单支付
    • 订单取消
    • 订单 再次下单
    • 订单统计数据
    • 订单列表
    • 订单详情
    • 删除已完成订单
    • 订单收货
    • 订单查看物流
    • 订单评价
    • 订单可以使用优惠券列表
    • 订单退款理由
    • 订单退款申请
    • 订单产品信息
    • 下单之后赠送优惠劵(商品关联优惠劵)
    • 获取未支付订单(废弃)
    • 门店列表
    • 支付宝支付
  • 微信
    • 小程序登陆
    • 微信App登陆
    • 收集小程序form_id
    • 公众号静默授权(不登录)
    • 公众号静默授权(登录)
    • 公众号静默授权直接绑定手机号
    • 小程序静默授权(不登录)
    • 小程序静默授权(登录)
    • 授权获取小程序用户手机号直接绑定
    • 小程序手机号验证码登录静默授权绑定
    • 微信公众号是否关注
    • 公众号服务
    • 小程序订阅消息列表
    • 获取直播回放
    • 获取直播间列表
    • 微信授权
    • 微信授权登录_新
    • 小程序授权登录_新
    • 获取微信公众号js配置
  • 用户
    • 个人中心
    • 修改用户信息_新
    • 修改绑定手机号
    • 当前登录用户信息
    • 检测登录code
    • 清除用户搜索记录
    • 用户修改信息
    • 用户修改手机号
    • 用户搜索记录
    • 用户绑定手机号
    • 用户资金统计
    • 获取分销海报详细信息
    • 获取小程序二维码
    • 获取用户和客服聊天列表
    • 设置登录code
    • 退出登录
    • 静默绑定推广人
    • 切换H5登陆
  • 客服
    • 保存客服反馈内容
    • 客服列表
    • 客服聊天记录
    • 客服聊天记录版本2
    • 获取客服反馈头部文字信息
    • 获取客服页面广告(已废弃)
  • 个人中心->付费会员
    • 会员优惠券
    • 会员卡主界面
    • 卡密领取会员卡
    • 线下扫码付款
    • 线下支付方式
    • 获取会员时长
    • 计算会员线下付款金额
    • 购买会员卡
  • 个人中心->发票管理
    • 删除发票
    • 开票详情
    • 用户单个发票详情
    • 用户发票列表
    • 用户开票记录
    • 用户添加|修改发票
    • 用户设置默认发票
    • 获取用户默认发票
    • 订单申请开票
  • 个人中心->积分中心
    • 积分记录
  • 个人中心->我的等级
    • 会员经验列表
    • 检测用户是否可以升级
    • 用户等级列表
    • 用户等级详情信息
    • 获取等级任务
  • 个人中心->统计管理
    • 获取物流公司
    • 获取物流公司模板
    • 获取订单打印默认配置
    • 订单交易额/订单数量时间统计
    • 订单列表
    • 订单发货提交
    • 订单发货获取订单信息
    • 订单备注
    • 订单支付
    • 订单改价
    • 订单数据统计
    • 订单每月统计数据
    • 订单详情
    • 订单退款
    • 配送员列表(全部)
    • 物流公司列表
  • 个人中心->我的推广
    • 佣金排行
    • 推广人排行
    • 推广佣金/提现总和
    • 推广佣金明细
    • 推广分销二维码海报生成
    • 推广数据接口(昨天的佣金 累计提现金额 当前佣金)
    • 推广用户
    • 推广订单
    • 提现申请
    • 提现银行/提现最低金额
  • 个人中心->地址信息
    • 修改/添加地址
    • 删除地址
    • 地址列表
    • 获取单个地址
    • 获取默认地址
    • 设置默认地址
    • 获取城市数据
  • 个人中心->我的收藏
    • 取消收藏产品
    • 批量收藏
    • 收藏列表
    • 添加收藏产品
  • 个人中心->消息中心
    • 消息列表
  • 个人中心->我的余额
    • 充值额度选择
    • 公众号充值
    • 小程序充值
    • 统一充值
    • 活动状态
  • PC端
    • PC获取收藏列表
    • PC订单列表
    • PC购物车
    • 余额记录
    • 商品列表
    • 商品详情小程序码
    • 城市数据
    • 微信关注二维码
    • 扫码授权
    • 扫码支付轮询接口
    • 扫码登录key
    • 推荐商品列表
    • 检测扫码情况
    • 获取付费会员购买页面二维码
    • 获取优品推荐
    • 获取公司信息
    • 获取微信开放平台appid
    • 获取跳转手机端购买二维码
    • 首页分类商品
    • 首页轮播

CRMEB_标准版前台

crmeb api

基础接口

apple登陆

基本信息

Path: /api/apple_login

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
openId text 是 凭证
phone text 否 手机号
email text 是 email
captcha text 否 验证码

返回数据

名称类型是否必须默认值备注其他信息

主题类型

基本信息

Path: /api/v2/diy/color_change/color_change

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusnumber非必须主题色类型

获取个人中心菜单

基本信息

Path: /api/menu/user

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ routine_my_menusobject []非必须个人中心菜单

item 类型: object

├─ idnumber必须菜单id
├─ namestring必须菜单名称
├─ picstring必须菜单图标
├─ urlstring必须跳转地址
├─ routine_my_bannerstring []非必须个人中心轮播图

item 类型: string

├─ 非必须
├─ routine_spread_bannerstring []非必须推广背景图

item 类型: string

├─ 非必须
├─ routine_contact_typestring必须是否小程序客服
├─ diy_dataobject必须个人中心样式
├─ valuestring必须个人中心样式
├─ order_statusstring必须订单状态样式

图片上传

基本信息

Path: /api/upload/image

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
filenamestring必须文件名称
dirstring非必须文件路径 默认(store/comment)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须接口状态
msgstring非必须接口返回信息
dataobject非必须
├─ namestring非必须上传图片名称
├─ urlstring非必须上传图片路径

获取登录授权logo

基本信息

Path: /api/wechat/get_logo

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须请求状态
msgstring非必须提示语
dataobject非必须返回数据
├─ logo_urlstring非必须授权logo

获取网站基础配置

基本信息

Path: /api/site_config

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
dataobject非必须
├─ record_Nostring非必须备案信息

获取配置是否强制绑定手机号

基本信息

Path: /api/v2/bind_status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusboolean非必须是否需要强制手机号登录

门店自提开启状态

基本信息

Path: /api/v2/diy/get_store_status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须接口状态
msgstring非必须接口返回信息
dataobject非必须
├─ store_statusstring非必须是否开启门店自提

公众号支付回调

基本信息

Path: /api/wechat/notify

Method: GET

接口描述:

请求参数

小程序支付回调

基本信息

Path: /api/routine/notify

Method: GET

接口描述:

请求参数

支付回调

基本信息

Path: /api/pay/notify/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type alipay wechat tourine 类型

图片验证码

基本信息

Path: /api/sms_captcha

Method: GET

接口描述:

请求参数

获取发短信的code

基本信息

Path: /api/verify_code

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ keystring非必须发短信key
├─ expire_timestring非必须过期时间

验证码发送

基本信息

Path: /api/register/verify

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
phonestring必须手机号
typestring必须发送验证码类型|register=注册,login=登录,mobile=手机号登录,reset=修改密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

手机号注册

基本信息

Path: /api/register

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号/账号
captchastring必须验证码
passwordstring必须密码
spreadstring必须推广编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

手机号验证码登录

基本信息

Path: /api/login/mobile

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
phonestring必须手机号
captchastring必须短信验证码
spreadstring必须推广员编号 默认0

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ tokenstring非必须用户登录密钥
├─ expires_timestring非必须用户登录密钥到期时间

账号密码登陆

基本信息

Path: /api/login

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
account text 是 账号
password text 是 密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须用户登录密钥
├─ expires_timenumber非必须过期时间

手机号修改密码

基本信息

Path: /api/register/reset

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
accountstring必须手机号/账号
captchastring必须验证码
passwordstring必须新密码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

绑定手机号

基本信息

Path: /api/binding

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
phone text 是 手机号码
captcha text 是 验证码
key text 是 授权用户信息保存key

记录用户分享

基本信息

Path: /api/user/share

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须状态
msgstring非必须提示语

分享配置

基本信息

Path: /api/share

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject非必须
├─ imgstring非必须分享图片
├─ titlestring非必须分享标题
├─ synopsisstring非必须分享内容

获取图片base64

基本信息

Path: /api/image_base64

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
image text 是 图片路径
code text 是 二维码路径

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ codestring非必须
├─ imagestring非必须

海报二维码

基本信息

Path: /api/wechat/follow

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ pathstring非必须路径

优惠券列表_copy(已废弃)

基本信息

Path: /api/coupons_1586329598967

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 分页参数起始值
limit 否 分页数步长值
type 否 0-所有优惠券(默认) 1-产品相关优惠券
product_id 否 商品id (默认为0)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ idinteger非必须优惠券发布编号
├─ cidinteger非必须优惠券编号
├─ start_timenumber非必须优惠券开始领取时间
├─ end_timestring非必须优惠券结束领取时间,为空时不限时
├─ total_countnumber非必须优惠券领取数量
├─ remain_countnumber非必须优惠券剩余领取数量
├─ is_permanentnumber非必须是否无限张数
├─ coupon_pricenumber非必须优惠券面额
├─ use_min_pricestring非必须优惠券最低消费金额
├─ is_useboolean非必须是否领取
├─ titlestring非必须优惠券名称
├─ typestring非必须优惠券类型 0-通用券 1-品类券 2-商品券

添加登录用户的访问记录

基本信息

Path: /api/user/set_visit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
url text 是 页面路径
stay_time text 是 1 页面停留时间-暂时不传

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户关键字分享

基本信息

Path: /api/user/share/words

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ key_wordsstring非必须关键字

复制口令接口

基本信息

Path: /api/copy_wrds

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ wordsstring非必须

首页

首页商品列表

基本信息

Path: /api/api/home/products

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
ids 否 商品id集合
selectId 否 分类ID
selectType 是 类型
newsOrder 否 最新排序
salesOrder 否 销量排序
page 是 分页参数起始值
limit 是 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须商品id
├─ store_namestring必须商品名称
├─ cate_idstring必须商品分类
├─ imagestring必须商品主图
├─ salesstring必须商品销量
├─ pricestring必须商品最低价
├─ stocknumber必须商品总库存
├─ activitystring []必须商品活动显示排序

item 类型: string

├─ 非必须
├─ ot_pricestring必须商品最低原价
├─ spec_typenumber必须是否多规格
├─ recommend_imagestring必须商品推荐图
├─ unit_namestring必须商品单位
├─ is_vipnumber必须商品是否有付费会员价格
├─ vip_pricestring必须最低会员价
├─ descriptionstring必须商品详情
├─ checkCouponboolean必须此商品是否可用优惠券

首页DIY数据

基本信息

Path: /api/v2/diy/get_diy/:name

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
name moren 模版名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ headerSerchobject非必须顶部搜索
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ hotListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring非必须
├─ maxlengthnumber非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ hotListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ maxlengthnumber非必须
├─ swiperBgobject非必须轮播图
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring非必须
├─ infoobject []非必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ ccobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ aaobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring非必须
├─ infoobject []非必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ menusobject非必须首页菜单
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ newsobject非必须新闻公告
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ newListobject非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ chiildobject []非必须

item 类型: object

├─ titlestring必须
├─ valstring必须
├─ maxnumber必须
├─ plastring必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ newListobject非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ chiildobject []必须

item 类型: object

├─ titlestring必须
├─ valstring必须
├─ maxnumber必须
├─ plastring必须
├─ activityobject非必须活动
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ isDeleteboolean非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ maxnumber非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ isDeleteboolean非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring必须
├─ infoobject []必须

item 类型: object

├─ titlestring必须
├─ valuestring必须
├─ maxlengthnumber必须
├─ tipsstring必须
├─ maxnumber非必须
├─ aliveobject非必须直播
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ numConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ numConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ scrollBoxobject非必须快速选择
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ numConfigobject非必须
├─ titlestring非必须
├─ valnumber非必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring必须
├─ pidnumber必须
├─ activeValuestring必须
├─ activeValuestring非必须
├─ numConfigobject非必须
├─ titlestring非必须
├─ valstring非必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ cate_namestring必须
├─ pidnumber必须
├─ picstring必须
├─ adsRecommendobject非必须首页广告位
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring非必须
├─ infoobject []非必须

item 类型: object

├─ titlestring非必须
├─ valuestring非必须
├─ maxlengthnumber非必须
├─ tipsstring非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgListobject非必须
├─ titlestring非必须
├─ maxnumber非必须
├─ listobject []非必须

item 类型: object

├─ imgstring非必须
├─ infoobject []非必须

item 类型: object

├─ titlestring非必须
├─ valuestring非必须
├─ maxlengthnumber非必须
├─ tipsstring非必须
├─ couponobject非必须优惠券
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ seckillobject非必须秒杀
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ combinationobject非必须拼团
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ bargainobject非必须砍价
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ titlestring非必须
├─ valstring非必须
├─ maxnumber非必须
├─ plastring非必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ goodListobject非必须商品列表
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ aaobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ bbobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ ccobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ ddobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabConfigobject非必须
├─ tabValnumber非必须
├─ typenumber非必须
├─ tabListobject []非必须

item 类型: object

├─ namestring必须
├─ iconstring必须
├─ selectSortConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ listobject []非必须

item 类型: object

├─ activeValuestring必须
├─ titlestring必须
├─ selectConfigobject非必须
├─ titlestring非必须
├─ activeValuestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ numConfigobject非必须
├─ valnumber非必须
├─ goodsSortobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ typenumber非必须
├─ listobject []非必须

item 类型: object

├─ valstring必须
├─ iconstring必须
├─ goodsListobject非必须
├─ maxnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ picTxtobject非必须
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ richTextobject非必须
├─ valstring非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ richTextobject非必须
├─ valstring非必须
├─ titlesobject非必须精品推荐
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring必须
├─ valstring必须
├─ maxnumber必须
├─ plastring必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ titleInfoobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ titlestring必须
├─ valstring必须
├─ maxnumber必须
├─ plastring必须
├─ customerServiceobject非必须客服按钮
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ routine_contact_typestring非必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ imgUrlobject非必须
├─ titlestring非必须
├─ urlstring非必须
├─ routine_contact_typestring非必须
├─ tabBarobject非必须底部菜单
├─ defaultValobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabBarListobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ imgListstring []必须

item 类型: string

├─ 非必须
├─ linkstring必须
├─ defaultobject非必须
├─ isShowobject非必须
├─ valboolean非必须
├─ tabBarListobject非必须
├─ titlestring非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ imgListstring []必须

item 类型: string

├─ 非必须
├─ linkstring必须

获取底部导航

基本信息

Path: /api/navigation/:template_name

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
template_name 非必填

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ namestring非必须
├─ txtColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ activeTxtColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ bgColorobject非必须
├─ titlestring非必须
├─ namestring非必须
├─ defaultobject []非必须

item 类型: object

├─ itemstring非必须
├─ colorobject []非必须

item 类型: object

├─ itemstring非必须
├─ menuListobject []非必须

item 类型: object

├─ imgListstring []必须

item 类型: string

├─ 非必须
├─ namestring必须
├─ linkstring必须
├─ idstring非必须

优惠券列表

基本信息

Path: /api/coupons

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 分页参数起始值
limit 否 分页数步长值
type 否 0-所有优惠券(默认) 1-产品相关优惠券
product_id 否 商品id (默认为0)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须优惠券id
├─ cidnull必须0
├─ coupon_titlestring必须优惠券标题
├─ start_timestring必须领取开始时间
├─ end_timestring必须领取结束时间
├─ total_countnumber必须总数量
├─ remain_countnumber必须已领取数量
├─ is_permanentnumber必须是否无限
├─ statusnumber必须状态
├─ is_give_subscribenumber必须是否关注公众号赠送
├─ is_full_givenumber必须是否满额赠送
├─ full_reductionstring必须满额金额
├─ is_delnumber必须是否删除
├─ add_timenumber必须添加时间
├─ titlestring必须优惠券标题
├─ integralnumber必须积分兑换所需积分
├─ coupon_pricenumber必须优惠券金额
├─ use_min_pricenumber必须最低使用金额
├─ coupon_timenumber必须领取后多少天可以使用
├─ product_idstring必须商品券商品id
├─ category_idnumber必须分类券分类id
├─ typenumber必须优惠券类型
├─ receive_typenumber必须优惠券领取类型
├─ start_use_timenumber必须优惠券开始使用时间
├─ end_use_timenumber必须优惠券结束使用时间
├─ sortnumber必须排序
├─ usednull必须使用
├─ is_useboolean必须

今日优惠券弹窗

基本信息

Path: /api/v2/get_today_coupon

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须优惠券列表

item 类型: object

├─ idnumber非必须id
├─ cidnull非必须0
├─ coupon_titlestring非必须优惠券标题
├─ start_timenumber非必须领取开始时间
├─ end_timenumber非必须领取结束时间
├─ total_countnumber非必须总数
├─ remain_countnumber非必须已领取数量
├─ is_permanentnumber非必须是否不限量
├─ statusnumber非必须状态
├─ is_give_subscribenumber非必须是否关注赠送
├─ is_full_givenumber非必须是否满额赠送
├─ full_reductionstring非必须满额金额
├─ is_delnumber非必须是否删除
├─ add_timenumber非必须添加时间
├─ titlestring非必须标题
├─ integralnumber非必须积分
├─ coupon_pricenumber非必须优惠券金额
├─ use_min_pricenumber非必须使用最小金额
├─ coupon_timenumber非必须领取后使用时间(天)
├─ product_idstring非必须商品id
├─ category_idnumber非必须分类id
├─ typenumber非必须类型
├─ receive_typenumber非必须领取类型
├─ start_use_timenumber非必须开始使用时间
├─ end_use_timenumber非必须结束使用时间
├─ sortnumber非必须排序
├─ imagestring非必须弹窗背景图

首页产品的轮播图和产品信息(弃用)

基本信息

Path: /api/groom/list/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 1 获取产品类型 1 精品推荐 2 热门榜单 3首发新品 4促销单品

Query

参数名称 是否必须 示例 备注
page 是 1
limit 是 20

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ bannerobject []非必须

item 类型: object

├─ idnumber非必须
├─ imgstring非必须
├─ commentstring非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ imagestring必须
├─ store_namestring必须
├─ store_infostring必须
├─ cate_idstring必须
├─ pricestring必须
├─ ot_pricestring必须
├─ salesstring必须
├─ unit_namestring必须
├─ sortnumber必须
├─ activitystring []必须

item 类型: string

├─ 非必须
├─ stocknumber必须
├─ vip_pricestring,number必须
├─ is_vipnumber必须
├─ starobject []必须

item 类型: object

├─ product_scorenumber必须
├─ product_idnumber必须
├─ checkCouponboolean必须

热门搜索关键字获取(弃用)

基本信息

Path: /api/search/keyword

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ idinteger必须热门搜索编号
├─ titlestring必须热门搜索名称

首页获取拼团数据(弃用)

基本信息

Path: /api/pink

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ pink_countnumber非必须拼团完成总数
├─ avatarsobject非必须用户头像
├─ http://kaifa.crmeb.net/uploads/attach/2019/08/20190807/723adbdd4e49a0f9394dfc700ab5dba3.pngstring非必须
├─ http://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTKhUGDdn4VqtbgcdFPYBRZ9J6f5Mo6ib8rW7UJK10uKf9gyMk6agZbcmicv40HpYIlGsSlWaAibDdOwg/132string非必须
├─ http://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLiblpc6erWiaKEBniadyFgb5L9ShYj9Z7NNDedS0OKD7UD5zIRTokCiaB4GKnvyP4AGoBxQ81ibhaPqGg/132string非必须

文章

最新文章(弃用)

基本信息

Path: /api/article/new/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须文章id
├─ titlestring必须
├─ image_inputstring []必须

item 类型: string

├─ 非必须
├─ visitstring必须
├─ add_timestring必须
├─ synopsisstring必须
├─ urlstring必须

文章分类列表

基本信息

Path: /api/article/category/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须分类id
├─ titlestring必须分类名称

文章列表

基本信息

Path: /api/article/list/:cid

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
cid 1 分类编号

Query

参数名称 是否必须 示例 备注
page 否 1 分页数起始值(默认0 查询全部)
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须文章id
├─ titlestring非必须文章标题
├─ image_inputstring []非必须文章图片

item 类型: string

├─ 非必须
├─ visitstring非必须访问量
├─ add_timestring非必须添加时间
├─ synopsisstring非必须文章简介

文章详情

基本信息

Path: /api/article/details/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 文章编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须文章id
├─ cidstring非必须文章分类id
├─ titlestring非必须文章标题
├─ authorstring非必须作者
├─ image_inputstring []非必须文章图片

item 类型: string

├─ 非必须
├─ synopsisstring非必须文章简介
├─ share_titlestring非必须分享标题(弃用)
├─ share_synopsisstring非必须分享简介(弃用)
├─ visitnumber非必须访问量
├─ sortnumber非必须排序
├─ urlstring非必须跳转链接(弃用)
├─ statusnumber非必须状态
├─ add_timestring非必须添加时间
├─ hidenumber非必须是否隐藏
├─ admin_idnumber非必须0
├─ mer_idnumber非必须0
├─ product_idnumber非必须关联商品id
├─ is_hotnumber非必须是否热门
├─ is_bannernumber非必须是否轮播
├─ contentstring非必须内容
├─ catenamestring非必须文章分类名称
├─ store_infoobject非必须商品信息
├─ store_namestring非必须商品名称
├─ imagestring非必须商品图片
├─ pricestring非必须商品价格
├─ idnumber非必须商品id
├─ ot_pricestring非必须商品原价
├─ update_timestring非必须更新时间
├─ storeInfoobject非必须商品信息
├─ store_namestring非必须
├─ imagestring非必须
├─ pricestring非必须
├─ idnumber非必须
├─ ot_pricestring非必须

文章 热门列表

基本信息

Path: /api/article/hot/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须文章id
├─ titlestring必须文章标题
├─ image_inputstring []必须文章图片

item 类型: string

├─ 非必须
├─ visitstring必须访问量
├─ add_timestring必须添加时间
├─ synopsisstring必须文章简介

文章 轮播列表

基本信息

Path: /api/article/banner/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须文章id
├─ titlestring必须文章标题
├─ image_inputstring []必须文章图片

item 类型: string

├─ 非必须
├─ visitstring必须访问量
├─ add_timestring必须添加时间
├─ synopsisstring必须文章简介

商品

产品分享二维码 推广员

基本信息

Path: /api/product/code/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 产品id

Query

参数名称 是否必须 示例 备注
user_type 否 wechat wechat = 公众号,routine = 小程序 ,默认 wechat

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ codestring非必须推广二维码base64格式

产品评价数量和好评度

基本信息

Path: /api/reply/config/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ sum_countnumber非必须总评论数
├─ good_countnumber非必须好评数
├─ in_countnumber非必须中评数
├─ poor_countnumber非必须差评数
├─ reply_chancestring非必须好评率
├─ reply_starnumber非必须评论星星数

商品详情

基本信息

Path: /api/product/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 商品id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ uidnumber非必须用户id
├─ productAttrobject []非必须商品规格

item 类型: object

├─ idnumber必须规格id
├─ product_idnumber必须商品id
├─ attr_namestring必须规格名称
├─ attr_valuesstring []必须规格值

item 类型: string

├─ 非必须
├─ typenumber必须规格类型
├─ attr_valueobject []必须规格值

item 类型: object

├─ attrstring必须
├─ checkboolean必须
├─ productValueobject非必须规格值
├─ storeInfoobject非必须商品信息
├─ idnumber非必须商品id
├─ mer_idnumber非必须0
├─ imagestring非必须商品主图
├─ recommend_imagestring非必须商品推荐图
├─ slider_imagestring []非必须商品轮播图

item 类型: string

├─ 非必须
├─ store_namestring非必须商品名称
├─ store_infostring非必须商品简介
├─ keywordstring非必须商品关键字
├─ bar_codestring非必须商品码
├─ cate_idstring非必须分类id
├─ pricestring非必须商品最低价
├─ vip_pricenumber非必须商品会员价最低价
├─ ot_pricestring非必须商品原价最低价
├─ postagestring非必须运费(废弃)
├─ unit_namestring非必须商品单位
├─ sortnumber非必须排序
├─ salesnumber非必须销量
├─ stocknumber非必须库存
├─ is_shownumber非必须是否显示
├─ is_hotnumber非必须是否热卖
├─ is_benefitnumber非必须是否促销
├─ is_bestnumber非必须是否精品推荐
├─ is_newnumber非必须是否首发新品
├─ add_timenumber非必须添加时间
├─ is_postagenumber非必须是否包邮(废弃)
├─ is_delnumber非必须是否删除
├─ mer_usenumber非必须0
├─ give_integralstring非必须购买赠送积分
├─ coststring非必须成本价
├─ is_seckillnumber非必须是否开启秒杀
├─ is_bargainnull非必须是否开启砍价
├─ is_goodnumber非必须是否优品推荐
├─ is_subnumber非必须是否单独返佣
├─ is_vipnumber非必须是否设置会员价
├─ fictinumber非必须虚拟销量
├─ browsenumber非必须
├─ code_pathstring非必须口令
├─ soure_linkstring非必须
├─ video_linkstring非必须视频链接
├─ temp_idnumber非必须运费模版id
├─ spec_typenumber非必须是否多规格
├─ activitystring非必须活动顺序
├─ spustring非必须商品spu
├─ label_idstring非必须用户标签id
├─ command_wordstring非必须
├─ descriptionstring非必须商品详情
├─ image_basestring非必须
├─ fsalesnumber非必须
├─ code_basestring非必须
├─ userCollectboolean非必须
├─ userLikeboolean非必须
├─ priceNamenumber非必须推广佣金
├─ replynull非必须评论
├─ replyChancenumber非必须好评率
├─ replyCountnumber非必须评论数
├─ mer_idnumber非必须0
├─ good_listobject []非必须推荐商品

item 类型: object

├─ idnumber必须
├─ store_namestring必须
├─ cate_idstring必须
├─ imagestring必须
├─ salesstring必须
├─ pricestring必须
├─ stocknumber必须
├─ activityobject必须
├─ typestring非必须
├─ idnumber非必须
├─ unit_namestring必须
├─ descriptionstring必须
├─ checkCouponboolean必须
├─ mapKeystring非必须
├─ store_self_mentionnumber非必须
├─ activityobject []非必须活动

item 类型: object

├─ typestring必须
├─ idnumber必须
├─ couponsobject []非必须优惠券

item 类型: object

├─ idnumber非必须
├─ cidnull非必须
├─ coupon_titlestring非必须
├─ start_timestring非必须
├─ end_timestring非必须
├─ total_countnumber非必须
├─ remain_countnumber非必须
├─ is_permanentnumber非必须
├─ statusnumber非必须
├─ is_give_subscribenumber非必须
├─ is_full_givenumber非必须
├─ full_reductionstring非必须
├─ is_delnumber非必须
├─ add_timenumber非必须
├─ titlestring非必须
├─ integralnumber非必须
├─ coupon_pricenumber非必须
├─ use_min_pricenumber非必须
├─ coupon_timenumber非必须
├─ product_idstring非必须
├─ category_idnumber非必须
├─ typenumber非必须
├─ receive_typenumber非必须
├─ start_use_timenumber非必须
├─ end_use_timenumber非必须
├─ sortnumber非必须
├─ usednull非必须
├─ is_useboolean非必须
├─ routine_contact_typestring非必须

获取产品评论

基本信息

Path: /api/reply/list/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 产品编号

Query

参数名称 是否必须 示例 备注
page 否 1 分页数起始值(默认0 查询全部)
limit 否 20 分页数步长值
type 否 0 评价等级

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须评论id
├─ uidnumber必须用户ID
├─ oidnumber必须订单id
├─ uniquestring必须唯一值
├─ product_idnumber必须商品ID
├─ reply_typestring必须评论类型
├─ product_scorenumber必须商品评分
├─ service_scorenumber必须服务评分
├─ commentstring必须评论内容
├─ picsstring []必须评论图片

item 类型: string

├─ 非必须
├─ add_timestring必须评论时间
├─ merchant_reply_contentnull,string必须(弃用)
├─ merchant_reply_timestring必须(弃用)
├─ is_delnumber必须是否删除
├─ is_replynumber必须是否回复
├─ nicknamestring必须用户昵称
├─ avatarstring必须用户头像
├─ is_money_levelnull必须付费会员等级
├─ sukstring必须商品规格
├─ starstring必须评分

商品分类

基本信息

Path: /api/category

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须分类id
├─ pidnumber必须分类父级id
├─ cate_namestring必须分类名称
├─ picstring必须分类图片
├─ big_picstring必须pc首页分类大图
├─ childrenobject []必须下级分类

item 类型: object

├─ idnumber必须分类id
├─ cate_namestring必须分类名称
├─ picstring必须分类大图
├─ big_picstring必须

为你推荐

基本信息

Path: /api/product/hot

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
page 是 1 分页参数起始值
limit 是 20 分页数步长值

Body

名称类型是否必须默认值备注其他信息
pagenumber必须分页数起始值
limitnumber必须分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须商品ID
├─ store_namestring非必须商品名称
├─ cate_idstring非必须分类ID
├─ imagestring非必须商品主图
├─ salesstring非必须销量
├─ pricestring非必须价格
├─ stocknumber非必须库存
├─ activitystring []非必须活动

item 类型: string

├─ 非必须
├─ unit_namestring非必须单位
├─ descriptionstring非必须详情
├─ checkCouponboolean非必须是否有优惠券

优惠券

优惠券列表

基本信息

Path: /api/v2/coupons

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是
product_id 是
page 是 1
limit 是 20

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须优惠券ID
├─ cidnull非必须0
├─ coupon_titlestring非必须优惠券名称
├─ start_timestring非必须领取开始时间
├─ end_timestring非必须领取结束时间
├─ total_countnumber非必须总数
├─ remain_countnumber非必须已领取数量
├─ is_permanentnumber非必须是否不限量
├─ statusnumber非必须状态
├─ is_give_subscribenumber非必须关注赠送
├─ is_full_givenumber非必须是否满额赠送
├─ full_reductionstring非必须满额金额
├─ is_delnumber非必须是否删除
├─ add_timenumber非必须添加时间
├─ titlestring非必须优惠券标题
├─ integralnumber非必须积分
├─ coupon_pricenumber非必须优惠券金额
├─ use_min_pricenumber非必须最小使用金额
├─ coupon_timenumber非必须优惠使用时间(天)
├─ product_idstring非必须商品ID
├─ category_idnumber非必须分类ID
├─ typenumber非必须优惠券类型
├─ receive_typenumber非必须优惠券领取类型
├─ start_use_timenumber非必须开始使用时间
├─ end_use_timenumber非必须结束使用时间
├─ sortnumber非必须排序
├─ usednull非必须
├─ is_useboolean非必须
├─ countnumber []非必须

item 类型: number

├─ 非必须[通用数,品类数,商品数]

我的优惠券

基本信息

Path: /api/coupons/user/:types

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
types 0 优惠券状态 0全部 1未使用 2已使用

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须领取优惠券ID
├─ cidnumber非必须0
├─ uidnumber非必须用户ID
├─ coupon_titlestring非必须优惠券标题
├─ coupon_pricenumber非必须优惠券金额
├─ use_min_pricenumber非必须优惠券使用最小金额
├─ add_timestring非必须领取时间
├─ start_timenumber非必须开始领取时间
├─ end_timestring非必须结束领取时间
├─ use_timenumber非必须使用时间
├─ typestring非必须优惠券类型
├─ statusstring非必须状态
├─ is_failnumber非必须是否失效
├─ applicable_typenumber非必须
├─ coupon_timenumber非必须使用时间(天)
├─ product_idstring非必须商品ID
├─ category_idnumber非必须分类ID
├─ receive_typenumber非必须领取类型
├─ start_use_timenumber非必须开始使用时间
├─ end_use_timenumber非必须结束使用时间
├─ _typenumber非必须
├─ _msgstring非必须
├─ _add_timestring非必须
├─ _end_timestring非必须

批量领取优惠券

基本信息

Path: /api/coupon/receive/batch

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
couponId text 是 [1,2] 领取优惠券编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

新人优惠券

基本信息

Path: /api/v2/new_coupon

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须优惠券ID
├─ cidnumber必须0
├─ start_timenumber必须开始领取时间
├─ end_timenumber必须结束领取时间
├─ total_countnumber必须总数
├─ remain_countnumber必须已领取数
├─ is_permanentnumber必须是否不限量
├─ statusnumber必须状态
├─ is_give_subscribenumber必须是否关注赠送
├─ is_full_givenumber必须是否满额赠送
├─ full_reductionstring必须满额金额
├─ is_delnumber必须是否删除
├─ add_timenumber必须添加时间
├─ imagestring非必须背景图

领取优惠券

基本信息

Path: /api/coupon/receive

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
couponIdinteger必须要领取的优惠券编号(公共接口 优惠券列表返回参数的优惠券发布编号)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

签到

签到

基本信息

Path: /api/sign/integral

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ integralstring非必须

签到列表

基本信息

Path: /api/sign/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页参数起始值
limit 是 20 分页数步长值

Body

名称类型是否必须默认值备注其他信息
pagenumber必须分页参数起始值
limitnumber必须分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须ID
├─ uidnumber非必须用户ID
├─ titlestring非必须标题
├─ numbernumber非必须获取积分数
├─ balancenumber非必须余额
├─ add_timestring非必须签到时间

签到列表(年月)

基本信息

Path: /api/sign/month

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页参数起始值
limit 是 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ monthstring非必须月份
├─ listobject []非必须

item 类型: object

├─ add_timestring非必须签到时间
├─ titlestring非必须标题
├─ numbernumber非必须获得积分数
├─ idnumber非必须ID
├─ uidnumber非必须用户ID

签到用户信息

基本信息

Path: /api/sign/user

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
signstring非必须是否统计签到|1=是,0=否
integralstring非必须是否统计积分使用情况|1=是,0=否
allstring非必须是否统计签到和统计积分使用情况|1=是,0=否

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ uidnumber非必须用户ID
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ now_moneystring非必须用户余额
├─ brokerage_pricestring非必须用户佣金
├─ integralnumber非必须用户积分
├─ expstring非必须用户经验
├─ sign_numnumber非必须第几天签到
├─ agent_levelnumber非必须分销等级
├─ spread_opennumber非必须是否开启分销
├─ is_promoterboolean非必须是否推广员
├─ pay_countnumber非必须支付数量
├─ spread_countnumber非必须推广数量
├─ adminidnumber非必须
├─ login_typestring非必须登录端
├─ record_phonestring非必须临时手机
├─ is_money_levelnumber非必须付费会员等级
├─ is_ever_levelnumber非必须是否永久
├─ overdue_timenumber非必须会员到期时间
├─ uniqidstring非必须

签到配置

基本信息

Path: /api/sign/config

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须ID
├─ daystring必须名称
├─ sign_numstring必须签到获取积分

秒杀

秒杀产品时间区间

基本信息

Path: /api/seckill/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ lovelystring非必须
├─ seckillTimeobject []非必须

item 类型: object

├─ idnumber必须时间段ID
├─ timestring必须开始时间
├─ continuedstring必须结束时间
├─ slidearray,string必须轮播图
├─ statestring必须状态
├─ statusnumber必须状态
├─ stopnumber必须停止时间戳
├─ seckillTimeIndexnumber非必须秒杀当前时间段

秒杀产品列表

基本信息

Path: /api/seckill/list/:time

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
time 1 秒杀时间段编号(秒杀产品时间区间接口获取)

Query

参数名称 是否必须 示例 备注
page 否 1 分页数起始值(默认0查询全部)
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须秒杀商品ID
├─ product_idnumber非必须正常商品ID
├─ imagestring非必须主图
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ titlestring非必须秒杀标题
├─ infostring非必须秒杀简介
├─ pricenumber非必须价格
├─ coststring非必须成本价
├─ ot_pricenumber非必须原价
├─ give_integralstring非必须赠送积分(废弃)
├─ sortnumber非必须排序
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ unit_namestring非必须单位
├─ postagestring非必须邮费(废弃)
├─ descriptionnull非必须详情
├─ start_timestring非必须开始时间
├─ stop_timestring非必须结束时间
├─ add_timestring非必须添加时间
├─ statusnumber非必须状态
├─ is_postagenumber非必须是否包邮(废弃)
├─ is_hotnumber非必须是否热门(废弃)
├─ is_delnumber非必须是否删除
├─ numnumber非必须用户购买件数
├─ is_shownumber非必须是否显示
├─ time_idnumber非必须时间段
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须
├─ volumestring非必须
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ once_numnumber非必须单订单购买件数
├─ percentnumber非必须已购百分比

秒杀产品详情

基本信息

Path: /api/seckill/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 秒杀产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ buy_numnumber非必须
├─ storeInfoobject非必须
├─ idnumber非必须秒杀ID
├─ product_idnumber非必须商品ID
├─ imagestring非必须主图
├─ imagesstring []非必须轮播

item 类型: string

├─ 非必须
├─ titlestring非必须标题
├─ infostring非必须简介
├─ pricestring非必须价格
├─ coststring非必须成本价
├─ ot_pricestring非必须元件
├─ give_integralstring非必须赠送积分
├─ sortnumber非必须排序
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ unit_namestring非必须单位
├─ postagestring非必须邮费
├─ descriptionstring非必须详情
├─ start_timestring非必须开始时间
├─ stop_timestring非必须结束时间
├─ add_timestring非必须添加时间
├─ statusnumber非必须状态
├─ is_postagenumber非必须是否包邮
├─ is_hotnumber非必须是否热门
├─ is_delnumber非必须是否删除
├─ numnumber非必须每个公户最大购买件数
├─ is_shownumber非必须是否显示
├─ time_idnumber非必须时间段
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须重量
├─ volumestring非必须体积
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ once_numnumber非必须单订单购买件数
├─ image_basestring非必须
├─ totalnumber非必须
├─ code_basestring非必须
├─ userCollectboolean非必须
├─ userLikeboolean非必须
├─ uidnumber非必须
├─ percentnumber非必须
├─ replyobject非必须评论列表
├─ idnumber非必须评论ID
├─ uidnumber非必须用户ID
├─ oidnumber非必须订单ID
├─ uniquestring非必须唯一值
├─ product_idnumber非必须商品ID
├─ reply_typestring非必须
├─ product_scorenumber非必须
├─ service_scorenumber非必须
├─ commentstring非必须
├─ picsstring []非必须

item 类型: string

├─ 非必须
├─ add_timestring非必须
├─ merchant_reply_contentnull非必须
├─ merchant_reply_timestring非必须
├─ is_delnumber非必须
├─ is_replynumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ cart_infonull非必须
├─ is_money_levelnull非必须
├─ sukstring非必须
├─ starstring非必须
├─ replyChancestring非必须好评率
├─ replyCountnumber非必须评论数
├─ productAttrobject []非必须

item 类型: object

├─ idnumber必须规格ID
├─ product_idnumber必须秒杀商品ID
├─ attr_namestring必须规格名称
├─ attr_valuesstring []必须规格值

item 类型: string

├─ 非必须
├─ typenumber必须1
├─ attr_valueobject []必须规格值

item 类型: object

├─ attrstring必须规格
├─ checkboolean必须
├─ productValueobject非必须规格值
├─ routine_contact_typestring非必须小程序客服判断

拼团

拼团列表

基本信息

Path: /api/combination/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值(默认0 全程查询)
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须拼团ID
├─ product_idnumber非必须商品ID
├─ mer_idnumber非必须0
├─ imagestring非必须主图
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ titlestring非必须拼团商品标题
├─ attrnull非必须
├─ peoplenumber非必须几人团
├─ infostring非必须简介
├─ pricenumber非必须价格
├─ sortnumber非必须排序
├─ salesnumber非必须销量
├─ stocknumber非必须库存
├─ add_timestring非必须添加时间
├─ is_hostnumber非必须是否热门
├─ is_shownumber非必须是否显示
├─ is_delnumber非必须是否删除
├─ combinationnumber非必须
├─ mer_usenull非必须
├─ is_postagenumber非必须是否包邮
├─ postagestring非必须邮费
├─ start_timenumber非必须开始时间
├─ stop_timenumber非必须结束时间
├─ effective_timenumber非必须拼团到期时间
├─ costnumber非必须成本价
├─ browsenumber非必须浏览
├─ unit_namestring非必须单位
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须重量
├─ volumestring非必须体积
├─ numnumber非必须用户可购买件数
├─ once_numnumber非必须单个订单购买件数
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ virtualnumber非必须虚拟拼团比例
├─ ot_pricestring非必须原价
├─ product_pricenumber非必须正常商品价格

拼团列表页轮播图

基本信息

Path: /api/combination/banner_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须编号ID
├─ imgstring非必须图片地址
├─ commentstring非必须备注
├─ linkstring非必须图片链接

拼团 开团

基本信息

Path: /api/combination/pink/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ userInfoobject非必须用户信息
├─ uidinteger非必须用户编号
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ pinkBoolnumber非必须判断拼团是否成功|0=失败
├─ is_oknumber非必须判断拼团是否完成
├─ userBoolnumber非必须判断当前用户是否在团内|0=未在,1=在
├─ store_combinationobject非必须拼团产品信息
├─ idinteger非必须拼团产品编号
├─ product_idinteger非必须产品编号
├─ imagestring非必须拼团产品图片
├─ titlestring非必须拼团产品标题
├─ peoplenumber非必须拼团产品人数
├─ pricestring非必须拼团产品价格
├─ unit_namestring非必须拼团产品单位
├─ pinkTobject非必须团长信息
├─ idinteger非必须拼团编号
├─ uidnumber非必须团长用户编号
├─ total_numnumber非必须拼团产品数量
├─ peoplenumber非必须拼团人数
├─ pricestring非必须拼团价格
├─ stop_timestring非必须拼团结束时间
├─ statusnumber非必须拼团状态|1=进行中,2=已完成,3=未完成
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ pinkAllobject []非必须拼团成员信息

item 类型: object

├─ idinteger非必须拼团编号
├─ uidinteger非必须用户编号
├─ total_numnumber非必须拼团产品数量
├─ peoplenumber非必须拼团人数
├─ pricestring非必须拼团价格
├─ stop_timestring非必须拼团结束时间
├─ statusnumber非必须拼团状态|1=进行中,2=已完成,3=未完成
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ countnumber非必须可参团人数
├─ store_combination_hostobject []非必须拼团推荐产品

item 类型: object

├─ idinteger非必须拼团产品编号
├─ imagestring非必须拼团产品图片
├─ pricestring非必须拼团产品价格
├─ salesnumber非必须拼团产品销量
├─ titlestring非必须拼团产品标题
├─ peoplenumber非必须拼团产品人数
├─ product_pricestring非必须拼团产品原价
├─ current_pink_orderstring非必须拼团编号

拼团 取消开团

基本信息

Path: /api/combination/remove

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须拼团编号
cidinteger必须拼团产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

拼团海报

基本信息

Path: /api/combination/poster

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须拼团编号
from string非必须海报类型|wechat=公众号,routine=小程序(默认公众号)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ urlstring非必须小程序海报图片地址
├─ wap_urlstring非必须公众号海报图片地址

拼团产品详情

基本信息

Path: /api/combination/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ storeInfoobject非必须商品信息
├─ idnumber非必须拼团商品ID
├─ product_idnumber非必须正常商品ID
├─ mer_idnumber非必须0
├─ imagestring非必须主图
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ titlestring非必须商品名称
├─ attrnull非必须
├─ peoplenumber非必须成团所需人数
├─ infostring非必须拼团详情
├─ pricestring非必须价格
├─ sortnumber非必须排序
├─ salesnumber非必须销量
├─ stocknumber非必须库存
├─ add_timestring非必须添加时间
├─ is_hostnumber非必须是否热门
├─ is_shownumber非必须是否显示
├─ is_delnumber非必须是否删除
├─ combinationnumber非必须
├─ mer_usenull非必须
├─ is_postagenumber非必须是否包邮
├─ postagestring非必须邮费
├─ start_timenumber非必须开始时间
├─ stop_timenumber非必须结束时间
├─ effective_timenumber非必须开团后限制时间
├─ costnumber非必须成本价
├─ browsenumber非必须浏览
├─ unit_namestring非必须单位
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须重量
├─ volumestring非必须体积
├─ numnumber非必须用户可购买总数
├─ once_numnumber非必须单个订单购买件数
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ virtualnumber非必须虚拟成团比例
├─ descriptionstring非必须详情
├─ totalstring非必须
├─ product_pricestring非必须商品价格
├─ image_basestring非必须
├─ sale_stocknumber非必须
├─ userCollectboolean非必须用户收藏
├─ userLikeboolean非必须用户喜欢
├─ code_basestring非必须
├─ pink_ok_liststring []非必须拼团成功列表

item 类型: string

├─ 非必须
├─ pink_ok_sumnumber非必须拼团成功数量
├─ pinkobject []非必须拼团中列表

item 类型: object

├─ idnumber非必须拼团团队ID
├─ uidnumber非必须用户ID
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ order_idstring非必须订单ID
├─ order_id_keynumber非必须
├─ total_numnumber非必须订单总数
├─ total_pricestring非必须总金额
├─ cidnumber非必须拼团商品ID
├─ pidnumber非必须正常商品ID
├─ peoplenumber非必须拼团人数
├─ pricestring非必须金额
├─ add_timestring非必须开团时间
├─ stop_timenumber非必须拼团结束时间
├─ k_idnumber非必须是否团长
├─ is_tplnumber非必须是否已发送消息
├─ is_refundnumber非必须是否已退款
├─ statusnumber非必须状态
├─ is_virtualnumber非必须是否虚拟成团
├─ countnumber非必须总数
├─ hstring非必须
├─ istring非必须
├─ sstring非必须
├─ pindAllnumber []非必须

item 类型: number

├─ 非必须
├─ buy_numnumber非必须购买件数
├─ replynull非必须评论
├─ replyChancenumber非必须好评率
├─ replyCountnumber非必须评论总数
├─ productAttrobject []非必须规格

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ attr_namestring必须
├─ attr_valuesstring []必须

item 类型: string

├─ 非必须
├─ typenumber必须
├─ attr_valueobject []必须

item 类型: object

├─ attrstring必须
├─ checkboolean必须
├─ productValueobject非必须规格
├─ 陶瓷白,8GB+256GB,Mate 40 RS标准版object非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ product_stocknumber非必须
├─ 陶瓷黑,8GB+256GB,Mate 40 RS标准版object非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ product_stocknumber非必须
├─ routine_contact_typestring非必须是否小程序自带客服

获取拼团小程序二维码

基本信息

Path: /api/combination/code/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ codestring非必须二维码路径

获取拼团海报详细信息

基本信息

Path: /api/combination/poster_info/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 拼团id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ titlestring非必须商品标题
├─ urlstring非必须小程序二维码,只有小程序访问时才会有
├─ imagestring非必须商品图
├─ pricestring非必须剩余金额
├─ labelstring非必须标签
├─ msgstring非必须备注

预售

预售列表

基本信息

Path: /api/advance/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是
time_type 是 1未开始2进行中3已结束

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须编号
├─ product_idnumber非必须商品编号
├─ imagestring非必须主图
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ titlestring非必须标题
├─ infostring非必须简介
├─ pricestring非必须价格
├─ ot_pricestring非必须原价
├─ sortnumber非必须排序
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ unit_namestring非必须单位
├─ start_timestring非必须开始时间
├─ stop_timestring非必须结束时间
├─ add_timestring非必须添加时间
├─ statusnumber非必须状态
├─ is_delnumber非必须是否删除
├─ typenumber非必须类型
├─ depositstring非必须
├─ pay_start_timestring非必须
├─ pay_stop_timestring非必须
├─ deliver_timenumber非必须发货时间
├─ numnumber非必须限购
├─ temp_idnumber非必须运费模版id
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ once_numnumber非必须单次购买
├─ cate_idnull非必须分类id
├─ countnumber非必须

预售商品详情

基本信息

Path: /api/advance/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 预售商品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ pay_statusnumber非必须预售状态1未开始2进行中3已结束
├─ buy_numnumber非必须用户已购买数量
├─ storeInfoobject非必须商品详情
├─ idnumber非必须编号
├─ product_idnumber非必须商品id
├─ imagestring非必须主图
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ titlestring非必须标题
├─ infostring非必须简介
├─ pricestring非必须价格
├─ ot_pricestring非必须原价
├─ sortnumber非必须排序
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ unit_namestring非必须单位
├─ start_timestring非必须开始时间
├─ stop_timestring非必须结束时间
├─ add_timestring非必须添加时间
├─ statusnumber非必须状态
├─ is_delnumber非必须是否删除
├─ typenumber非必须类型
├─ depositstring非必须
├─ pay_start_timestring非必须
├─ pay_stop_timestring非必须
├─ deliver_timenumber非必须发货天数
├─ numnumber非必须每个用户限制购买
├─ temp_idnumber非必须运费模版ID
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ once_numnumber非必须
├─ descriptionstring非必须详情
├─ image_basestring非必须
├─ totalnumber非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ code_basestring非必须
├─ userCollectboolean非必须收藏
├─ userLikeboolean非必须
├─ uidnumber非必须用户ID
├─ percentnumber非必须
├─ replynull非必须评论
├─ replyChancenumber非必须好评率
├─ replyCountnumber非必须评论总数
├─ productAttrobject []非必须规格

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ attr_namestring必须
├─ attr_valuesstring []必须

item 类型: string

├─ 非必须
├─ typenumber必须
├─ attr_valueobject []必须

item 类型: object

├─ attrstring必须
├─ checkboolean必须
├─ productValueobject非必须规格值
├─ 【蝶悦色】蓝色交领上衣+半壁+6米摆蓝色襦裙,Sobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricenumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ is_virtualnumber非必须
├─ coupon_idnumber非必须
├─ product_stocknumber非必须
├─ routine_contact_typestring非必须是否小程序自带客服

砍价

砍价产品详情

基本信息

Path: /api/bargain/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 砍价产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ userInfoobject非必须
├─ uidnumber非必须用户ID
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ bargainobject非必须砍价详情
├─ idnumber非必须砍价商品ID
├─ product_idnumber非必须正常商品ID
├─ titlestring非必须商品标题
├─ imagestring非必须主图
├─ unit_namestring非必须单位
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ start_timenumber非必须开始时间
├─ stop_timenumber非必须结束时间
├─ store_namenull非必须商品名称
├─ pricestring非必须砍价起始金额
├─ min_pricestring非必须砍价最低金额
├─ numnumber非必须用户可购买件数
├─ bargain_max_pricestring非必须
├─ bargain_min_pricestring非必须
├─ bargain_numnumber非必须
├─ statusnumber非必须状态
├─ give_integralstring非必须
├─ infostring非必须砍价详情
├─ costnull非必须成本价
├─ sortnumber非必须排序
├─ is_hotnumber非必须是否热门
├─ is_delnumber非必须是否删除
├─ add_timestring非必须添加时间
├─ is_postagenumber非必须
├─ postagenull非必须
├─ rulestring非必须砍价规则
├─ looknumber非必须关注
├─ sharenumber非必须分享
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须重量
├─ volumestring非必须体积
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ people_numnumber非必须用户此商品可砍次数
├─ descriptionstring非必须详情
├─ timenumber非必须砍价时间
├─ attrobject非必须规格
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricenumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ product_stocknumber非必须
├─ bargainSumCountnumber非必须可砍数量
├─ userBargainStatusnumber非必须用户砍价状态

开启砍价用户信息

基本信息

Path: /api/bargain/start/user

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像

砍价列表(已参与)

基本信息

Path: /api/bargain/user/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值(默认全部查询)
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须砍价记录ID
├─ uidnumber非必须用户ID
├─ bargain_idnumber非必须砍价ID
├─ bargain_price_minstring非必须砍价最低价
├─ bargain_pricestring非必须砍价起始金额
├─ pricestring非必须砍掉的金额
├─ statusnumber非必须状态
├─ add_timenumber非必须砍价时间
├─ is_delnumber非必须是否删除
├─ titlestring非必须标题
├─ imagestring非必须主图
├─ datatimenumber非必须时间
├─ people_numnumber非必须需要几个人砍价才能成功
├─ residue_pricestring非必须剩余金额

砍价 开启

基本信息

Path: /api/bargain/start

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdnumber必须砍价产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

砍价 观看/分享/参与次数

基本信息

Path: /api/bargain/share

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdnumber必须砍价产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ lookCountnumber非必须关注次数
├─ userCountnumber非必须砍价次数
├─ shareCountnumber非必须分享次数

砍价取消

基本信息

Path: /api/bargain/user/cancel

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdstring必须砍价产品编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

砍价 帮助好友砍价

基本信息

Path: /api/bargain/help

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdstring必须砍价产品编号
bargainUserUidstring必须开启砍价的用户

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

砍价 砍掉金额

基本信息

Path: /api/bargain/help/price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdstring必须砍价产品编号
bargainUserUidstring必须开启砍价的用户

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ pricestring非必须砍掉的金额

砍价 砍价帮

基本信息

Path: /api/bargain/help/list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdstring必须砍价产品编号
bargainUserUidstring必须开启砍价的用户
pagestring必须分页参数起始值(默认全部查询)|0=全部查询
limitstring必须分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ pricestring非必须砍掉金额
├─ add_timestring非必须砍价时间
├─ nicknamestring非必须帮砍用户昵称
├─ avatarstring非必须帮砍用户头像

砍价 砍价帮总人数、剩余金额、进度条、已经砍掉的价格

基本信息

Path: /api/bargain/help/count

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdstring必须砍价产品编号
bargainUserUidstring必须开启砍价的用户

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ userBargainStatusboolean非必须用户是否能砍价
├─ countnumber非必须砍价人数
├─ pricestring非必须剩余金额
├─ statusnumber非必须状态
├─ alreadyPricenumber非必须砍掉的金额
├─ pricePercentnumber非必须百分比

砍价海报

基本信息

Path: /api/bargain/poster

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
bargainIdnumber必须砍价产品编号
fromstring非必须海报类型|wechat=公众号,routine=小程序(默认公众号)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlstring非必须分享海报

获取砍价海报详细信息(废弃)

基本信息

Path: /api/bargain/poster_info/:bargainId

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
bargainId 1 砍价id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlstring非必须只有在小程序访问下才会返回二维码路径
├─ titlestring非必须砍价商品标题
├─ imagestring非必须商品主图
├─ pricestring非必须金额
├─ labelstring非必须标签内文字
├─ msgstring非必须说明

砍价列表

基本信息

Path: /api/bargain/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须砍价ID
├─ product_idnumber非必须正常商品ID
├─ titlestring非必须砍价商品名称
├─ imagestring非必须主图
├─ unit_namestring非必须单位
├─ stocknumber非必须库存
├─ salesnumber非必须销量
├─ imagesstring []非必须轮播图

item 类型: string

├─ 非必须
├─ start_timenumber非必须开始时间
├─ stop_timenumber非必须结束时间
├─ store_namenull非必须商品名称
├─ pricenumber非必须砍价起时价格
├─ min_pricestring非必须砍价最低价
├─ numnumber非必须购买件数
├─ bargain_max_pricestring非必须
├─ bargain_min_pricestring非必须
├─ bargain_numnumber非必须砍价人数
├─ statusnumber非必须状态
├─ give_integralstring非必须
├─ infostring非必须砍价简介
├─ costnull非必须成本价
├─ sortnumber非必须排序
├─ is_hotnumber非必须是否热门
├─ is_delnumber非必须是否删除
├─ add_timestring非必须添加时间
├─ is_postagenumber非必须
├─ postagenull非必须
├─ rulestring非必须砍价规则
├─ looknumber非必须关注砍价人数
├─ sharenumber非必须分享砍价人数
├─ temp_idnumber非必须运费模版ID
├─ weightstring非必须重量
├─ volumestring非必须体积
├─ quotanumber非必须限量
├─ quota_shownumber非必须限量显示
├─ people_numnumber非必须同一个商品可帮砍次数
├─ ot_pricestring非必须原价
├─ cate_idstring非必须分类
├─ peoplenumber非必须人数

购物车

商品规格(新)

基本信息

Path: /api/v2/get_attr/:id/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 商品ID
type 0 0正常1秒杀2砍价3拼团

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须

item 类型: string

├─ 非必须

购物车 修改产品数量

基本信息

Path: /api/cart/num

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须购物车编号
numbernumber必须购物车数量

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

购物车 列表

基本信息

Path: /api/cart/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 购物车商品状态
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ validobject []非必须有效商品

item 类型: object

├─ idnumber非必须购物车ID
├─ uidnumber非必须用户ID
├─ typestring非必须购物车类型product
├─ product_idnumber非必须商品ID
├─ product_attr_uniquestring非必须商品规格
├─ cart_numnumber非必须数量
├─ add_timenumber非必须添加时间
├─ is_paynumber非必须是否支付(弃用)
├─ is_delnumber非必须是否删除(弃用)
├─ is_newnumber非必须是否直接购买
├─ combination_idnumber非必须拼团ID
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ statusnumber非必须状态
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须规格状态
├─ costPricestring非必须成本价
├─ trueStocknumber非必须库存
├─ truePricestring非必须价格
├─ vip_truePricenumber非必须vip价格
├─ invalidstring []非必须无效商品

item 类型: string

├─ 非必须
├─ deductionobject非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须

购物车 删除

基本信息

Path: /api/cart/del

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idsstring []必须购物车编号数组

item 类型: string

├─ 非必须购物车编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

购物车 添加

基本信息

Path: /api/cart/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
productId text 是 1 普通产品编号
cartNum text 是 1 购物车数量
uniqueId text 否 6af2068e 属性唯一值
combinationId text 否 1 拼团产品编号
secKillId text 否 1 秒杀产品编号
bargainId text 否 1 砍价产品编号
new text 是 1 购物车类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ cartIdinteger非必须购物车编号

购物车 获取数量

基本信息

Path: /api/cart/count

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
numType 否 false 购物车数量类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ countnumber非必须购物车数量

购物车修改(新)

基本信息

Path: /api/v2/set_cart_num

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
product_id text 是 1 商品ID
num text 是 1 数量
unique text 是 规格唯一值,单规格为空
type text 是 0 -1 直接修改,0 减少, 1 增加

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

购物车重选

基本信息

Path: /api/api/v2/reset_cart

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是
unique text 是
num text 是
product_id text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

积分商城

兑换记录

基本信息

Path: /api/store_integral/order/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须

item 类型: string

├─ 非必须

抽奖页面

基本信息

Path: /api/v2/lottery/info/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 抽奖类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ lotteryobject非必须
├─ idnumber非必须编号
├─ typenumber非必须抽奖类型
├─ namestring非必须名称
├─ descstring非必须简介
├─ imagestring非必须背景图
├─ factornumber非必须消耗类型
├─ factor_numnumber非必须消耗数量
├─ attends_usernumber非必须参与用户1全部2部分
├─ user_levelnumber []非必须用户等级

item 类型: number

├─ 非必须
├─ user_labelstring []非必须用户标签

item 类型: string

├─ 非必须
├─ is_svipnumber非必须是否付费会员
├─ prize_numnumber非必须奖品数量
├─ start_timenumber非必须开始时间
├─ end_timenumber非必须结束时间
├─ lottery_num_termnumber非必须抽奖次数限制
├─ lottery_numnumber非必须抽奖次数
├─ spread_numnumber非必须关注推广获取抽奖次数
├─ is_all_recordnumber非必须中奖纪录展示
├─ is_personal_recordnumber非必须个人中奖纪录展示
├─ is_contentnumber非必须活动规格是否展示
├─ contentstring非必须活动文案抽奖协议之类
├─ statusnumber非必须状态
├─ sortnumber非必须排序
├─ is_delnumber非必须是否删除
├─ add_timenumber非必须添加时间
├─ prizeobject []非必须

item 类型: object

├─ idnumber必须编号
├─ typenumber必须类型
├─ lottery_idnumber必须抽奖ID
├─ namestring必须名称
├─ promptstring必须提示语
├─ imagestring必须图片
├─ chancenumber必须权重
├─ totalnumber必须总数
├─ coupon_idnumber必须优惠券ID
├─ product_idnumber必须商品ID
├─ uniquestring必须唯一值
├─ numnumber必须数量
├─ sortnumber必须排序
├─ statusnumber必须状态
├─ is_delnumber必须是否删除
├─ add_timenumber必须添加时间
├─ lottery_numnumber非必须抽奖次数
├─ all_recordstring []非必须全部记录

item 类型: string

├─ 非必须
├─ user_recordstring []非必须用户记录

item 类型: string

├─ 非必须

用户抽奖

基本信息

Path: /api/v2/lottery

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 抽奖id
type text 是 类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须编号
├─ typenumber非必须类型
├─ lottery_idnumber非必须抽奖ID
├─ namestring非必须名称
├─ promptstring非必须说明
├─ imagestring非必须图片
├─ chancenumber非必须权重
├─ totalnumber非必须总数
├─ coupon_idnumber非必须优惠券ID
├─ product_idnumber非必须商品ID
├─ uniquestring非必须唯一值
├─ numnumber非必须数量
├─ sortnumber非必须排序
├─ statusnumber非必须状态
├─ is_delnumber非必须是否删除
├─ add_timenumber非必须添加时间
├─ lottery_record_idstring非必须记录ID

积分商品列表

基本信息

Path: /api/store_integral/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
store_name 是 商品名称
priceOrder 是 价格排序
salesOrder 是 销量排序
page 是 分页
limit 是 分页
cid 是 一级分类
sid 是 二级分类
news 是 是否最新

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须编号
├─ imagestring非必须图片
├─ titlestring非必须标题
├─ pricenumber非必须价格
├─ salesnumber非必须销量

积分商品详情

基本信息

Path: /api/store_integral/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 商品id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ storeInfoobject非必须商品详情
├─ idnumber非必须
├─ imagestring非必须
├─ product_idnumber非必须
├─ imagesstring []非必须

item 类型: string

├─ 非必须
├─ titlestring非必须
├─ pricenumber非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ unit_namestring非必须
├─ stocknumber非必须
├─ add_timestring非必须
├─ is_hostnumber非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ numnumber非必须
├─ quotanumber非必须
├─ once_numnumber非必须
├─ quota_shownumber非必须
├─ ot_pricestring非必须
├─ product_pricestring非必须
├─ image_basestring非必须
├─ sale_stocknumber非必须
├─ descriptionstring非必须
├─ small_imagestring非必须
├─ productAttrobject []非必须规格

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ attr_namestring必须
├─ attr_valuesstring []必须

item 类型: string

├─ 非必须
├─ typenumber必须
├─ attr_valueobject []必须

item 类型: object

├─ attrstring必须
├─ checkboolean必须
├─ productValueobject非必须规格值
├─ 【小狐仙】上儒+襦裙,Sobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricenumber非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ is_virtualnumber非必须
├─ coupon_idnumber非必须
├─ product_stocknumber非必须

积分商城首页

基本信息

Path: /api/store_integral/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ bannerobject []非必须积分商城轮播图

item 类型: object

├─ idnumber非必须编号
├─ imgstring非必须图片
├─ commentstring非必须描述
├─ linkstring非必须链接
├─ listobject []非必须推荐商品

item 类型: object

├─ idnumber非必须编号
├─ imagestring非必须图片
├─ titlestring非必须标题
├─ pricenumber非必须价格
├─ salesnumber非必须销量

领取抽奖商品

基本信息

Path: /api/v2/lottery/receive

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 抽奖ID
name text 是 名称
phone text 是 电话
address text 是 地址
detail text 是 详细地址

订单

计算订单金额

基本信息

Path: /api/order/computed/:key

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
key 2076dfaecae7404169f8eea9b3bcdf28 订单信息缓存标识

Body

参数名称 参数类型 是否必须 示例 备注
addressId text 是 1 地址编号
couponId text 是 1 领取优惠券编号
payType text 是 weixin 支付方式
useIntegral text 是 1 是否积分抵扣

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusstring非必须
├─ resultobject非必须
├─ total_pricestring非必须总金额
├─ pay_pricenumber非必须支付金额
├─ pay_postagenumber非必须支付运费
├─ coupon_pricenumber非必须优惠券抵扣
├─ deduction_pricenumber非必须积分抵扣金额
├─ usedIntegralnumber非必须使用积分
├─ SurplusIntegralnumber非必须剩余积分
├─ storePostageDiscountnumber非必须运费折扣

退款订单详情

基本信息

Path: /api/order/refund_detail/:order_id/:cat_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
order_id
cat_id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ pidnumber非必须
├─ order_idstring非必须
├─ trade_nostring非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ user_phonestring非必须
├─ user_addressstring非必须
├─ cart_idstring []非必须

item 类型: string

├─ 非必须
├─ freight_pricestring非必须
├─ total_numnumber非必须
├─ total_pricestring非必须
├─ total_postagestring非必须
├─ pay_pricestring非必须
├─ pay_postagestring非必须
├─ deduction_pricestring非必须
├─ coupon_idnumber非必须
├─ coupon_pricestring非必须
├─ paidnumber非必须
├─ pay_timenumber非必须
├─ pay_typestring非必须
├─ add_timenumber非必须
├─ statusnumber非必须
├─ refund_statusnumber非必须
├─ refund_typenumber非必须
├─ refund_expressstring非必须
├─ refund_reason_wap_imgstring非必须
├─ refund_reason_wap_explainstring非必须
├─ refund_reason_timenumber非必须
├─ refund_reason_wapstring非必须
├─ refund_reasonstring非必须
├─ refund_pricestring非必须
├─ delivery_namestring非必须
├─ delivery_codestring非必须
├─ delivery_typestring非必须
├─ delivery_idstring非必须
├─ fictitious_contentstring非必须
├─ delivery_uidnumber非必须
├─ gain_integralstring非必须
├─ use_integralstring非必须
├─ back_integralstring非必须
├─ spread_uidnumber非必须
├─ spread_two_uidnumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ markstring非必须
├─ is_delnumber非必须
├─ uniquestring非必须
├─ remarkstring非必须
├─ mer_idnumber非必须
├─ is_mer_checknumber非必须
├─ combination_idnumber非必须
├─ pink_idnumber非必须
├─ coststring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ advance_idnumber非必须
├─ verify_codestring非必须
├─ store_idnumber非必须
├─ shipping_typenumber非必须
├─ clerk_idnumber非必须
├─ is_channelnumber非必须
├─ is_remindnumber非必须
├─ is_system_delnumber非必须
├─ channel_typestring非必须
├─ provincestring非必须
├─ express_dumpstring非必须
├─ virtual_typenumber非必须
├─ virtual_infostring非必须
├─ splitstring []非必须

item 类型: string

├─ 非必须
├─ invoicenull非必须
├─ cartInfoobject []非必须

item 类型: object

├─ idstring非必须
├─ typenumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ advance_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ is_virtualnumber非必须
├─ virtual_typenumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnumber非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ recommend_liststring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ is_virtualnumber非必须
├─ coupon_idnumber非必须
├─ sum_pricestring非必须
├─ truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ attrStatusboolean非必须
├─ vip_truePricenumber非必须
├─ price_typestring非必须
├─ is_validnumber非必须
├─ use_integralnumber非必须
├─ integral_pricenumber非必须
├─ coupon_pricenumber非必须
├─ one_brokeragestring非必须
├─ two_brokeragestring非必须
├─ postage_pricestring非必须
├─ uniquestring非必须
├─ is_replynumber非必须
├─ vip_sum_truePricestring非必须
├─ one_postage_pricestring非必须
├─ _statusobject非必须
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _deliveryTypestring非必须
├─ _pay_timestring非必须
├─ _add_timestring非必须
├─ stop_timenumber非必须
├─ status_picstring非必须
├─ offlinePayStatusnumber非必须
├─ order_logobject非必须
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须

订单确认

基本信息

Path: /api/order/confirm

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cartId text 是 1 购物车编号 (多个请用英文状态逗号隔开 1,2,3)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ deductionboolean非必须订单是否是活动订单
├─ addressInfoobject非必须用户默认地址
├─ idnumber非必须地址ID
├─ uidnumber非必须用户ID
├─ real_namestring非必须姓名
├─ phonestring非必须电话
├─ provincestring非必须省份
├─ citystring非必须城市
├─ city_idnumber非必须城市ID
├─ districtstring非必须区
├─ detailstring非必须详细地址
├─ post_codenumber非必须邮编
├─ longitudestring非必须经度
├─ latitudestring非必须纬度
├─ is_defaultnumber非必须是否默认
├─ seckill_idnumber非必须秒杀ID
├─ combination_idnumber非必须拼团ID
├─ bargain_idnumber非必须砍价ID
├─ cartInfoobject []非必须购物车信息

item 类型: object

├─ idnumber非必须购物车ID
├─ uidnumber非必须用户ID
├─ typestring非必须购物车类型product
├─ product_idnumber非必须商品ID
├─ product_attr_uniquestring非必须商品规格
├─ cart_numnumber非必须数量
├─ add_timenumber非必须添加时间
├─ is_paynumber非必须是否支付
├─ is_delnumber非必须是否删除
├─ is_newnumber非必须是否直接购买
├─ combination_idnumber非必须拼团ID
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ statusnumber非必须状态
├─ productInfoobject非必须商品详情
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须规格状态
├─ costPricestring非必须成本价格
├─ trueStocknumber非必须库存
├─ truePricestring非必须价格
├─ vip_truePricenumber非必须vip价格
├─ priceGroupobject非必须金额信息
├─ storePostagestring非必须订单运费
├─ storeFreePostagenumber非必须订单节省运费
├─ totalPricestring非必须总价
├─ costPricestring非必须成本价
├─ vipPricestring非必须vip价格
├─ storePostageDiscountnumber非必须运费折扣
├─ orderKeystring非必须订单key
├─ offlinePostagestring非必须线下付款运费
├─ userInfoobject非必须用户信息
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须
├─ vipboolean非必须
├─ vip_idnumber非必须
├─ discountnumber非必须
├─ integralRatiostring非必须积分开关
├─ offline_pay_statusnumber非必须线下付款开关
├─ yue_pay_statusnumber非必须余额开关
├─ pay_weixin_opennumber非必须微信支付开关
├─ store_self_mentionnumber非必须
├─ ali_pay_statusboolean非必须支付宝开关
├─ system_storestring []非必须到店自提店铺

item 类型: string

├─ 非必须
├─ invoice_funcboolean非必须
├─ special_invoiceboolean非必须

订单创建

基本信息

Path: /api/order/create/:key

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
key 2076dfaecae7404169f8eea9b3bcdf28 订单信息缓存标识

Body

参数名称 参数类型 是否必须 示例 备注
addressId text 是 1 地址编号
couponId text 是 1 领取优惠券编号
payType text 是 weixin 支付方式
useIntegral text 否 1 是否积分抵扣
mark text 是 订单备注 订单备注
combinationId text 否 1 砍价产品编号
pinkId text 否 1 拼团编号
seckill_id text 否 1 秒杀产品编号
formId text 否 123123213 表单id 小程序模板消息使用
bargainId text 否 1 砍价产品编号
from text 否 weixin 支付类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusstring非必须
├─ resultobject非必须
├─ orderIdstring非必须订单ID
├─ keystring非必须订单key

订单支付

基本信息

Path: /api/order/pay

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
unistring必须订单编号
paytypestring非必须支付方式(默认微信支付)
fromstring必须支付类型|routine=小程序,weixin=微信
quitUrlstring非必须支付宝支付H5上必须填写,小程序不用填写

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ statusstring非必须状态
├─ resultobject非必须
├─ jsConfigobject非必须支付参数
├─ appIdstring非必须appId
├─ nonceStrstring非必须随机字符串
├─ packagestring非必须统一下单接口返回的 prepay_id 参数值
├─ signTypestring非必须签名类型
├─ paySignstring非必须签名
├─ timestampstring非必须时间戳
├─ order_idstring非必须订单编号

订单取消

基本信息

Path: /api/order/cancel

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 wx2019052910013710014 订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单 再次下单

基本信息

Path: /api/order/again

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
unistring必须订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ cateIdstring非必须购物车编号

订单统计数据

基本信息

Path: /api/order/data

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ order_countstring非必须订单数量
├─ sum_pricestring非必须总金额
├─ unpaid_countstring非必须未支付数量
├─ unshipped_countstring非必须未发货数量
├─ received_countstring非必须待收货订单
├─ evaluated_countstring非必须待评价订单
├─ complete_countstring非必须完成订单数量
├─ refund_countstring非必须退款订单数量
├─ yue_pay_statusnumber非必须余额支付开关
├─ pay_weixin_opennumber非必须微信支付开关
├─ ali_pay_statusboolean非必须支付宝支付开关

订单列表

基本信息

Path: /api/order/list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
type 否 0 订单状态
page 否 1 分页参数起始值 默认0查询全部
limit 否 20 分页数步长值
search 否 wx2019071014372910004 搜索订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须订单ID
├─ order_idstring非必须订单order_id
├─ trade_nostring非必须支付回调支付号
├─ uidnumber非必须用户ID
├─ real_namestring非必须真实姓名
├─ user_phonestring非必须电话
├─ user_addressstring非必须地址
├─ cart_idnumber []非必须购物车id

item 类型: number

├─ 非必须
├─ freight_pricestring非必须
├─ total_numnumber非必须总数
├─ total_pricestring非必须总价格
├─ total_postagestring非必须总邮费
├─ pay_pricestring非必须支付金额
├─ pay_postagestring非必须支付邮费
├─ deduction_pricestring非必须积分抵扣
├─ coupon_idnumber非必须使用的优惠券ID
├─ coupon_pricestring非必须优惠券金额
├─ paidnumber非必须是否支付
├─ pay_timenumber非必须支付时间
├─ pay_typestring非必须支付类型
├─ add_timenumber非必须生成订单时间
├─ statusnumber非必须状态
├─ refund_statusnumber非必须退款状态
├─ refund_reason_wap_imgnull非必须退款图
├─ refund_reason_wap_explainnull非必须退款备注说明
├─ refund_reason_timenull非必须退款时间
├─ refund_reason_wapnull非必须退款原因
├─ refund_reasonnull非必须退款说明
├─ refund_pricestring非必须退款金额
├─ delivery_namenull非必须送货人/物流公司
├─ delivery_codestring非必须物流公司编号
├─ delivery_typenull非必须发货类型
├─ delivery_idnull非必须物流单号
├─ fictitious_contentstring非必须虚拟发货备注
├─ delivery_uidnumber非必须送货人ID
├─ gain_integralstring非必须赠送积分
├─ use_integralstring非必须使用积分
├─ back_integralnull非必须退回积分
├─ markstring非必须备注
├─ is_delnumber非必须用户是否删除或者取消订单
├─ uniquestring非必须唯一值
├─ remarknull非必须备注
├─ mer_idnumber非必须0
├─ is_mer_checknumber非必须0
├─ combination_idnumber非必须拼团商品ID
├─ pink_idnumber非必须拼团ID
├─ coststring非必须成本价
├─ seckill_idnumber非必须秒杀商品ID
├─ bargain_idnumber非必须砍价商品ID
├─ verify_codestring非必须核销码
├─ store_idnumber非必须核销后店铺ID
├─ shipping_typenumber非必须订单类型
├─ clerk_idnumber非必须0
├─ is_channelnumber非必须下单端,小程序还是公众号
├─ is_remindnumber非必须是否消息提醒
├─ is_system_delnumber非必须是否系统删除
├─ channel_typestring非必须用户类型
├─ provincestring非必须省份
├─ express_dumpstring非必须面单打印信息
├─ nicknamestring非必须昵称
├─ phonestring非必须电话
├─ spread_uidnumber非必须上级uid
├─ spread_nicknamenull非必须上级昵称
├─ cartInfoobject []非必须购物车信息

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ integral_pricenumber非必须
├─ uniquestring非必须
├─ is_replynumber非必须
├─ _statusobject非必须状态
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _pay_timestring非必须支付时间
├─ _add_timestring非必须下单时间
├─ stop_timenumber非必须
├─ status_picstring非必须
├─ offlinePayStatusnumber非必须线下支付状态
├─ order_logobject非必须订单操作日志
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须

订单详情

基本信息

Path: /api/order/detail/:uni

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
uni wx2019052910013710014 订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须订单ID
├─ order_idstring非必须订单编号
├─ trade_nostring非必须付款编号
├─ uidnumber非必须用户ID
├─ real_namestring非必须姓名
├─ user_phonestring非必须电话
├─ user_addressstring非必须地址
├─ cart_idnumber []非必须购物车ID

item 类型: number

├─ 非必须
├─ freight_pricestring非必须运费
├─ total_numnumber非必须总件数
├─ total_pricestring非必须总价格
├─ total_postagestring非必须总邮费
├─ pay_pricestring非必须支付金额
├─ pay_postagestring非必须支付邮费
├─ deduction_pricestring非必须积分抵扣金额
├─ coupon_idnumber非必须使用的优惠券ID
├─ coupon_pricestring非必须优惠券金额
├─ paidnumber非必须是否支付
├─ pay_timenumber非必须支付时间
├─ pay_typestring非必须支付类型
├─ add_timenumber非必须下单时间
├─ statusnumber非必须状态
├─ refund_statusnumber非必须退款状态
├─ refund_reason_wap_imgnull非必须退款图
├─ refund_reason_wap_explainnull非必须退款备注
├─ refund_reason_timenull非必须退款时间
├─ refund_reason_wapnull非必须退款原因
├─ refund_reasonnull非必须退款原因
├─ refund_pricestring非必须退款金额
├─ delivery_namenull非必须送货人/物流公司
├─ delivery_codestring非必须物流公司编号
├─ delivery_typenull非必须发货类型
├─ delivery_idnull非必须物流单号
├─ fictitious_contentstring非必须虚拟发货备注
├─ delivery_uidnumber非必须送货人ID
├─ gain_integralstring非必须赠送积分
├─ use_integralstring非必须使用积分
├─ back_integralnull非必须退回积分
├─ markstring非必须备注
├─ is_delnumber非必须用户是否删除或者取消订单
├─ uniquestring非必须唯一值
├─ remarknull非必须备注
├─ mer_idnumber非必须0
├─ is_mer_checknumber非必须0
├─ combination_idnumber非必须拼团商品ID
├─ pink_idnumber非必须拼团ID
├─ coststring非必须成本价
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ verify_codestring非必须核销码
├─ store_idnumber非必须核销店铺ID
├─ shipping_typenumber非必须订单类型
├─ clerk_idnumber非必须
├─ is_channelnumber非必须下单端,小程序还是公众号
├─ is_remindnumber非必须是否消息提醒
├─ is_system_delnumber非必须是否系统删除
├─ channel_typestring非必须用户类型
├─ provincestring非必须省份
├─ express_dumpstring非必须面单打印信息
├─ add_time_ystring非必须状态日期
├─ add_time_hstring非必须状态时间
├─ system_storeboolean非必须false
├─ mapKeystring非必须地图key
├─ yue_pay_statusnumber非必须余额支付开关
├─ pay_weixin_opennumber非必须微信支付开关
├─ ali_pay_statusboolean非必须支付宝开关
├─ cartInfoobject []非必须购物车信息

item 类型: object

├─ idnumber非必须购物车ID
├─ uidnumber非必须用户ID
├─ typestring非必须类型
├─ product_idnumber非必须商品ID
├─ product_attr_uniquestring非必须商品规格
├─ cart_numnumber非必须数量
├─ add_timenumber非必须添加时间
├─ is_paynumber非必须是否支付
├─ is_delnumber非必须是否删除
├─ is_newnumber非必须是否直接购买
├─ combination_idnumber非必须拼团ID
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ statusnumber非必须状态
├─ productInfoobject非必须商品信息
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean非必须规格状态
├─ costPricestring非必须成本价
├─ trueStocknumber非必须库存
├─ truePricestring非必须售价
├─ vip_truePricenumber非必须VIP价格
├─ integral_pricenumber非必须积分
├─ uniquestring非必须
├─ is_replynumber非必须
├─ _statusobject非必须状态
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _pay_timestring非必须支付时间
├─ _add_timestring非必须添加时间
├─ stop_timenumber非必须未支付取消时间
├─ status_picstring非必须状态图片
├─ offlinePayStatusnumber非必须线下支付状态
├─ order_logobject非必须订单日志
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须
├─ vip_true_pricenumber非必须VIP价格
├─ postage_pricenumber非必须邮费金额
├─ member_pricenumber非必须会员金额
├─ splitobject非必须拆单列表
├─ virtual_typenumber必须虚拟商品

删除已完成订单

基本信息

Path: /api/order/del

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
unistring必须订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单收货

基本信息

Path: /api/order/take

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
unistring必须订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

订单查看物流

基本信息

Path: /api/order/express/:uni

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
uni wx2019052910013710014 订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ orderobject非必须订单信息
├─ delivery_idstring非必须物流单号
├─ delivery_namestring非必须物流名称
├─ delivery_codestring非必须物流代码
├─ delivery_typestring非必须类型
├─ user_addressstring非必须用户地址
├─ user_markstring非必须用户备注
├─ cartInfoobject []非必须购物车信息

item 类型: object

├─ cart_numnumber非必须
├─ truePricestring非必须
├─ productInfoobject非必须
├─ imagestring非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ expressobject非必须物流信息
├─ resultobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须

订单评价

基本信息

Path: /api/order/comment

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
uniquestring必须购物车和订单号MD5加密的唯一值(订单详情接口内的cartInfo内)
commentstring必须产品评论
picsstring []非必须产品评论图片

item 类型: string

├─ 非必须
product_scorenumber非必须产品分数 0-5(不传默认5分)
service_scorenumber非必须服务分数 0-5(不传默认5分)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单可以使用优惠券列表

基本信息

Path: /api/coupons/order/:price

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
price 1 最低消费金额

Query

参数名称 是否必须 示例 备注
cartId 是 购物车id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须优惠券ID
├─ cidnumber非必须0
├─ uidnumber非必须用户ID
├─ coupon_titlestring非必须优惠券名称
├─ coupon_pricenumber非必须优惠券金额
├─ use_min_pricenumber非必须最小使用金额
├─ add_timestring非必须领取时间
├─ start_timestring非必须开始领取时间
├─ end_timestring非必须结束领取时间
├─ use_timenumber非必须使用时间
├─ typenumber非必须类型
├─ applicable_typenumber非必须
├─ coupon_timenumber非必须优惠券领取后可使用天数
├─ product_idstring非必须商品ID
├─ category_idnumber非必须分类ID
├─ receive_typenumber非必须领取类型
├─ start_use_timenumber非必须使用开始时间
├─ end_use_timenumber非必须使用结束时间
├─ titlestring非必须标题

订单退款理由

基本信息

Path: /api/order/refund/reason

Method: GET

接口描述:

a

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring []非必须订单退款理由

item 类型: string

├─ 非必须

订单退款申请

基本信息

Path: /api/order/refund/verify

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
text text 是 不要了 退款原因
uni text 是 wx2019071014372910004 订单编号
refund_reason_wap_img text 否 tuikuan.png,tuikuan.png,tuikuan.png 退款凭证(多个图片请用,(英文逗号)隔开)
refund_reason_wap_explain text 否 备注说明 备注说明

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单产品信息

基本信息

Path: /api/order/product

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
uniquestring必须购物车和订单号MD5加密的唯一值(订单详情接口返回的数据内 cartInfo)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ cart_numnumber非必须数量
├─ productInfoobject非必须商品信息
├─ imagestring非必须主图
├─ pricestring非必须金额
├─ store_namestring非必须商品名称
├─ attrInfoobject非必须
├─ product_idnumber非必须商品ID
├─ sukstring非必须规格
├─ pricestring非必须金额
├─ imagestring非必须主图
├─ product_idnumber非必须商品ID
├─ combination_idnumber非必须拼团ID
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ order_idstring非必须订单ID

下单之后赠送优惠劵(商品关联优惠劵)

基本信息

Path: /api/v2/order/product_coupon/:orderId

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
orderId

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ cidnumber必须优惠券ID
├─ uidnumber必须用户ID
├─ coupon_titlestring必须优惠券名称
├─ coupon_pricestring必须优惠券金额
├─ use_min_pricestring必须优惠券最小使用金额
├─ add_timestring必须领取时间
├─ end_timestring必须结束使用时间
├─ typestring必须类型

获取未支付订单(废弃)

基本信息

Path: /api/order/nopay

Method: GET

接口描述:

请求参数

门店列表

基本信息

Path: /api/store_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
latitude 是 经度
longitude 是 纬度
page 是 页码
limit 是 每页条数

返回数据

名称类型是否必须默认值备注其他信息
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring非必须门店名称
├─ introductionstring非必须门店介绍
├─ phonestring非必须门店电话
├─ addressstring非必须门店地址
├─ detailed_addressstring非必须详细地址
├─ imagestring非必须门店logo
├─ latitudestring非必须经度
├─ longitudestring非必须纬度
├─ valid_timestring非必须核销有效日期
├─ day_timestring非必须每日营业开关时间
├─ add_timestring非必须添加时间
├─ distancestring非必须距离
├─ rangestring非必须转换单位
├─ tengxun_map_keystring非必须地图key

支付宝支付

基本信息

Path: /api/ali_pay

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
key 是 订单缓存key
quitUrl 是 同步跳转地址

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ pay_contentstring非必须支付参数

微信

小程序登陆

基本信息

Path: /api/wechat/mp_auth

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
code text 是 小程序登陆授权code code 和 key 二选一
cache_key text 是 小程序授权缓存key code 和 key 二选一
spread_spid text 否 分享上级推广人id
spread_code text 是 扫码上级推广人
iv text 是 iv
encryptedData text 是 encryptedData

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ cache_keystring非必须
├─ tokenstring非必须
├─ userInfoobject非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ now_moneystring非必须
├─ integralstring非必须
├─ sign_numnumber非必须
├─ levelnumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ expires_timenumber非必须

微信App登陆

基本信息

Path: /api/wechat/app_auth

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
userInfo text 是 用户详细信息
phone text 是 手机号

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ tokenstring非必须
├─ userInfoobject非必须
├─ expires_timenumber非必须
statusstring必须
msgstring必须

收集小程序form_id

基本信息

Path: /api/wechat/set_form_id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
formId text 是 formId

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须

公众号静默授权(不登录)

基本信息

Path: /api/v2/wechat/wx_silence_auth

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是
spread 是

公众号静默授权(登录)

基本信息

Path: /api/v2/wechat/wx_silence_auth_login

Method: GET

接口描述:

请求参数

公众号静默授权直接绑定手机号

基本信息

Path: /api/v2/phone_wx_silence_auth

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
phone 是
captcha 是
key 是

小程序静默授权(不登录)

基本信息

Path: /api/v2/wechat/silence_auth

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是
spread_code 是
spread_spid 是

小程序静默授权(登录)

基本信息

Path: /api/v2/wechat/silence_auth_login

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是
spread_code 是
spread_spid 是

授权获取小程序用户手机号直接绑定

基本信息

Path: /api/v2/auth_bindind_phone

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是 授权code
iv 是 获取手机号必须参数
encryptedData 是 获取手机号必须参数
spread_code 是 推广人code
spread_spid 是 推广人id
key 是 授权信息保存key

小程序手机号验证码登录静默授权绑定

基本信息

Path: /api/v2/phone_silence_auth

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是 授权code
spread_code 是 推广code
spread_spid 是 推广id
phone 是 手机号
captcha 是 验证码

微信公众号是否关注

基本信息

Path: /api/v2/subscribe

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ subscribeboolean非必须

公众号服务

基本信息

Path: /api/wechat/serve

Method: GET

接口描述:

请求参数

小程序订阅消息列表

基本信息

Path: /api/wechat/teml_ids

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ order_postage_successnull非必须
├─ user_extractstring非必须
├─ oreder_takeverstring非必须
├─ order_clonestring非必须
├─ order_deliver_successstring非必须
├─ pink_truestring非必须
├─ bargain_successstring非必须
├─ order_write_offstring非必须
├─ order_newstring非必须
├─ order_refundstring非必须
├─ recharge_successstring非必须
├─ order_pay_successstring非必须
├─ order_refund_statusstring非必须
├─ integral_accoutstring非必须
├─ pink_statusstring非必须
├─ order_brokeragestring非必须
├─ bind_spread_uidstring非必须

获取直播回放

基本信息

Path: /api/wechat/livePlaybacks/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

获取直播间列表

基本信息

Path: /api/wechat/live

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 页码
limit 否 20 截取条数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ room_idnumber必须
├─ namestring必须
├─ cover_imgstring必须
├─ share_imgstring必须
├─ start_timestring必须
├─ end_timestring必须
├─ anchor_namestring必须
├─ anchor_wechatstring必须
├─ phonestring必须
├─ typenumber必须
├─ screen_typenumber必须
├─ close_likenumber必须
├─ close_goodsnumber必须
├─ close_commentnumber必须
├─ error_msgstring必须
├─ statusnumber必须
├─ live_statusnumber必须
├─ markstring必须
├─ replay_statusnumber必须
├─ sortnumber必须
├─ is_shownumber必须
├─ is_delnumber必须
├─ add_timestring必须
├─ anchor_imgnull必须
├─ roomidnumber必须
├─ goodsstring []必须

item 类型: string

├─ 非必须
├─ show_timestring必须

微信授权

基本信息

Path: /api/wechat/auth

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是
spread 是
login_type 是

返回数据

名称类型是否必须默认值备注其他信息

微信授权登录_新

基本信息

Path: /api/v2/wechat/auth

Method: GET

接口描述:

请求参数

小程序授权登录_新

基本信息

Path: /api/v2/wechat/routine_auth

Method: GET

接口描述:

请求参数

获取微信公众号js配置

基本信息

Path: /api/wechat/config

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
url 是 http://kaifa.crmeb.net 页面路径地址

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ debugboolean非必须
├─ betaboolean非必须
├─ appIdstring非必须
├─ nonceStrstring非必须
├─ timestampnumber非必须
├─ urlstring非必须
├─ signaturestring非必须
├─ jsApiListstring []非必须

item 类型: string

├─ 非必须

用户

个人中心

基本信息

Path: /api/user

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 授权token

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ uidnumber非必须用户ID
├─ real_namestring非必须姓名
├─ birthdaynumber非必须生日
├─ card_idstring非必须身份证
├─ markstring非必须备注
├─ partner_idnumber非必须
├─ group_idnumber非必须用户组
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ phonestring非必须电话
├─ add_timenumber非必须新增时间
├─ last_timenumber非必须最后登录时间
├─ now_moneystring非必须余额
├─ brokerage_pricestring非必须佣金
├─ integralnumber非必须积分
├─ expstring非必须经验
├─ sign_numnumber非必须签到天数
├─ statusnumber非必须状态
├─ levelnumber非必须等级
├─ agent_levelnumber非必须分销等级
├─ spread_opennumber非必须是否开启分销权限
├─ spread_uidnumber非必须上级ID
├─ spread_timenumber非必须绑定时间
├─ user_typestring非必须用户类型
├─ is_promoternumber非必须是否推广员
├─ pay_countnumber非必须支付订单书
├─ spread_countnumber非必须推广用户书
├─ addresstring非必须地址
├─ adminidboolean非必须
├─ login_typestring非必须登录端
├─ record_phonestring非必须临时电话
├─ is_money_levelnumber非必须付费等级
├─ is_ever_levelnumber非必须是否永久
├─ overdue_timenumber非必须到期时间
├─ uniqidstring非必须
├─ is_open_memberboolean非必须付费会员是否开启
├─ agent_level_namestring非必须分销等级
├─ is_completenumber非必须信息是否完整
├─ couponCountnumber非必须优惠券数量
├─ likenumber非必须喜欢
├─ orderStatusNumobject非必须
├─ order_countstring非必须订单总数
├─ sum_pricestring非必须总金额
├─ unpaid_countstring非必须未支付数量
├─ unshipped_countstring非必须未发货数量
├─ received_countstring非必须未收货数量
├─ evaluated_countstring非必须未评价数量
├─ complete_countstring非必须完成数量
├─ refunding_countstring非必须申请退款中数量
├─ refunded_countstring非必须退款完成数量
├─ refund_countstring非必须售后订单数量
├─ yue_pay_statusnumber非必须余额支付开关
├─ pay_weixin_opennumber非必须微信支付开关
├─ ali_pay_statusboolean非必须支付宝支付开关
├─ noticenumber非必须
├─ rechargestring非必须充值
├─ orderStatusSumnumber非必须消费金额
├─ extractTotalPricenumber非必须提现总金额
├─ extractPricestring非必须提现金额
├─ statunumber非必须
├─ promoter_pricestring非必须
├─ broken_commissionstring非必须
├─ commissionCountstring非必须
├─ vipboolean非必须
├─ yesterDaynumber非必须
├─ recharge_switchnumber非必须充值开关
├─ switchUserInfoobject []非必须切换用户

item 类型: object

├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ agent_levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须
├─ broken_daynumber非必须冻结天数
├─ balance_func_statusnumber非必须
├─ invioce_funcboolean非必须
├─ special_invoiceboolean非必须
├─ collectCountnumber非必须
├─ spread_statusboolean非必须
├─ pay_vip_statusboolean非必须
├─ service_numnumber非必须

修改用户信息_新

基本信息

Path: /api/v2/user/user_update

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
userInfo text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

修改绑定手机号

基本信息

Path: /api/user/update_binding_phone

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
phone 是 手机号
captcha 是 短信验证码

返回数据

名称类型是否必须默认值备注其他信息
statusstring非必须
msgstring非必须
datastring非必须

当前登录用户信息

基本信息

Path: /api/userinfo

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ uidnumber非必须编号
├─ real_namestring非必须姓名
├─ birthdaynumber非必须生日
├─ card_idstring非必须身份证
├─ partner_idnumber非必须合伙人id
├─ group_idnumber非必须用户分组id
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ phonestring非必须手机号
├─ now_moneystring非必须余额
├─ integralstring非必须积分
├─ sign_numnumber非必须签到次数
├─ levelnumber非必须等级
├─ spread_uidnumber非必须推广员编号
├─ spread_timenumber非必须推广时间
├─ user_typestring非必须用户类型
├─ is_promoternumber非必须是否为推广员
├─ pay_countnumber非必须支付次数
├─ spread_countnumber非必须推广人数
├─ addresstring非必须地址

检测登录code

基本信息

Path: /api/user/code

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
code 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

清除用户搜索记录

基本信息

Path: /api/v2/user/clean_search

Method: GET

接口描述:

请求参数

用户修改信息

基本信息

Path: /api/user/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
avatarstring必须用户头像
nicknamestring必须用户昵称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

用户修改手机号

基本信息

Path: /api/user/updatePhone

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
phone text 是 电话
captcha text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户搜索记录

基本信息

Path: /api/v2/user/search_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ keywordstring非必须
├─ vicwordstring非必须
├─ numnumber非必须
├─ resultstring []非必须

item 类型: string

├─ 非必须
├─ is_delnumber非必须
├─ add_timenumber非必须

用户绑定手机号

基本信息

Path: /api/api/user/binding

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
phone 是
captcha 是
step 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户资金统计

基本信息

Path: /api/user/balance

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ now_moneystring非必须当前总资金
├─ rechargenumber非必须累计充值
├─ orderStatusSumnumber非必须累计消费

获取分销海报详细信息

基本信息

Path: /api/user/spread_info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ spreadobject []非必须海报背景

item 类型: object

├─ picstring必须
├─ nicknamestring非必须用户昵称
├─ site_namestring非必须商城名称

获取小程序二维码

基本信息

Path: /api/user/routine_code

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
dataobject非必须
├─ urlstring非必须小程序二维码地址
statusnumber必须状态
msgstring必须说明

获取用户和客服聊天列表

基本信息

Path: /api/user/record

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
nickname 否 客服聊天用户搜索
is_tourist 否 0 是否为游客
page 是 1 页码
limit 是 10 展示条数

返回数据

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"status":{"type":"number"},"msg":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"id"},"user_id":{"type":"number","description":"客服id"},"to_uid":{"type":"number","description":"送达人id"},"add_time":{"type":"number","description":"添加时间"},"update_time":{"type":"number","description":"更新时间"},"mssage_num":{"type":"number","description":"未读取消息条数"},"nickname":{"type":"string","description":"昵称"},"avatar":{"type":"string","description":"头像"},"online":{"type":"number","description":"0=不在线,1=在线"},"type":{"type":"string","description":"\t0 = pc,1=微信,2=小程序,3=H5\t"},"message_type":{"type":"number","description":"最后发送的内容信息的类型 1=文字 2=表情 3=图片 4=语音\t"},"message":{"type":"string","description":"最后发送的内容信息"}},"required":["online","type","avatar","id","user_id","add_time","to_uid","update_time","mssage_num","nickname","message_type","message"]}}}}

设置登录code

基本信息

Path: /api/user/code

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
code text 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

退出登录

基本信息

Path: /api/logout

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

静默绑定推广人

基本信息

Path: /api/user/spread

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
puid text 是 推广人id
code text 是 推广code

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

切换H5登陆

基本信息

Path: /api/switch_h5

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
from 是 routine wechat=公众号,routine=小程序

返回数据

名称类型是否必须默认值备注其他信息

客服

保存客服反馈内容

基本信息

Path: /api/user/service/feedback

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
rela_name text 是 姓名
phone text 是 电话
content text 是 反馈内容

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

客服列表

基本信息

Path: /api/user/service/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ idinteger非必须客服编号
├─ uidinteger非必须客服用户编号
├─ avatarstring非必须客服头像
├─ nicknamestring非必须客服名称

客服聊天记录

基本信息

Path: /api/user/service/record/:toUid

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
toUid 1 聊天人编号

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ idinteger非必须消息编号
├─ msnstring非必须消息内容
├─ uidinteger非必须聊天人编号
├─ nicknamestring非必须聊天人昵称
├─ avatarstring非必须聊天人头像
├─ to_uidinteger非必须聊天人编号
├─ to_nicknamestring非必须聊天人昵称
├─ to_avatarstring非必须聊天人头像
├─ add_timenumber非必须聊天时间
├─ typenumber非必须是否已读
├─ remindnumber非必须是否提醒过
├─ msn_typenumber非必须消息类型|1=文字,2=表情,3=图片,4=语音

客服聊天记录版本2

基本信息

Path: /api/v2/user/service/record

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
uidTo 否 1 第一个数组的id
limit 否 20 分页数步长值
toUid 否 和谁用户聊天的uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ serviceListobject []非必须聊天记录

item 类型: object

├─ idnumber非必须获取上一页传值给uidTo
├─ msnstring非必须内容
├─ uidnumber非必须用户uid
├─ to_uidnumber非必须发送给谁
├─ time_nodenumber非必须时间节点
├─ add_timestring非必须添加时间
├─ typenumber非必须是否已读(0:否;1:是;)
├─ remindnumber非必须是否提醒过
├─ msn_typenumber非必须消息类型 1=文字 2=表情 3=图片 4=语音
├─ nicknamestring非必须用户名
├─ avatarstring非必须用户昵称
├─ uidnumber非必须和谁聊天的uid
├─ nicknamestring必须当前聊天对象名称

获取客服反馈头部文字信息

基本信息

Path: /api/user/service/feedback

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ feedbackstring非必须内容

获取客服页面广告(已废弃)

基本信息

Path: /api/user/service/get_adv

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

个人中心->付费会员

会员优惠券

基本信息

Path: /api/user/member/coupons/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须优惠券ID
├─ cidnumber必须0
├─ uidnumber必须用户ID
├─ coupon_titlestring必须优惠券标题
├─ coupon_pricenumber必须优惠券金额
├─ use_min_pricenumber必须最小使用金额
├─ add_timestring必须添加时间
├─ start_timenumber必须开始领取时间
├─ end_timestring必须结束领取时间
├─ use_timenumber必须使用时间
├─ typestring必须类型
├─ statusstring必须状态
├─ is_failnumber必须师傅哦失效
├─ applicable_typenumber必须
├─ coupon_timenumber必须领取后几天可用
├─ product_idstring必须商品ID
├─ category_idnumber必须分类ID
├─ receive_typenumber必须领取类型
├─ start_use_timenumber必须开始使用时间
├─ end_use_timenumber必须结束使用时间
├─ coupon_typestring必须优惠券类型
├─ _typenumber必须使用类型
├─ _msgstring必须备注
├─ _add_timestring必须开始时间
├─ _end_timestring必须结束时间

会员卡主界面

基本信息

Path: /api/user/member/card/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ member_rightsobject []非必须会员权益

item 类型: object

├─ idnumber必须ID
├─ right_typestring必须权益类型
├─ titlestring必须名称
├─ show_titlestring必须显示名称
├─ imagestring必须图片
├─ explainstring必须说明
├─ numbernumber必须规则数字
├─ sortnumber必须排序
├─ statusnumber必须状态
├─ add_timenumber必须添加时间
├─ picstring必须图片
├─ rightstring必须说明
├─ is_get_freeobject非必须
├─ pricenumber非必须金额
├─ pre_pricenumber非必须原价
├─ titlestring非必须名称
├─ typestring非必须类型
├─ vip_daynumber非必须天数
├─ is_recordnumber非必须
├─ user_infoobject非必须用户信息
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ agent_levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须
├─ register_daysnumber非必须
├─ economize_moneystring非必须
├─ shop_namestring非必须
├─ member_explainobject非必须会员协议
├─ idnumber非必须编号
├─ typenumber非必须类型
├─ titlestring非必须名称
├─ contentstring非必须内容
├─ sortnumber非必须排序
├─ statusnumber非必须状态
├─ add_timenumber非必须添加时间
├─ member_typeobject []非必须会员卡

item 类型: object

├─ titlestring必须名称
├─ typestring必须类型
├─ vip_daynumber必须时间
├─ pre_pricestring必须原价支付价格
├─ pricestring必须
├─ member_couponsstring []非必须会员优惠券

item 类型: string

├─ 非必须

卡密领取会员卡

基本信息

Path: /api/user/member/card/draw

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
member_card_code text 是 CR0003120091592118 卡号
member_card_pwd text 是 82000 卡密
from text 是 weixin 来源

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

线下扫码付款

基本信息

Path: /api/order/offline/create

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pay_type text 是 weixin 微信:weixin,余额:yue,线下:offile
type text 是 3 0:免费领取会员 ,1:购买会员 ,2:卡密领取会员 ,3:线下付款
from text 是 weixin 微信:weixin ,h5:h5,小程序: routine
price text 是 520 价格

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusstring非必须
├─ resultobject非必须
├─ orderIdstring非必须订单ID

线下支付方式

基本信息

Path: /api/order/offline/pay/type

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ offline_pay_statusstring非必须

获取会员时长

基本信息

Path: /api/user/member/overdue/time

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
member_type 是 会员类型
vip_day 是 有效时长

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ datastring非必须

计算会员线下付款金额

基本信息

Path: /api/order/offline/check/price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pay_price text 是 520 线下支付金额

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ pay_pricenumber非必须

购买会员卡

基本信息

Path: /api/user/member/card/create

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pay_type 是 yue 微信:weixin,余额:yue,线下:offile
type 是 1 0:免费领取会员 ,1:购买会员 ,2:卡密领取会员 ,3:线下付款
from 是 weixin 微信:weixin ,h5:h5,小程序: routine
member_type 是 free 免费:free,月卡:month,季卡:quarter,年卡:year,ever:永久(购买会员卡必填,线下付款无需)
price 是 12.3 价格
quitUrl 是 支付宝连接

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusstring非必须
├─ resultobject非必须
├─ orderIdstring非必须

个人中心->发票管理

删除发票

基本信息

Path: /api/v2/invoice/del/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 10 发票id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

开票详情

基本信息

Path: /api/v2/order/invoice_detail/:uni

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
uni wx999999 订单号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须订单ID
├─ order_idstring非必须订单编号
├─ trade_nostring非必须支付编号
├─ uidnumber非必须用户ID
├─ real_namestring非必须姓名
├─ user_phonestring非必须电话
├─ user_addressstring非必须地址
├─ cart_idstring []非必须购物车ID

item 类型: string

├─ 非必须
├─ freight_pricestring非必须运费
├─ total_numnumber非必须总数
├─ total_pricestring非必须总价
├─ total_postagestring非必须邮费
├─ pay_pricestring非必须支付金额
├─ pay_postagestring非必须支付邮费
├─ deduction_pricestring非必须积分抵扣金额
├─ coupon_idnumber非必须优惠券ID
├─ coupon_pricestring非必须优惠券金额
├─ paidnumber非必须是否支付
├─ pay_timenumber非必须支付时间
├─ pay_typestring非必须支付类型
├─ add_timenumber非必须创建订单时间
├─ statusnumber非必须状态
├─ refund_statusnumber非必须退款状态
├─ refund_typenumber非必须退款类型
├─ refund_expressstring非必须退款订单号
├─ refund_reason_wap_imgnull非必须退款图
├─ refund_reason_wap_explainnull非必须退款备注
├─ refund_reason_timenull非必须退款时间
├─ refund_reason_wapnull非必须退款原因
├─ refund_reasonnull非必须退款说明
├─ refund_pricestring非必须退款金额
├─ delivery_namenull非必须送货人/物流公司
├─ delivery_codestring非必须物流公司编号
├─ delivery_typenull非必须发货类型
├─ delivery_idnull非必须物流单号
├─ fictitious_contentstring非必须虚拟发货备注
├─ delivery_uidnumber非必须送货人ID
├─ gain_integralstring非必须赠送积分
├─ use_integralstring非必须使用积分
├─ back_integralnull非必须退回积分
├─ spread_uidnumber非必须上级uid
├─ one_brokeragestring非必须一级返佣
├─ two_brokeragestring非必须二级返佣
├─ markstring非必须备注
├─ is_delnumber非必须是否删除
├─ uniquestring非必须唯一值
├─ remarknull非必须备注
├─ mer_idnumber非必须0
├─ is_mer_checknumber非必须0
├─ combination_idnumber非必须拼团商品ID
├─ pink_idnumber非必须拼团ID
├─ coststring非必须成本价
├─ seckill_idnumber非必须秒杀ID
├─ bargain_idnumber非必须砍价ID
├─ verify_codestring非必须核销码
├─ store_idnumber非必须店铺ID
├─ shipping_typenumber非必须订单类型
├─ clerk_idnumber非必须
├─ is_channelnumber非必须下单端,小程序还是公众号
├─ is_remindnumber非必须是否消息提醒
├─ is_system_delnumber非必须是否系统删除
├─ channel_typestring非必须用户类型
├─ provincestring非必须省份
├─ express_dumpstring非必须面单打印信息
├─ invoiceobject非必须发票信息
├─ idnumber非必须
├─ uidnumber非必须
├─ categorystring非必须
├─ order_idnumber非必须
├─ invoice_idnumber非必须
├─ header_typenumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ duty_numberstring非必须
├─ drawer_phonestring非必须
├─ emailstring非必须
├─ tellstring非必须
├─ addressstring非必须
├─ bankstring非必须
├─ card_numberstring非必须
├─ is_paynumber非必须
├─ is_refundnumber非必须
├─ is_invoicenumber非必须
├─ invoice_numberstring非必须
├─ remarkstring非必须
├─ invoice_timenumber非必须
├─ add_timestring非必须
├─ add_time_ystring非必须
├─ add_time_hstring非必须
├─ system_storeboolean非必须
├─ mapKeystring非必须
├─ yue_pay_statusnumber非必须
├─ pay_weixin_opennumber非必须
├─ ali_pay_statusboolean非必须
├─ cartInfoobject []非必须

item 类型: object

├─ idstring非必须
├─ typestring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ combination_idnumber非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ imagestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ postagestring非必须
├─ give_integralstring非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ store_namestring非必须
├─ unit_namestring非必须
├─ is_shownumber非必须
├─ is_delnumber非必须
├─ is_postagenumber非必须
├─ coststring非必须
├─ is_subnumber非必须
├─ temp_idnumber非必须
├─ is_vipnumber非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ trueStocknumber非必须
├─ costPricestring非必须
├─ uniquestring非必须
├─ is_replynumber非必须
├─ vip_sum_truePricestring非必须
├─ _statusobject非必须
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _pay_timestring非必须
├─ _add_timestring非必须
├─ stop_timenumber非必须
├─ status_picstring非必须
├─ offlinePayStatusnumber非必须
├─ order_logobject非必须
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须

用户单个发票详情

基本信息

Path: /api/v2/invoice/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ header_typenumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ duty_numberstring非必须
├─ drawer_phonestring非必须
├─ emailstring非必须
├─ tellstring非必须
├─ addressstring非必须
├─ bankstring非必须
├─ card_numberstring非必须
├─ is_defaultnumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须

用户发票列表

基本信息

Path: /api/v2/invoice

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
header_type 是 抬头类型1:个人2:企业
type 是 发票类型1:普通2:专用
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ header_typenumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ duty_numberstring非必须
├─ drawer_phonestring非必须
├─ emailstring非必须
├─ tellstring非必须
├─ addressstring非必须
├─ bankstring非必须
├─ card_numberstring非必须
├─ is_defaultnumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须

用户开票记录

基本信息

Path: /api/v2/order/invoice_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ categorystring必须
├─ order_idnumber必须
├─ invoice_idnumber必须
├─ header_typenumber必须
├─ typenumber必须
├─ namestring必须
├─ duty_numberstring必须
├─ drawer_phonestring必须
├─ emailstring必须
├─ tellstring必须
├─ addressstring必须
├─ bankstring必须
├─ card_numberstring必须
├─ is_paynumber必须
├─ is_refundnumber必须
├─ is_invoicenumber必须
├─ invoice_numberstring必须
├─ remarkstring必须
├─ invoice_timenumber必须
├─ add_timestring必须
├─ orderobject必须
├─ idnumber非必须
├─ order_idstring非必须
├─ trade_nostring非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ user_phonestring非必须
├─ user_addressstring非必须
├─ cart_idstring []非必须

item 类型: string

├─ 非必须
├─ freight_pricestring非必须
├─ total_numnumber非必须
├─ total_pricestring非必须
├─ total_postagestring非必须
├─ pay_pricestring非必须
├─ pay_postagestring非必须
├─ deduction_pricestring非必须
├─ coupon_idnumber非必须
├─ coupon_pricestring非必须
├─ paidnumber非必须
├─ pay_timenumber非必须
├─ pay_typestring非必须
├─ add_timenumber非必须
├─ statusnumber非必须
├─ refund_statusnumber非必须
├─ refund_reason_wap_imgstring,null非必须
├─ refund_reason_wap_explainstring,null非必须
├─ refund_reason_timenumber,null非必须
├─ refund_reason_wapstring,null非必须
├─ refund_reasonnull非必须
├─ refund_pricestring非必须
├─ delivery_namenull非必须
├─ delivery_codestring非必须
├─ delivery_typenull非必须
├─ delivery_idnull非必须
├─ fictitious_contentstring非必须
├─ delivery_uidnumber非必须
├─ gain_integralstring非必须
├─ use_integralstring非必须
├─ back_integralnull非必须
├─ markstring非必须
├─ is_delnumber非必须
├─ uniquestring非必须
├─ remarknull非必须
├─ mer_idnumber非必须
├─ is_mer_checknumber非必须
├─ combination_idnumber非必须
├─ pink_idnumber非必须
├─ coststring非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ verify_codestring非必须
├─ store_idnumber非必须
├─ shipping_typenumber非必须
├─ clerk_idnumber非必须
├─ is_channelnumber非必须
├─ is_remindnumber非必须
├─ is_system_delnumber非必须
├─ channel_typestring非必须
├─ provincestring非必须
├─ express_dumpstring非必须
├─ cartInfoobject []非必须

item 类型: object

├─ idnumber,string必须
├─ uidnumber必须
├─ typestring必须
├─ product_idnumber必须
├─ product_attr_uniquestring必须
├─ cart_numnumber必须
├─ add_timenumber必须
├─ is_paynumber必须
├─ is_delnumber必须
├─ is_newnumber必须
├─ combination_idnumber必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ statusnumber必须
├─ productInfoobject必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean必须
├─ costPricestring必须
├─ trueStocknumber必须
├─ truePricestring必须
├─ vip_truePricenumber必须
├─ integral_pricenumber必须
├─ uniquestring必须
├─ is_replynumber必须
├─ _statusobject非必须
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _pay_timestring非必须
├─ _add_timestring非必须
├─ stop_timenumber非必须
├─ status_picstring非必须
├─ offlinePayStatusnumber非必须
├─ order_logobject非必须
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须

用户添加|修改发票

基本信息

Path: /api/v2/invoice/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 10
header_type text 是 1
type text 是 1
drawer_phone text 是 13572879909
name text 是 张三(某某技术有限公司)
duty_number text 是
tell text 是
address text 是
bank text 是
card_number text 是
is_default text 是 0
email text 是 [email protected]

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户设置默认发票

基本信息

Path: /api/v2/invoice/set_default/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

路径参数

参数名称 示例 备注
id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

获取用户默认发票

基本信息

Path: /api/v2/invoice/get_default/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 1 发票类型1:普通2:专用

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ header_typenumber非必须
├─ typenumber非必须
├─ namestring非必须
├─ duty_numberstring非必须
├─ drawer_phonestring非必须
├─ emailstring非必须
├─ tellstring非必须
├─ addressstring非必须
├─ bankstring非必须
├─ card_numberstring非必须
├─ is_defaultnumber非必须
├─ is_delnumber非必须
├─ add_timestring非必须

订单申请开票

基本信息

Path: /api/v2/order/make_up_invoice

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单id
invoice_id text 是 发票id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

个人中心->积分中心

积分记录

基本信息

Path: /api/integral/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ link_idstring必须
├─ pmnumber必须
├─ titlestring必须
├─ categorystring必须
├─ typestring必须
├─ numbernumber必须
├─ balancestring必须
├─ markstring必须
├─ add_timestring必须
├─ statusnumber必须
├─ takenumber必须

个人中心->我的等级

会员经验列表

基本信息

Path: /api/api/user/level/expList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须
├─ numberstring必须
├─ add_timestring必须

检测用户是否可以升级

基本信息

Path: /api/user/level/detection

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须

用户等级列表

基本信息

Path: /api/user/level/grade

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ listobject []非必须任务列表

item 类型: object

├─ namestring非必须会员名称
├─ discountnumber非必须享受折扣
├─ imagestring非必须会员卡背景
├─ iconstring非必须会员等级
├─ explainstring非必须会员任务等级说明
├─ idinteger非必须任务等级编号
├─ gradenumber非必须会员等级
├─ is_clearboolean非必须会员状态||true=关闭,false=开启
├─ taskobject非必须
├─ listobject []非必须任务列表

item 类型: object

├─ namestring非必须任务名称
├─ real_namestring非必须配置原名
├─ task_typestring非必须任务类型
├─ illustratestring非必须任务说明
├─ numbernumber非必须限定数
├─ idinteger非必须任务编号
├─ reach_countnumber非必须完成的任务数量
├─ taskobject []非必须任务列表

item 类型: object

├─ namestring非必须任务名称
├─ real_namestring非必须配置原名
├─ task_typestring非必须任务类型
├─ illustratestring非必须任务说明
├─ numbernumber非必须限定数
├─ idinteger非必须任务编号
├─ new_numberstring非必须新限定数
├─ speedstring非必须任务完成率
├─ finishstring非必须条件是否满足|1=满足,0=未满足
├─ task_type_titlestring非必须未满足提示

用户等级详情信息

基本信息

Path: /api/api/user/level/info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ userobject非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ birthdaynumber非必须
├─ card_idstring非必须
├─ markstring非必须
├─ partner_idnumber非必须
├─ group_idnumber非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ phonestring非必须
├─ add_timenumber非必须
├─ last_timenumber非必须
├─ now_moneystring非必须
├─ brokerage_pricestring非必须
├─ integralnumber非必须
├─ expstring非必须
├─ sign_numnumber非必须
├─ statusnumber非必须
├─ levelnumber非必须
├─ spread_opennumber非必须
├─ spread_uidnumber非必须
├─ spread_timenumber非必须
├─ user_typestring非必须
├─ is_promoternumber非必须
├─ pay_countnumber非必须
├─ spread_countnumber非必须
├─ addresstring非必须
├─ adminidnumber非必须
├─ login_typestring非必须
├─ record_phonestring非必须
├─ is_money_levelnumber非必须
├─ is_ever_levelnumber非必须
├─ overdue_timenumber非必须
├─ uniqidstring非必须
├─ level_infoobject非必须
├─ expstring非必须
├─ today_expnumber非必须
├─ level_listobject []非必须

item 类型: object

├─ idnumber必须
├─ mer_idnumber必须
├─ namestring必须
├─ moneystring必须
├─ valid_datenumber必须
├─ is_forevernumber必须
├─ is_paynumber必须
├─ is_shownumber必须
├─ gradenumber必须
├─ discountnumber必须
├─ imagestring必须
├─ iconstring必须
├─ explainstring必须
├─ add_timestring必须
├─ is_delnumber必须
├─ exp_numnumber必须
├─ next_exp_numnumber必须
├─ taskobject非必须
├─ sign_countnumber非必须
├─ signstring非必须
├─ orderstring非必须
├─ invitestring非必须

获取等级任务

基本信息

Path: /api/user/level/task/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 任务等级编号(会员等级列表接口获取)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ listobject []非必须任务列表

item 类型: object

├─ namestring非必须任务名称
├─ real_namestring非必须配置原名
├─ task_typestring非必须任务类型
├─ illustratestring非必须任务说明
├─ numbernumber非必须限定数
├─ idinteger非必须任务编号
├─ reach_countnumber非必须完成的任务数量
├─ taskobject []非必须任务列表

item 类型: object

├─ namestring非必须任务名称
├─ real_namestring非必须配置原名
├─ task_typestring非必须任务类型
├─ illustratestring非必须任务说明
├─ numbernumber非必须限定数
├─ idinteger非必须任务编号
├─ new_numbernumber非必须新限定数
├─ speedstring非必须任务完成率
├─ task_type_titlestring非必须未满足提示
├─ finishnumber非必须条件是否满足|1=满足,0=未满足

个人中心->统计管理

获取物流公司

基本信息

Path: /api/admin/order/export_all

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber必须快递公司id
├─ namestring必须快递公司名称
├─ codestring必须快递公司编码
├─ markstring必须快递公司备注
├─ countnumber非必须

获取物流公司模板

基本信息

Path: /api/admin/order/export_temp

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是

Query

参数名称 是否必须 示例 备注
com 是 物流公司编码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idnumber非必须模板数据库id
├─ titlestring非必须模板标题
├─ codestring非必须模板编码
├─ picstring非必须模板预览图
├─ temp_idstring非必须模板id
├─ countnumber非必须

获取订单打印默认配置

基本信息

Path: /api/admin/order/delivery_info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ express_temp_idstring非必须模板id
├─ to_namestring非必须发货人姓名
├─ to_telstring非必须发货人电话
├─ to_addstring非必须发货人地址
├─ idstring必须快递公司id

订单交易额/订单数量时间统计

基本信息

Path: /api/admin/order/time

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start 否 1561910400 开始时间默认本月开始时间
stop 否 1561910400 结束时间默认当前时间
type 否 1 统计类型

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ chartobject []非必须月 周统计数据

item 类型: object

├─ numstring非必须营业额/订单数量
├─ timestring非必须天
├─ timenumber非必须时间区间营业额/订单数量
├─ growth_ratenumber非必须时间区间增长率
├─ increase_timenumber非必须同比上个时间区间增长营业额/订单数量
├─ increase_time_statusnumber非必须同比上个时间区间状态|1=增长,2=减少

订单列表

基本信息

Path: /api/admin/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 1 订单状态
page 否 1 分页参数起始值默认0为查询全部
limit 否 10 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ idinteger非必须订单ID
├─ pay_typestring非必须支付方式
├─ order_idstring非必须订单编号
├─ add_timestring非必须订单添加时间
├─ statusnumber非必须订单状态
├─ total_numnumber非必须订单数量
├─ total_pricestring非必须订单价格
├─ total_postagestring非必须订单邮费
├─ pay_pricestring非必须实付金额
├─ pay_postagestring非必须实付邮费
├─ paidnumber非必须支付状态
├─ remarkstring非必须订单备注
├─ _infoobject []非必须订单购物车信息

item 类型: object

├─ cart_infoobject非必须订单购物车信息
├─ idinteger非必须购物车编号
├─ cart_numnumber非必须购物车数量
├─ productInfoobject非必须产品信息
├─ imagestring非必须产品图片
├─ pricestring非必须产品价格
├─ ot_pricestring非必须产品原价
├─ store_namestring非必须产品名称
├─ sukstring非必须产品属性
├─ status_namestring非必须订单状态名称

订单发货提交

基本信息

Path: /api/admin/order/delivery/keep/:id

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

路径参数

参数名称 示例 备注
id

Body

名称类型是否必须默认值备注其他信息
typestring必须1=发货,2=送货,3=虚拟
delivery_typestring必须快递公司
delivery_namestring非必须快递公司id
delivery_codestring非必须快递公司编号
express_record_typestring必须1=自行发货,2=电子面单打印
express_temp_idstring必须快递面单id
to_namestring必须发货人名称
to_telstring必须发货人电话
to_addrstring必须发货人地址
sh_delivery_namestring必须送货人姓名
sh_delivery_idstring必须送货人id
sh_delivery_uidstring必须送货人uid

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单发货获取订单信息

基本信息

Path: /api/admin/order/delivery/gain/:orderId

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
orderId wx2019072514554910001 订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ real_namestring非必须收货人姓名
├─ user_phonestring非必须收货人电话
├─ user_addressstring非必须收货人地址
├─ order_idstring非必须订单号
├─ nicknamestring非必须用户昵称

订单备注

基本信息

Path: /api/admin/order/remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
order_idstring非必须订单编号
remarkstring非必须订单备注

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单支付

基本信息

Path: /api/admin/order/offline

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
order_idstring必须订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单改价

基本信息

Path: /api/admin/order/price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
order_idstring非必须订单编号
pricestring非必须支付金额

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

订单数据统计

基本信息

Path: /api/admin/order/statistics

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ order_countnumber非必须订单支付没有退款数量
├─ sum_pricenumber非必须订单支付没有退款 支付总金额
├─ unpaid_countnumber非必须订单待支付 数量
├─ unshipped_countnumber非必须订单待发货 数量
├─ received_countnumber非必须订单待收货 数量
├─ evaluated_countnumber非必须订单待评价 数量
├─ complete_countnumber非必须订单已完成 数量
├─ refund_countnumber必须订单退款 数量
├─ todayPricenumber非必须今日成交额
├─ todayCountnumber非必须今日订单数
├─ proPricenumber非必须昨日成交额
├─ proCountnumber非必须昨日订单数
├─ monthPricenumber非必须本月成交额
├─ monthCountnumber非必须本月订单数

订单每月统计数据

基本信息

Path: /api/admin/order/data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值默认0查询全部
limit 否 10 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ pricestring非必须金额
├─ countnumber非必须数量
├─ timestring非必须日期 月-日

订单详情

基本信息

Path: /api/admin/order/detail/:orderId

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
orderId wx2019072514554910001 订单编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须订单详情
├─ idinteger非必须订单ID
├─ order_idstring非必须订单编号
├─ add_timestring非必须下单时间
├─ total_numnumber非必须订单数量
├─ total_pricestring非必须订单金额
├─ pay_pricestring非必须实付金额
├─ pay_postagestring非必须实付邮费
├─ paidnumber非必须是否支付|1=支付,0=未支付
├─ remarknull非必须管理员备注
├─ markstring非必须会员备注
├─ real_namestring非必须收货人信息
├─ user_phonestring非必须收货人手机号
├─ user_addressstring非必须收货人地址
├─ coupon_pricestring非必须优惠券抵扣金额
├─ freight_pricestring非必须运费
├─ _infoobject []非必须购物车信息

item 类型: object

├─ cart_infoobject非必须购物车信息
├─ cart_numnumber非必须购物车数量
├─ productInfoobject非必须产品信息
├─ imagestring非必须产品图片
├─ pricestring非必须产品价格
├─ ot_pricestring非必须产品原价
├─ store_namestring非必须产品名称
├─ sukstring非必须产品属性
├─ _statusobject非必须状态详情
├─ _typenumber非必须状态类型|0=未支付,1=未发货,2=待收货,3=待评价,4=交易完成,-1=申请退款中,-2=已退款,11=拼团中
├─ _titlestring非必须状态名称
├─ _msgstring非必须状态备注
├─ _classstring非必须状态样式
├─ _payTypestring非必须支付方式
├─ nicknamestring非必须会员昵称
├─ pay_typestring非必须支付方式
├─ delivery_namestring非必须快递单号/手机号
├─ delivery_typestring非必须发货类型
├─ delivery_idstring非必须快递单号/手机号

订单退款

基本信息

Path: /api/admin/order/refund

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
orderIdstring必须订单编号
pricenumber必须退款金额
typenumber必须订单退款后状态|直接退款=1,退款后,返回原状态=2

返回数据

名称类型是否必须默认值备注其他信息
statusstring必须
msgstring必须

配送员列表(全部)

基本信息

Path: /api/admin/order/delivery

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须配送员id
├─ uidnumber非必须配送员uid
├─ avatarstring非必须配送员图像
├─ wx_namestring非必须微信昵称
├─ statusnumber非必须状态
├─ add_timestring非必须添加时间
├─ phonestring非必须手机号
├─ nicknamestring非必须当前名称

物流公司列表

基本信息

Path: /api/logistics

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ namestring非必须物流公司名称

个人中心->我的推广

佣金排行

基本信息

Path: /api/brokerage_rank

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 week month 类型
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ rankobject []非必须

item 类型: object

├─ uidnumber必须
├─ brokerage_pricestring必须
├─ nicknamestring必须
├─ avatarstring必须
├─ positionnumber非必须

推广人排行

基本信息

Path: /api/rank

Method: GET

接口描述:

请求参数

推广佣金/提现总和

基本信息

Path: /api/spread/count/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 3 佣金类型3=佣金,4=提现

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ countnumber非必须佣金总额

推广佣金明细

基本信息

Path: /api/spread/commission/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 0 佣金类型

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值(默认0 全部查询)
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject []非必须

item 类型: object

├─ timestring非必须年月
├─ listobject []非必须佣金记录信息

item 类型: object

├─ add_timestring非必须添加时间
├─ titlestring非必须标题
├─ numberstring非必须佣金
├─ pmnumber非必须佣金状态|0=支出,1=收入

推广分销二维码海报生成

基本信息

Path: /api/spread/banner

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 1 1=小程序,2=公众号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ picstring必须
├─ wap_posterstring必须

推广数据接口(昨天的佣金 累计提现金额 当前佣金)

基本信息

Path: /api/commission

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ uidnumber非必须
├─ pmnumber非必须
├─ commissionCountnumber非必须
├─ lastDayCountnumber非必须
├─ extractCountnumber非必须

推广用户

基本信息

Path: /api/spread/people

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pagestring必须分页参数起始值
limitstring必须分页数步长值
gradestring必须推荐人类型|0=一级|1=二级
keywordstring必须会员名称查询
sortstring必须排序|childCount(ASC/DESC)=团队排序,numberCount(ASC/DESC)=金额排序,orderCount(ASC/DESC)=订单排序

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ totalnumber非必须
├─ totalLevelnumber非必须
├─ listobject []非必须

item 类型: object

├─ uidnumber必须
├─ nicknamestring必须
├─ avatarstring必须
├─ timestring必须
├─ spread_timenumber必须
├─ childCountnumber必须
├─ orderCountnumber必须
├─ numberCountnull必须
├─ countnumber非必须

推广订单

基本信息

Path: /api/spread/order

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pagestring必须分页参数起始值
limitstring必须分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ timestring非必须
├─ childobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ order_idstring非必须
├─ timestring非必须
├─ numberstring非必须
├─ typestring非必须
├─ time_keystring非必须
├─ avatarstring非必须
├─ nicknamestring非必须
├─ countnumber非必须
├─ countnumber非必须

提现申请

基本信息

Path: /api/extract/cash

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
alipay_code text 否 666666 支付宝账号
extract_type text 是 weixin 提现方式
money text 是 1 提现金额
name text 是 姓名 提现用户名称
bankname text 否 561561561615165156 提现银行名称
cardnum text 否 561561561615165156 提现银行卡号
weixin text 否 123213 微信账号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

提现银行/提现最低金额

基本信息

Path: /api/extract/bank

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ broken_commissionstring非必须
├─ brokerage_pricestring非必须
├─ commissionCountstring非必须
├─ extractBankstring []非必须

item 类型: string

├─ 非必须
├─ minPricestring非必须

个人中心->地址信息

修改/添加地址

基本信息

Path: /api/address/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
address[province] text 是 陕西省 省
address[city] text 是 西安市 市
address[district] text 是 莲湖区 区
address[city_id] text 是 城市ID
detail text 是 阳光大奥 详细地址
is_default text 是 1 是否默认地址 1默认地址 0 非默认地址
real_name text 是 姓名 姓名
phone text 是 18688886666 手机号
id text 是 地址编号 0 添加地址 非0 修改对应编号的地址信息

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须

删除地址

基本信息

Path: /api/address/del

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须地址编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

地址列表

基本信息

Path: /api/address/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页参数起始值
limit 否 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ idnumber非必须
├─ real_namestring非必须
├─ phonestring非必须
├─ provincestring非必须
├─ citystring非必须
├─ districtstring非必须
├─ detailstring非必须
├─ is_defaultnumber非必须
├─ city_idnumber非必须

获取单个地址

基本信息

Path: /api/address/detail/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 地址编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ uidnumber非必须
├─ real_namestring非必须
├─ phonestring非必须
├─ provincestring非必须
├─ citystring非必须
├─ city_idnumber非必须
├─ districtstring非必须
├─ detailstring非必须
├─ post_codenumber非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ is_defaultnumber非必须

获取默认地址

基本信息

Path: /api/address/default

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须
├─ real_namestring非必须
├─ phonestring非必须
├─ provincestring非必须
├─ citystring非必须
├─ districtstring非必须
├─ detailstring非必须
├─ is_defaultnumber非必须

设置默认地址

基本信息

Path: /api/address/default/set

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须地址编号

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

获取城市数据

基本信息

Path: /api/city_list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ vnumber必须
├─ nstring必须
├─ cobject []必须

item 类型: object

├─ vnumber必须
├─ nstring必须
├─ cobject []必须

item 类型: object

├─ vnumber必须
├─ nstring必须
├─ cstring []必须

item 类型: string

├─ 非必须

个人中心->我的收藏

取消收藏产品

基本信息

Path: /api/collect/del

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须产品编号
categorystring非必须产品类型|product=普通产品,product_seckill=秒杀产品(默认普通产品)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

批量收藏

基本信息

Path: /api/collect/all

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idstring []必须产品编号

item 类型: string

├─ 非必须
categorystring必须产品类型|product=普通产品,product_seckill=秒杀产品

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

收藏列表

基本信息

Path: /api/collect/user

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页参数起始值
limit 是 20 分页数步长值

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ product_idnumber必须
├─ categorystring必须
├─ productobject必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ pidnumber必须
├─ store_namestring必须
├─ pricestring必须
├─ ot_pricestring必须
├─ salesnumber必须
├─ imagestring必须
├─ is_delnumber必须
├─ is_shownumber必须
├─ is_failboolean必须

添加收藏产品

基本信息

Path: /api/collect/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idinteger必须
categorystring非必须产品类型|product=普通产品,product_seckill=秒杀产品(默认 普通产品 product)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须

个人中心->消息中心

消息列表

基本信息

Path: /api/user/message_system/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ countnumber非必须

个人中心->我的余额

充值额度选择

基本信息

Path: /api/recharge/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ recharge_quotaobject []非必须

item 类型: object

├─ idnumber必须
├─ recharge_attentionstring []非必须

item 类型: string

├─ 非必须

公众号充值

基本信息

Path: /api/recharge/wechat

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pricenumber必须充值金额
fromstring必须支付方式|weixin=微信公众号,weixinh5=微信H5支付
typenumber必须0=充值,1=转入

枚举: 0,1

枚举备注: 0=充值,1=转入

rechar_idnumber必须组合数据id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ dataobject非必须支付参数
├─ appIdstring非必须appId
├─ nonceStrstring非必须随机字符串
├─ packagestring非必须统一下单接口返回的 prepay_id 参数值
├─ signTypestring非必须签名类型
├─ paySignstring非必须签名
├─ timestampstring非必须时间戳
├─ typestring非必须充值支付类型|weixin=微信公众号,weixinh5=公众号H5支付

小程序充值

基本信息

Path: /api/recharge/routine

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pricenumber必须充值金额

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ appIdstring非必须appId
├─ nonceStrstring非必须随机字符串
├─ packagestring非必须统一下单接口返回的 prepay_id 参数值
├─ signTypestring非必须签名类型
├─ paySignstring非必须签名
├─ timestampstring非必须时间戳

统一充值

基本信息

Path: /api/recharge/recharge

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ dataobject非必须
├─ appIdstring非必须
├─ nonceStrstring非必须
├─ packagestring非必须
├─ signTypestring非必须
├─ paySignstring非必须
├─ timestampstring非必须
├─ typestring非必须

活动状态

基本信息

Path: /api/user/activity

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
dataobject非必须
├─ is_barginboolean非必须砍价活动是否开启|true=开启,false=关闭
├─ is_pinkboolean非必须拼团活动是否开启|true=开启,false=关闭
├─ is_seckillboolean非必须秒杀活动是否开启|true=开启,false=关闭

PC端

PC获取收藏列表

基本信息

Path: /api/pc/get_collect_list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ2NC5jcm1lYi5teSIsImF1ZCI6InY0LmNybWViLm15IiwiaWF0IjoxNjAxMzQ1NTQ4LCJuYmYiOjE2MDEzNDU1NDgsImV4cCI6MTYwMTM1NjM0OCwianRpIjp7ImlkIjoxLCJ0eXBlIjoiYXBpIn19.sKP9BLM-qNtPx5t8l99nsbI7uOn2l_dbXLcqBmUh4Pg

Query

参数名称 是否必须 示例 备注
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ product_idnumber必须
├─ categorystring必须
├─ productobject必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ pidnumber必须
├─ store_namestring必须
├─ pricestring必须
├─ ot_pricestring必须
├─ salesnumber必须
├─ imagestring必须
├─ is_delnumber必须
├─ is_shownumber必须
├─ is_failboolean必须
├─ countnumber非必须

PC订单列表

基本信息

Path: /api/pc/get_order_list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ2NC5wYy5jcm1lYi5uZXQiLCJhdWQiOiJ2NC5wYy5jcm1lYi5uZXQiLCJpYXQiOjE2MDEyNzUxMDksIm5iZiI6MTYwMTI3NTEwOSwiZXhwIjoxNjAxMjg1OTA5LCJqdGkiOnsiaWQiOjY1LCJ0eXBlIjoiYXBpIn19.xeirj_pgdUR-hnL3CCPksqdU5KWzKsZYrJdgnyuR9jk

Query

参数名称 是否必须 示例 备注
type 是 1 类型
page 是 1
limit 是 20

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ order_idstring必须
├─ trade_nostring必须
├─ uidnumber必须
├─ real_namestring必须
├─ user_phonestring必须
├─ user_addressstring必须
├─ cart_idstring []必须

item 类型: string

├─ 非必须
├─ freight_pricestring必须
├─ total_numnumber必须
├─ total_pricestring必须
├─ total_postagestring必须
├─ pay_pricestring必须
├─ pay_postagestring必须
├─ deduction_pricestring必须
├─ coupon_idnumber必须
├─ coupon_pricestring必须
├─ paidnumber必须
├─ pay_timenumber,null必须
├─ pay_typestring必须
├─ add_timenumber必须
├─ statusnumber必须
├─ refund_statusnumber必须
├─ refund_reason_wap_imgnull,string必须
├─ refund_reason_wap_explainnull,string必须
├─ refund_reason_timenull,number必须
├─ refund_reason_wapnull,string必须
├─ refund_reasonnull必须
├─ refund_pricestring必须
├─ delivery_namestring,null必须
├─ delivery_codestring必须
├─ delivery_typestring,null必须
├─ delivery_idstring,null必须
├─ fictitious_contentstring必须
├─ delivery_uidnumber必须
├─ gain_integralstring必须
├─ use_integralstring必须
├─ back_integralnull必须
├─ markstring必须
├─ is_delnumber必须
├─ uniquestring必须
├─ remarkstring,null必须
├─ mer_idnumber必须
├─ is_mer_checknumber必须
├─ combination_idnumber必须
├─ pink_idnumber必须
├─ coststring必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ verify_codestring必须
├─ store_idnumber必须
├─ shipping_typenumber必须
├─ clerk_idnumber必须
├─ is_channelnumber必须
├─ is_remindnumber必须
├─ is_system_delnumber必须
├─ channel_typestring必须
├─ provincestring必须
├─ express_dumpstring必须
├─ nicknamestring必须
├─ phonestring必须
├─ spread_uidnumber必须
├─ spread_nicknamestring必须
├─ cartInfoobject []必须

item 类型: object

├─ idnumber,string必须
├─ uidnumber必须
├─ typestring必须
├─ product_idnumber必须
├─ product_attr_uniquestring必须
├─ cart_numnumber必须
├─ add_timenumber,string必须
├─ is_paynumber必须
├─ is_delnumber必须
├─ is_newnumber必须
├─ combination_idnumber必须
├─ seckill_idnumber必须
├─ bargain_idnumber必须
├─ statusnumber必须
├─ productInfoobject必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ attrStatusboolean必须
├─ costPricestring必须
├─ trueStocknumber必须
├─ truePricestring必须
├─ vip_truePricenumber必须
├─ integral_pricenumber必须
├─ uniquestring必须
├─ is_replynumber必须
├─ _statusobject必须
├─ _typenumber非必须
├─ _titlestring非必须
├─ _msgstring非必须
├─ _classstring非必须
├─ _payTypestring非必须
├─ _deliveryTypestring非必须
├─ _pay_timestring必须
├─ _add_timestring必须
├─ stop_timenumber必须
├─ status_picstring必须
├─ offlinePayStatusnumber必须
├─ order_logobject必须
├─ createstring非必须
├─ paystring非必须
├─ deliverystring非必须
├─ takestring非必须
├─ completestring非必须
├─ countnumber非必须

PC购物车

基本信息

Path: /api/pc/get_cart_list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ2NC5jcm1lYi5teSIsImF1ZCI6InY0LmNybWViLm15IiwiaWF0IjoxNjAwNzY2OTY2LCJuYmYiOjE2MDA3NjY5NjYsImV4cCI6MTYwMDc3Nzc2NiwianRpIjp7ImlkIjoxLCJ0eXBlIjoiYXBpIn19.0hWCvZnq8Ytk1QuNiicOipF0ickyD7si_dYjSaop4v4

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ validobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须
├─ invalidobject []非必须

item 类型: object

├─ idnumber非必须
├─ uidnumber非必须
├─ typestring非必须
├─ product_idnumber非必须
├─ product_attr_uniquestring非必须
├─ cart_numnumber非必须
├─ add_timenumber非必须
├─ is_paynumber非必须
├─ is_delnumber非必须
├─ is_newnumber非必须
├─ combination_idnumber非必须
├─ seckill_idnumber非必须
├─ bargain_idnumber非必须
├─ statusnumber非必须
├─ productInfoobject非必须
├─ idnumber非必须
├─ mer_idnumber非必须
├─ imagestring非必须
├─ recommend_imagestring非必须
├─ slider_imagestring []非必须

item 类型: string

├─ 非必须
├─ store_namestring非必须
├─ store_infostring非必须
├─ keywordstring非必须
├─ bar_codestring非必须
├─ cate_idstring非必须
├─ pricestring非必须
├─ vip_pricestring非必须
├─ ot_pricestring非必须
├─ postagestring非必须
├─ unit_namestring非必须
├─ sortnumber非必须
├─ salesnumber非必须
├─ stocknumber非必须
├─ is_shownumber非必须
├─ is_hotnumber非必须
├─ is_benefitnumber非必须
├─ is_bestnumber非必须
├─ is_newnumber非必须
├─ add_timenumber非必须
├─ is_postagenumber非必须
├─ is_delnumber非必须
├─ mer_usenumber非必须
├─ give_integralstring非必须
├─ coststring非必须
├─ is_seckillnumber非必须
├─ is_bargainnull非必须
├─ is_goodnumber非必须
├─ is_subnumber非必须
├─ is_vipnumber非必须
├─ fictinumber非必须
├─ browsenumber非必须
├─ code_pathstring非必须
├─ soure_linkstring非必须
├─ video_linkstring非必须
├─ temp_idnumber非必须
├─ spec_typenumber非必须
├─ activitystring非必须
├─ spustring非必须
├─ label_idstring非必须
├─ command_wordstring非必须
├─ attrInfoobject非必须
├─ product_idnumber非必须
├─ sukstring非必须
├─ stocknumber非必须
├─ salesnumber非必须
├─ pricestring非必须
├─ imagestring非必须
├─ uniquestring非必须
├─ coststring非必须
├─ bar_codestring非必须
├─ ot_pricestring非必须
├─ vip_pricestring非必须
├─ weightstring非必须
├─ volumestring非必须
├─ brokeragestring非必须
├─ brokerage_twostring非必须
├─ typenumber非必须
├─ quotanumber非必须
├─ quota_shownumber非必须
├─ costPricestring非必须
├─ trueStocknumber非必须
├─ truePricestring非必须
├─ vip_truePricenumber非必须

余额记录

基本信息

Path: /api/pc/get_balance_record/:type

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
type 0 0全部,1支出,2收入

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ uidnumber必须
├─ link_idstring必须
├─ pmnumber必须
├─ titlestring必须
├─ categorystring必须
├─ typestring必须
├─ numberstring必须
├─ balancestring必须
├─ markstring必须
├─ add_timestring必须
├─ statusnumber必须
├─ takenumber必须
├─ timestring必须
├─ countnumber非必须

商品列表

基本信息

Path: /api/pc/get_products

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
sid 是 二级分类
cid 是 一级分类
keyword 是 搜索
priceOrder 是 金额排序
salesOrder 是 销量排序
page 是
limit 是
news 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须总条数
├─ listobject []非必须

item 类型: object

├─ idnumber非必须商品ID
├─ store_namestring非必须商品名称
├─ cate_idstring非必须分类ID
├─ imagestring非必须主图
├─ salesstring非必须销量
├─ pricestring非必须售价
├─ stocknumber非必须库存
├─ activitystring []非必须活动

item 类型: string

├─ 非必须
├─ ot_pricestring非必须原价
├─ spec_typenumber非必须1多规格,0单规格
├─ recommend_imagestring非必须推荐图
├─ unit_namestring非必须单位
├─ descriptionstring非必须详情
├─ checkCouponboolean非必须是否有优惠券

商品详情小程序码

基本信息

Path: /api/pc/get_product_code/:product_id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
product_id 1 商品ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ routineCodestring非必须小程序码地址

城市数据

基本信息

Path: /api/pc/get_city/:pid

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
pid 0 父级ID

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ city_idnumber必须城市ID
├─ namestring必须城市名称

微信关注二维码

基本信息

Path: /api/pc/get_wechat_qrcode

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ wechat_qrcodestring非必须

扫码授权

基本信息

Path: /api/pc/wechat_auth

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须登录认证token
├─ exp_timestring非必须过期时间

扫码支付轮询接口

基本信息

Path: /api/pc/check_order_status/:order_id/:end_time

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
order_id 订单ID
end_time 到期时间戳

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusboolean非必须
├─ timenumber非必须

扫码登录key

基本信息

Path: /api/pc/key

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ keystring非必须
├─ timestring非必须

推荐商品列表

基本信息

Path: /api/pc/get_recommend/:type

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authori-zation 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ2NC5wYy5jcm1lYi5uZXQiLCJhdWQiOiJ2NC5wYy5jcm1lYi5uZXQiLCJpYXQiOjE2MDEyNzUxMDksIm5iZiI6MTYwMTI3NTEwOSwiZXhwIjoxNjAxMjg1OTA5LCJqdGkiOnsiaWQiOjY1LCJ0eXBlIjoiYXBpIn19.xeirj_pgdUR-hnL3CCPksqdU5KWzKsZYrJdgnyuR9jk

路径参数

参数名称 示例 备注
type 1

Query

参数名称 是否必须 示例 备注
page 是
limit 是

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须列表

item 类型: object

├─ idnumber必须ID
├─ imagestring必须图片
├─ store_namestring必须名称
├─ store_infostring必须简介
├─ cate_idstring必须分类ID
├─ pricestring必须价格
├─ ot_pricestring必须原价
├─ salesstring必须销量
├─ unit_namestring必须单位
├─ sortnumber必须排序
├─ activitystring []必须活动

item 类型: string

├─ 非必须
├─ stocknumber必须库存
├─ starstring必须评分
├─ checkCouponboolean必须有无优惠券
├─ countnumber非必须总数

检测扫码情况

基本信息

Path: /api/pc/scan/:key

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
key

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ statusnumber非必须

获取付费会员购买页面二维码

基本信息

Path: /api/pc/get_pay_vip_code

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ urlstring非必须地址

获取优品推荐

基本信息

Path: /api/pc/get_good_product

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须列表

item 类型: object

├─ idnumber必须ID
├─ imagestring必须图片
├─ store_namestring必须名称
├─ store_infostring必须简介
├─ cate_idstring必须分类ID
├─ pricestring必须价格
├─ ot_pricestring必须原价
├─ salesstring必须销量
├─ unit_namestring必须单位
├─ sortnumber必须排序
├─ activitystring []必须活动

item 类型: string

├─ 非必须
├─ stocknumber必须库存
├─ starstring必须评分
├─ checkCouponboolean必须有无优惠券

获取公司信息

基本信息

Path: /api/pc/get_company_info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ contact_numberstring非必须
├─ company_addressstring非必须
├─ copyrightstring非必须
├─ record_Nostring非必须
├─ site_namestring非必须
├─ site_keywordsstring非必须
├─ site_descriptionstring非必须
├─ logoUrlstring非必须

获取微信开放平台appid

基本信息

Path: /api/pc/get_appid

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ appidstring非必须
├─ versionstring非必须

获取跳转手机端购买二维码

基本信息

Path: /api/pc/get_product_phone_buy

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ phone_buystring非必须手机跳转地址
├─ sit_urlstring非必须网站根域名

首页分类商品

基本信息

Path: /api/pc/get_category_product

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页
limit 是 3 每次三个分类

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ pidnumber必须
├─ cate_namestring必须
├─ sortnumber必须
├─ picstring必须
├─ is_shownumber必须
├─ add_timestring必须
├─ big_picstring必须
├─ productListobject []必须

item 类型: object

├─ idnumber必须
├─ store_namestring必须
├─ imagestring必须
├─ salesstring必须
├─ pricestring必须
├─ ot_pricestring必须
├─ descriptionstring必须
├─ couponIdobject []必须

item 类型: object

├─ idnumber必须
├─ product_idnumber必须
├─ issue_coupon_idnumber必须
├─ add_timenumber必须
├─ titlestring必须
├─ starstring必须
├─ countnumber非必须

首页轮播

基本信息

Path: /api/pc/get_banner

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ titlestring非必须
├─ imagestring非必须
├─ urlstring非必须

Build by YMFE.