Deprecated: Creation of dynamic property itxq\apidoc\BootstrapApiDoc::$webname is deprecated in /www/wwwroot/apply.buyql.com/Star/Tool/Apidoc/itxq/api-doc-php/src/BootstrapApiDoc.php on line 94
xqlAPI文档 By Api-Doc-PHP

广告数据

API - 广告数据_汇总

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Ad_data/summary

返回参数

参数类型描述
data.name string 模块名称
data.act_name string 活动名称
data.total string 累计广告数据
data.pending string 待领取
data.claimed string 已领取
data.void string 已作废
data.types array 按来源类型汇总(type/name/total/pending/claimed/count)
data.claim_filters array 明细可用状态筛选项

状态码说明

状态码描述
0 成功

API - 广告数据_明细列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Ad_data/detail

请求参数

参数类型描述默认值是否必须
claim_status number 领取状态 0待领取 1已领取
type number 来源类型 1买套餐注册 2直推
page number 页码 1 必须
limit number 每页条数 20 必须

返回参数

参数类型描述
data.list array 明细(id/type/type_name/amount/claim_status/claim_status_name/seq_no/src_phone/remark/created_at/claimed_at)
data.count int 总条数

状态码说明

状态码描述
0 成功

代理

API - 城市服务_详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent/region_agent_service_data

请求参数

参数类型描述默认值是否必须
token string token 无 必须
address_id int 地址id 空 必须
strategy_type int 策略类型:0-区策略,1-品牌策略 空 可选(默认0:也支持不传strategy_type但传brand_id则自动推断为1)
brand_id int 品牌id 空 可选(当strategy_type=1时建议必传)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 城市服务详情及档位/席位列表

状态码说明

状态码描述
0 成功
其他 失败

API - 代理订单是否已生成

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent/agent_permission

请求参数

参数类型描述默认值是否必须
token string 令牌 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 订单让利_按品牌地区日汇总执行

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent/order_brand_rl_stat_run

请求参数

参数类型描述默认值是否必须
token string 令牌 无 必须
confirm string 固定传run 无 必须
start_date string 起始日Y-m-d(含当日00:00起) 无 非必须,默认昨日;
end_date string 结束日Y-m-d(含当日23:59:59) 无 非必须,默认到当前时刻
exec_secret string 与env配置order_brand_rl_stat_secret一致时允许执行 无 非必须(建议仅内网/运维配置)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data.stats array 含

状态码说明

状态码描述
0 成功
其他 失败

API - 订单让利_汇总池列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent/order_brand_rl_pool_list

请求参数

参数类型描述默认值是否必须
token string 令牌 无 必须
page int 页数 无 必须
limit int 条数 无 必须(最大100)
fh_status int 0待分润1已分润 无 非必须
brand_id int 品牌id 无 非必须
address_id int 地区id 无 非必须
address_level int 0省1市2区县3街镇 无 非必须
stat_date string 业务日 Y-m-d 无

返回参数

参数类型描述
data array 汇总池列表

状态码说明

状态码描述
0 成功

代理AI云店额度

API - 代理AI云店额度_额度汇总

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent_cloud/quota

返回参数

参数类型描述
data.name string 模块名称
data.is_agent int 是否有额度席位
data.total_quota int 总额度(各席位合计)
data.used_quota int 已绑定
data.remain_quota int 剩余额度
data.seat_count int 席位数
data.seats array 席位列表(quota_id/agent_order_id/range/range_name/region_address/total_quota/used_quota/remain_quota/enabled)

状态码说明

状态码描述
0 成功

API - 代理AI云店额度_绑定明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Agent_cloud/bind_list

请求参数

参数类型描述默认值是否必须
agent_order_id number 只看某个席位,不传看全部 空 可选
page number 页码 1 必须
limit number 每页条数 20 必须

返回参数

参数类型描述
data.list array 明细(id/agent_order_id/range/range_name/buyer_uid/buyer_phone/shop_name/cloud_level/cloud_zt/cloud_end_time/cloud_expired/created_at)
data.count int 总条数

状态码说明

状态码描述
0 成功

卡包

API - 卡列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/cardlist

请求参数

参数类型描述默认值是否必须
id string 卡id 空 必须
type string 卡片定义 id,与 cardtype
catalog_id string 卡片定义 id,与 type
limit string 每页条数 空 必须
page string 页数 空 必须
zt string 状态0未激活1正常2过期、失效 空 必须
company_id int 公司id hxd_company.id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡类型

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/cardtype

请求参数

参数类型描述默认值是否必须
company_id int 公司id hxd_company.id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡对应类型的数量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/cardtypenum

请求参数

参数类型描述默认值是否必须
company_id int 公司id hxd_company.id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡领取

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/cardget

请求参数

参数类型描述默认值是否必须
id string 卡号 空 必须
ids string 多个卡号,英文逗号分隔,与 id 二选一;单次最多50张

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡签到_type1_状态

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/sign_state

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡签到_type1

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/sign_do

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 卡签到_type1_记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Card/sign_log

请求参数

参数类型描述默认值是否必须
page int 页数 空 必须
limit int 条数 空 必须
cid int 卡id 空 非必须
time_start int 时间开始(秒) 空 非必须
time_end int 时间结束(秒) 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

云店

API - 云店激活码激活

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloudkey

请求参数

参数类型描述默认值是否必须
token string token 空 必须
key string 激活码 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 云店激活码(本人直接生成,无需被赠送)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_code

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data.no string 激活码
data.card_id int 卡id

状态码说明

状态码描述
0 成功
其他 失败

API - 云店产品列表(不包含过期产品)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_goods

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page string 页数20条固定 空 必须

返回参数

参数类型描述
每项含 array cloud_goods
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 云店过期产品产品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_goods_invalid

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 添加产品

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_add_goods

请求参数

参数类型描述默认值是否必须
token string token 空 必须
rl string 让利5-30,或前端滑条合计%(让利+消费金,最高33) 空 必须
sell_price number 单规格兼容:统一售价;多规格请用 sell_prices 空
sell_prices string 按规格提价 JSON,如 {"规格id":"99.00"}
gid string 产品id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 修改产品

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_update_goods

请求参数

参数类型描述默认值是否必须
token string token 空 必须
rl string 让利5-30,或前端滑条合计%(让利+消费金,最高33) 空 必须
sell_price number 单规格兼容售价;传了才改 空 非必须
sell_prices string 按规格提价 JSON;传了才改,传 {}
id string 数据id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 删除产品

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/cloud_del_goods

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id string 数据id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 云店店铺资质_查询(店主)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/qualification_get

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data object 合并后的展示字段(同
data.manual object 店主补填原文(含

状态码说明

状态码描述
0 成功
100 店铺未注册

API - 云店店铺资质_保存(店主补填)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud/qualification_save

请求参数

参数类型描述默认值是否必须
token string token 空 必须
company_name string 公司名称 空 非必须
contact_name string 联系人 空 非必须
phone string 联系电话 空 非必须
email string 邮箱 空 非必须
address string 地址 空 非必须
license_no string 营业执照号 空 非必须
license_pic string 营业执照图片路径(上传接口返回的相对路径)空 非必须

返回参数

参数类型描述
data object 同

状态码说明

状态码描述
0 成功
100 校验失败/店铺未注册

线上交易

API - 获取运费(预下单/报错此规格就无法下单)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/freightorder

请求参数

参数类型描述默认值是否必须
gid number 产品规格的id 空 必须
num number 购买数量 空 必须
address_id number 收货地址id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 下订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/addorder

请求参数

参数类型描述默认值是否必须
id number 供应链产品id 空 必须
gid number 供应链规格id(sid) 空 必须
hxd_id number 本地套壳产品id(goods_list.id) 空 非必须
hxd_gid number 本地套壳规格id(goods_size.id) 空 非必须
num number 购买数量 空 必须
cloud_id number 云店id非必传 空 非必须
address_id number 收货地址id 空 必须
msg string 备注 空 必须
use_ac int 是否参与活动 1参与0不参与 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 订单支付最大使用金额计算

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/orderfun

请求参数

参数类型描述默认值是否必须
id number 订单id 空 必须(type=1

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
pay_meta object 支付元信息;套餐一/四含

状态码说明

状态码描述
0 成功
其他 失败

API - 支付订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/palayorder

请求参数

参数类型描述默认值是否必须
id number 订单id 空 必须
price number 现金支付金额(同 xj;优先按 price
ye number 余额支付金额 0 非必须
dkq number 抵扣券支付金额 0 非必须
yhq number 消费金支付金额 0 非必须
xfq number 消费券支付金额 0 非必须
dkqdh number 抵扣券[兑换]支付金额 0 非必须
tmq number 特卖券支付金额 0 非必须
thq number 特惠券支付金额 0 非必须
jtb_card_no string 汇享店兑换卡号(套餐一必填,仅卡兑换)0 非必须
ai_cloud_card_no string AI云店兑换卡号(套餐四必填,仅卡兑换)0 非必须
q1_FrpCode string 汇聚支付通道(仅现金部分>0时必填);云闪付 UNIONPAY_*;支付宝服务窗 ALIPAY_FWC
p8_ReturnUrl string 汇聚同步跳转地址(可选);云闪付仅 UNIONPAY_H5/UNIONPAY_WXMP 支持
qj_DJPlan string 汇聚点金计划JSON(可选)
wx_code string 微信授权code(可选,后端可换取openid)
q5_OpenId string 微信openid(可选)
q7_AppId string 微信/支付宝 appid(可选)
alipay_code string 支付宝服务窗授权 code(ALIPAY_FWC 时换
qb_buyerId string 支付宝买家 user_id(可选)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 申请退款、取消退款申请

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/refundorder

请求参数

参数类型描述默认值是否必须
id number 订单id 空 必须
state number 类型值为afr申请退款为nafr取消申请 0 非必须
msg number 退款原因 申请退款时必填 0

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 确认收货

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/receiptorder

请求参数

参数类型描述默认值是否必须
id number 订单id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 添加收藏

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/collectadd

请求参数

参数类型描述默认值是否必须
token string token 空 必须
type string 类型shop-店铺、goods-产品 无 必须
id string 店铺、产品id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 删除收藏

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/collectdel

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id string 数据id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 收藏列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Cloud_goods/collectlist

请求参数

参数类型描述默认值是否必须
name string 名称搜索 无 非必须
type string 类型 无 非必须
sid string 收藏产品、店id 无 非必须
page string 页数20条固定 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

幸运店主(C端)

API - 幸运店主_首页顶卡

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/home

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.enabled int 模块总开关
data.can_join int 当前用户是否可参与
data.cloud_level int 云店等级
data.cycle object|null 当前周期;无进行中为
data.cycle.id int 周期
data.cycle.start_at string 开始时间
data.cycle.end_at string 结束时间
data.cycle.status int 1进行中2已结束
data.remain_days int 本期剩余整天数
data.remain_seconds int 本期剩余秒数(前端可自行倒计时)
data.remain_hms string 剩余时分秒,如
data.remain_text string 展示文案,如「3天
data.period_text string 周期区间文案,如「07.07
data.week_amount string 本期累计幸运积分(展示值=库内×doubei)
data.today_amount string 今日新增幸运积分(展示值=库内×doubei)

状态码说明

状态码描述
0 成功
其他 失败

API - 幸运店主_档位状态

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/tier

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.cloud_level int 云店等级
data.direct_owner_count int 直推店主数
data.current_tier int 当前自动档位:1过渡消费
data.current_tier_name string 当前档位名称,如「店主数据」
data.unlocked_tiers array 已解锁档位号列表
data.tier4_unlock int 广告档是否解锁
data.next_tier int 下一档位号,0表示已最高
data.next_tier_name string 下一档位名称
data.next_need int 距下一档还差直推店铺数
data.progress_text string 进度文案,如「直推店铺
data.tiers array 全部启用档位(含解锁状态,用于四宫格)
data.tiers[].tier int 档位号
data.tiers[].name string 名称
data.tiers[].unlocked int 1已解锁0未解锁
data.tiers[].locked int 1锁定0未锁
data.tiers[].label string 已解锁/未解锁

状态码说明

状态码描述
0 成功
其他 失败

API - 幸运店主_我的7家店铺

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/my_group

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.list array 匹配成员列表(最多7)
data.list[].uid int 匹配对象用户
data.list[].slot int 位次
data.list[].nickname string 原始展示名
data.list[].display_name string 脱敏名,如「张·明」
data.list[].shop_id int 店铺
data.list[].img string 头像
data.list[].cloud_level int 云店等级
data.list[].is_owner int 是否店主
data.list[].active_7d int 近7日是否有订单行为
data.total int 匹配店铺总数
data.active_7d_count int 近7日有行为店铺数
data.tip string 摘要文案,如「7家店铺中,近7日有

状态码说明

状态码描述
0 成功
其他 失败

API - 幸运店主_谁匹配了我

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/matched_me

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.list array 受益店铺列表(最多7)
data.list[].uid int 受益店铺用户
data.list[].nickname string 原始展示名
data.list[].display_name string 脱敏名
data.list[].img string 头像
data.list[].cloud_level int 云店等级
data.total int 匹配我的店铺数
data.tip string 固定提示「最多7家店铺匹配你」

状态码说明

状态码描述
0 成功
其他 失败

API - 幸运店主_奖励明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/reward_list

请求参数

参数类型描述默认值是否必须
page int 页码 1 非必须
limit int 每页条数(最大50) 20 非必须
cycle_id int 周期 id,0 表示全部

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 奖励流水列表(按
data[].id int 流水
data[].cycle_id int 周期
data[].matched_uid int 行为源
data[].tier int 档位
data[].tier_name string 档位名称
data[].base_type string 基数类型
data[].base_amount string 奖励基数
data[].rate string 单个店铺比例
data[].amount string 发放积分
data[].order_id int 关联订单
data[].created_at string 发放时间
count int 总条数

状态码说明

状态码描述
0 成功
其他 失败

API - 幸运店主_全网动态

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Lucky/feed

请求参数

参数类型描述默认值是否必须
page int 页码 1 非必须
limit int 每页条数(最大100) 50 非必须;首页预览可传

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 动态列表(按
data[].id int 动态
data[].display_name string 展示名(已按脱敏策略处理)
data[].tier int 档位
data[].tier_name string 档位名称,如「店主数据」
data[].amount string 奖励积分
data[].created_at string 时间
data[].time_ago string 相对时间,如「刚刚」「1分钟前」
stats object 本周期统计
stats.week_users int 本周期获得奖励的店铺数(去重)
stats.week_amount string 本周期累计发放积分

状态码说明

状态码描述
0 成功
其他 失败

模式Ⅰ

API - 赠送记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/zzlist

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 无 非必须
limit int 每页条数 无 必须
zhi int 类型-1出1入 无 必须
type int 类型筛选 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 赠送消费券(弹窗显示金额对方信息二次确认)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/hz

请求参数

参数类型描述默认值是否必须
token string token 空 必须
num number 数量 无 必须
phone number 对方人手机号(下级、东家) 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 赠送余额(弹窗显示金额对方信息二次确认)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/hz1

请求参数

参数类型描述默认值是否必须
token string token 空 必须
num number 数量 无 必须
phone number 对方注册手机号任意用户 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 余额充值记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/palaylist

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 无 必须
limit int 每页条数 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 提交凭证充值余额

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/palay_img

请求参数

参数类型描述默认值是否必须
token string token 空 必须
img string 图片url 无 必须
num number 金额数量 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 获取全等级信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/usermsglevel

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 获取普通用户全部信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/userlevel

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 获取东家数统计

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/userlevel3

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 领取记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/setlist

请求参数

参数类型描述默认值是否必须
type int 1特卖区2特惠区 无 必须
page int 页数 无 必须
limit int 每页条数 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 东家数据看板(下级、订单、资金流水、卡、消费券转入等汇总)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/dongjia_dashboard

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data array 统计项见返回结构

状态码说明

状态码描述
0 成功
100 非东家或无云店

API - 推荐沉淀奖金可领列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/referral_deposit_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 待领记录列表(id/msg/price/time/oid)
count int 条数(与
total_price string 待领金额合计(与
can_claim bool 是否可领取(店小二及以上,与

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 推荐沉淀奖金领取

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/referral_deposit_claim

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id int 单条 model_log.id 0

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 成功时含

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 云店状态(套餐三购买前

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/cloud_shop_status

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data.cloud_level int 云店等级:0普通
data.shop object 云店详情(含

状态码说明

状态码描述
0 成功

API - 法大大协议签约状态(总店长买后提示

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/fdd_sign_status

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功

API - 发起法大大协议签约(返回签署链接)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/fdd_sign_start

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功

API - 汇享店兑换卡待赠送列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/jtb_card_pool

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data array 本人

状态码说明

状态码描述
0 成功

API - 汇享店兑换卡赠送/转赠(支持批量)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/jtb_card_gift

请求参数

参数类型描述默认值是否必须
token string token 空 必须
phone string 接收人手机号 空 必须
no string 单张卡号(与 nos/num 三选一)空
nos string 多张卡号:逗号分隔或 JSON 数组,最多50
num int 按数量从可赠池自动抽取,最多50 空 非必须

返回参数

参数类型描述
data.count int 成功张数
data.card_ids array 卡
data.nos array 实际赠出卡号
data.card_id int 首张卡

状态码说明

状态码描述
0 成功

API - 汇享店兑换卡激活

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/jtb_card_activate

请求参数

参数类型描述默认值是否必须
token string token 空 必须
no string 卡号 无 必须(待赠送池

状态码说明

状态码描述
0 成功

API - 汇享店兑换卡未激活列表(本人名下)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/jtb_card_inactive

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data array uid=本人且

状态码说明

状态码描述
0 成功

API - 汇享店兑换卡赠送记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/jtb_card_gift_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 空 必须
limit int 每页条数(最大100) 空 必须

返回参数

参数类型描述
data array 本人

状态码说明

状态码描述
0 成功

API - AI云店兑换卡待赠送列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_pool

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data array 本人

状态码说明

状态码描述
0 成功

API - AI云店兑换卡赠送/转赠(支持批量)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_gift

请求参数

参数类型描述默认值是否必须
token string token 空 必须
phone string 接收人手机号 空 必须
no string 单张卡号(与 nos/num 三选一)空
nos string 多张卡号:逗号分隔或 JSON 数组,最多50
num int 按数量从可赠池自动抽取,最多50 空 非必须

返回参数

参数类型描述
data.count int 成功张数
data.card_ids array 卡
data.nos array 实际赠出卡号
data.card_id int 首张卡

状态码说明

状态码描述
0 成功

API - AI云店激活码_我的列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_redeem_code_mine

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 空 非必须
limit int 每页条数 空 非必须
zt int 0未使用1已使用2作废;不传则过滤已作废 空 非必须

状态码说明

状态码描述
0 成功

API - AI云店激活码_赠送未使用码(支持批量)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_redeem_code_gift

请求参数

参数类型描述默认值是否必须
token string token 空 必须
phone string 接收人手机号 空 必须
code string 单个激活码(与 codes/num 三选一)空
codes string 多个激活码,逗号分隔或 JSON 数组,最多50
num int 按数量从本人未使用码自动抽取,最多50 空 非必须

返回参数

参数类型描述
data.count int 成功个数
data.to_uid int 接收人
data.codes array 实际赠出激活码

状态码说明

状态码描述
0 成功

API - AI云店兑换卡激活

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_activate_by_code

请求参数

参数类型描述默认值是否必须
token string token 空 必须
no string 卡号 无 必须
code string 一次性激活码 无 非必须(未传
direct string 本平台直接激活 空 非必须。传

状态码说明

状态码描述
0 成功

API - AI云店兑换卡未激活列表(本人名下)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_inactive

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
data array uid=本人且

状态码说明

状态码描述
0 成功

API - AI云店兑换卡已激活列表(本人名下)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_active

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功

API - AI云店兑换卡赠送记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/ai_cloud_card_gift_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 空 必须
limit int 每页条数(最大100) 空 必须

返回参数

参数类型描述
data array 本人

状态码说明

状态码描述
0 成功

API - 归属店铺会员列表(总店长:已报单+未报单)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/bind_shop_member_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页数 空 必须
limit int 每页条数(最大100) 空 必须

返回参数

参数类型描述
data.list array 会员列表;bind_status:
count int 列表分页总条数(同
member_total int 会员数总计(已报单+未报单)
summary object member_total/bound_count/unreported_count/zone_order_count/zone_order_amount

状态码说明

状态码描述
0 成功

API - 赠送合伙人席位列表与进度

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Model_Shop/partner_gift_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须
claim_status int 领取状态筛选:0待领取 1已领取 2已作废;不传为全部

状态码说明

状态码描述
0 成功

订单

API - 订单(所有数据)列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/orderlist

请求参数

参数类型描述默认值是否必须
id number 订单id 空 非必须
page number 页数条数固定20 0 必须
state number 状态0-待支付1-已支付2-已完成3-已退款-1订单取消4-待收货、不传全部订单 0 非必须
type number 类型1-线下普通订单2-线下即使零售订单3-线上普通订单4-线上模式订单、不传全部订单 0 非必须
name string 订单搜索云店名、产品名 0 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data[].gift_jf string 本单赠送购买者的积分(已发放取实发,未发放按规则预估;取消/退款且未发放为

状态码说明

状态码描述
0 成功
其他 失败

API - 订单各个状态数量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/ordernum

请求参数

参数类型描述默认值是否必须
id number 订单id 空 非必须
page number 页数条数固定20 0 必须
type number 类型1-线下普通订单2-线下即使零售订单3-线上普通订单4-线上模式订单、不传全部订单 0 非必须
name string 订单搜索云店名、产品名 0 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 店铺订单(所有数据)列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/cloudorderlist

请求参数

参数类型描述默认值是否必须
id number 订单id 空 非必须
page number 页数条数固定20 0 必须
state number 状态0-待支付1-已支付2-已完成3-已退款-1订单取消4-待收货、不传全部订单 0 非必须
type number 类型1-线下普通订单2-线下即使零售订单3-线上普通订单4-线上模式订单、不传全部订单 0 非必须
name string 订单搜索云店名、产品名 0 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 线下订单完成(发放让利/成长积分

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/shopOfflineOrderComplete

请求参数

参数类型描述默认值是否必须
id number 订单 id 无

状态码说明

状态码描述
0 成功
其他 失败

API - 店铺订单各个状态数量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/shopordernum

请求参数

参数类型描述默认值是否必须
id number 订单id 空 非必须
page number 页数条数固定20 0 必须
type number 类型1-线下普通订单2-线下即使零售订单3-线上普通订单4-线上模式订单、不传全部订单 0 非必须
name string 订单搜索云店名、产品名 0 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 查询物流

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order/logisticsmsg

请求参数

参数类型描述默认值是否必须
gid number 供应链子订单 id(orderlist.supplyorder[0].id,非本地 order.id)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 物流节点(最新在前;末条可为收货地址)
data.has_track bool 是否有物流轨迹

状态码说明

状态码描述
0 成功
其他 失败

特殊订单(来一票预付)

API - 生成订单(来一票预付)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/addorder

请求参数

参数类型描述默认值是否必须
lyp_biz string 来一票业务标识短名:av_send、av_card、brand、dryclean、hotel、taxi、movie、ticket、tourism_travel、tourism_product、train;或完整:lyp_av_send、lyp_av_card、lyp_brand、lyp_dryclean、lyp_hotel、lyp_taxi、lyp_movie、lyp_ticket、lyp_tourism_travel、lyp_tourism_product、lyp_train 空 必须
lyp_payload string 业务请求体JSON字符串或数组(字段同对应各业务下单接口) 空 必须;lyp_biz=brand
price number 本平台订单金额 空 必须
price_supply number 成本金额 空 非必须(缺省同
name string 订单展示名称 空 非必须(缺省按业务生成)
lyp_env string 来一票环境 lyp_prod/lyp_test 空
brandKey string 大牌品牌 key 空
shop_id number 店铺 id 空
shop_uid number 店铺用户 id 空
margin_cap_pct number 让利计算用利润率上限 0~30 空
address string 四级地址 id 串如
product_info string 商品信息JSON字符串,写入order.product_info 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data number 本地订单

状态码说明

状态码描述
0 成功
其他 失败

API - 订单发货(已支付→待收货)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/deliveryorder

请求参数

参数类型描述默认值是否必须
id number 订单 id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 订单支付最大使用金额计算(来一票预付)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/orderfun

请求参数

参数类型描述默认值是否必须
id number 订单 id 空
deliveryPrice number 配送费 空 可选(外卖:按新旧配送费差额改写

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data mixed ModelOrder::jsprice

状态码说明

状态码描述
0 成功
其他 失败

API - 支付订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/palayorder

请求参数

参数类型描述默认值是否必须
id number 订单 id 空
price number 现金支付金额(同 xj;优先按 price
ye number 余额支付金额 0 非必须
dkq number 抵扣券支付金额 0 非必须
yhq number 消费金支付金额 0 非必须
xfq number 消费券支付金额 0 非必须
dkqdh number 抵扣券[兑换]支付金额 0 非必须
tmq number 特卖券支付金额 0 非必须
thq number 特惠券支付金额 0 非必须
q1_FrpCode string 汇聚支付通道(仅现金部分>0时必填);云闪付 UNIONPAY_*;支付宝服务窗 ALIPAY_FWC
p8_ReturnUrl string 汇聚同步跳转地址(可选);云闪付仅 UNIONPAY_H5/UNIONPAY_WXMP 支持
qj_DJPlan string 汇聚点金计划JSON(可选)
wx_code string 微信授权code(可选,后端可换取openid)
q5_OpenId string 微信openid(可选)
q7_AppId string 微信/支付宝 appid(可选)
alipay_code string 支付宝服务窗授权 code(ALIPAY_FWC 时换
qb_buyerId string 支付宝买家 user_id(可选)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/cancelorder

请求参数

参数类型描述默认值是否必须
id number 订单 id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 申请退款、取消退款申请(兼容入参)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/refundorder

请求参数

参数类型描述默认值是否必须
id number 订单 id 空
state string 类型 afr 申请退款
msg string 退款原因等说明 空 非必须(预留,与供应链退款接口对齐时可透传)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 打车先款后单:同步三方状态(orderFind)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/taxiOrderSync

请求参数

参数类型描述默认值是否必须
id number 本地订单id与 hxd_order_id 二选一)
hxd_order_id number 同id,兼容字段 空 非必须

返回参数

参数类型描述
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 确认收货

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Order_big/receiptorder

请求参数

参数类型描述默认值是否必须
id number 订单 id 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

广告(前端公共接口)

API - 广告_列表(按广告位筛选可展示广告)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ad/ad_list

请求参数

参数类型描述默认值是否必须
position string 广告位 popup/splash/banner/feed 空
platform string 客户端平台 ios/android/h5/wechat 空
device_id string 设备ID(匿名用户的频次控制key) 空 非必须
token string 用户token 空 非必须(自动也会读取HEADER的HXDTOKEN)
limit int 返回条数上限 空 非必须

状态码说明

状态码描述
0 成功

API - 广告_弹窗(拉取一条最高优先级弹窗广告)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ad/ad_popup

请求参数

参数类型描述默认值是否必须
position string 广告位 popup/splash 空
platform string 客户端平台 ios/android/h5/wechat 空
device_id string 设备ID 空 非必须
token string 用户token 空 非必须

状态码说明

状态码描述
0 成功

API - 广告_详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ad/ad_detail

请求参数

参数类型描述默认值是否必须
id int 广告ID 空 必须

状态码说明

状态码描述
0 成功

API - 广告_行为上报(曝光/点击/关闭/跳过/完整观看)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ad/ad_report

请求参数

参数类型描述默认值是否必须
id int 广告ID 空 必须
action string 行为 view/click/close/skip/complete 空
watch_seconds int 实际观看秒数 空 非必须
platform string 平台 ios/android/h5/wechat 空
device string 设备信息 空 非必须
device_id string 设备ID 空 非必须
extra string 附加信息JSON 空 非必须
token string 用户token 空 非必须

状态码说明

状态码描述
0 成功

AI工具与智能体

API - AI工具列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/list

请求参数

参数类型描述默认值是否必须
category string 分类筛选(可选):chat-对话,video-视频,image-绘画,audio-音频,writing-写作
keyword string 关键词搜索(可选)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array AI工具列表(按分类分组)

状态码说明

状态码描述
0 成功
其他 失败

API - AI工具分类列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/category_list

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 分类列表(包含每个分类下的工具数量)

状态码说明

状态码描述
0 成功
其他 失败

API - AI智能体_列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_list

返回参数

参数类型描述
data array 智能体列表

状态码说明

状态码描述
0 成功

API - AI智能体_创建会话

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/session_create

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
agent_id int 智能体 id 空
title string 会话标题 空 非必须

返回参数

参数类型描述
data.session_id int 会话

状态码说明

状态码描述
0 成功

API - AI智能体_会话列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/session_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
agent_id int 只看某个智能体;不传则返回当前用户全部智能体的会话 空 非必须
page int 页码;不传默认第1页(最新消息) 1 可选
limit int 每页条数(最大50) 20 可选

返回参数

参数类型描述
data array 会话列表

状态码说明

状态码描述
0 成功

API - AI智能体_会话详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/session_detail

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
session_id int 会话 id 空
page int 页码 1 可选
limit int 每页条数(最大100) 50 可选

返回参数

参数类型描述
data.session object 会话信息
data.messages array 消息列表(按
num int 消息总条数
page int 当前页
last_page int 最后一页
has_next bool 是否还有下一页(更早消息)
next_page int 下一页页码,无则为0
has_prev bool 是否有上一页(更新消息)
prev_page int 上一页页码,无则为0
limit int 每页条数

状态码说明

状态码描述
0 成功

API - AI智能体_删除会话

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/session_delete

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
session_id int 会话 id 空

状态码说明

状态码描述
0 成功

API - AI智能体_当前用户Token额度

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_token_quota

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

状态码说明

状态码描述
0 成功

API - AI智能体_发送消息(会话式,落库)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_chat

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
message string 用户消息 空 必须(可与
image_url string 单张图片 URL 空
image_urls string 多张图片 JSON 数组或逗号分隔
session_id int 会话 id 空
agent_id int 智能体 id 空
stream int 是否 SSE 长连接
async int 异步轮询 1/0 空

返回参数

参数类型描述
data.session_id int 会话
data.content string AI
data.usage object token
data.provider string 实际调用的第三方
data.model string 模型名

状态码说明

状态码描述
0 成功

API - AI智能体_异步轮询增量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_chat_poll

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
task_id string 异步任务 id(agent_chat 返回)
offset int 已读 chunk 偏移

返回参数

参数类型描述
data.status string pending|running|done|error|stopped
data.stage string queued|thinking|streaming|done
data.chunks array 新增
data.offset int 下次轮询
data.done bool 是否结束

状态码说明

状态码描述
0 成功

API - AI智能体_SSE断线续读(Redis

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_chat_live

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stream_id string SSE meta 返回的
offset int 已读 live 偏移

返回参数

参数类型描述
data.chunks array 新增块(OpenAI/NVIDIA
data.offset int 下次轮询
data.done bool 流是否结束

状态码说明

状态码描述
0 成功

API - AI智能体_停止流式生成

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_ai_tool/agent_chat_stop

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stream_id string 流式任务id(agent_chatSSE首包meta返回) 空 必须

状态码说明

状态码描述
0 成功

预警公开看板

API - 预警看板汇总

请求方式: POST|GET

请求地址:https://apply.buyql.com/index.php/api/Public_alert/dashboard

请求参数

参数类型描述默认值是否必须
recent_limit int 最近待处理条数 20 非必须(1~50)
day_trend int 近 N 日新增趋势

返回参数

参数类型描述
data.summary object 总量与待处理分等级
data.rules array 规则及各自待处理数
data.recent_pending array 最近待处理告警
data.assets array 到期资产(含剩余天数/是否临期)
data.day_trend array 近几日新增条数
data.generated_at string 生成时间

状态码说明

状态码描述
0 成功

线上公共

API - 汇聚支付-异步通知(线上/LYP)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/huijuPayNotify

API - 微信APP支付-异步通知(线上)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/wxAppPayNotify

API - 让利计算

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/rl

请求参数

参数类型描述默认值是否必须
sj number 售价 空 必须
cb number 成本 空 必须
margin_cap_pct number 分配用让利上限(占售价%;普通默认最高30;传 goods_sz 专区时封顶20)空
goods_sz int 专区ID(goods_sz.id)空 非必须;传入时按专区规则:让利上限≤20、消费金为0;数资专区14让利×2

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 云店列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/cloudlist

请求参数

参数类型描述默认值是否必须
id number 店铺id 空 非必须
name string 店铺名称搜索 空 非必须
page string 页数20条固定 空 必须
gid string 产品id 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 云店店铺资质(买家只读)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/qualification

请求参数

参数类型描述默认值是否必须
shop_id number 云店id 空 必须

返回参数

参数类型描述
data.has_qualification int 是否有可展示资质主体
data.source string 来源
data.company_name string 公司名称
data.contact_name string 联系人
data.phone string 电话
data.email string 邮箱
data.address string 地址
data.license_no string 营业执照号
data.license_pic string 营业执照图片完整

状态码说明

状态码描述
0 成功
100 参数错误/店铺不存在

API - 云店产品列表(买家)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/cloud_goods

请求参数

参数类型描述默认值是否必须
token string token 空 必须
name string 云店名称 空 必须
page string 页数20条固定 空 必须
id string 云店id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 含

状态码说明

状态码描述
0 成功
其他 失败

API - 云店配置产品让利信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/goodscloudlist

请求参数

参数类型描述默认值是否必须
token string token 空 必须
cid string 云店id 空 必须
gid string 产品id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 产品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/Goodslist

请求参数

参数类型描述默认值是否必须
name string 和供应链产品列表参数一致 空 必须
key string 排序字段:id/heat;sales→heat;rprice/price 按售价、rl 按让利(本页本地排序);way=asc|desc
way string 排序方式 asc|desc 空
margin_cap_pct number 让利上限 0~30 空

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 产品详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/Goods

请求参数

参数类型描述默认值是否必须
name string 和供应链产品列表参数一致 空 必须
hxd_id string 产品数据的hxd_id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 产品分类

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/GoodsType

请求参数

参数类型描述默认值是否必须
name string 和供应链产品列表参数一致 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 金刚区数据

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/GoodsTypeIcon

请求参数

参数类型描述默认值是否必须
name string 11 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 专区列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/Goodsszlist

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 品牌列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/brand_list

请求参数

参数类型描述默认值是否必须
page int 页数 空 必须
limit int 每页条数(最大50) 空 必须
name string 品牌名称关键词 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 专区详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/sz

请求参数

参数类型描述默认值是否必须
id string 专区id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 专区产品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_cloud/Goodssz

请求参数

参数类型描述默认值是否必须
id string 专区id 空 必须
name string 搜索 空 必须
brand_id int 品牌id(goods_list.brand_id) 空 非必须
order string desc\asc价格排序方式留空默认排序 空 必须
page int 页数 空 必须
limit int 每页条数 空 必须

返回参数

参数类型描述
data array 列表项含
count int 可展示商品总数(已排除供应链查不到的商品,分页请用此字段)
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

本地生活点餐公共接口

API - 【触点/点餐】桌台解析(扫码)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/table_resolve

请求参数

参数类型描述默认值是否必须
qr_key string 桌台二维码标识 空 必须
visitor_key string 匿名访客标识 空 非必须(空则服务端生成,后续留资请回传)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.shop object 门店信息(img
data.table object 桌台信息(dine_in
data.touchpoint object 触点记录
data.action_type string 落地动作
data.action_config object 落地配置
data.route object 前端跳转
data.visitor_key string 访客标识(请本地持久化)
data.content_material object 内容类触点的素材(action_type=content

状态码说明

状态码描述
0 成功
100 参数或触点不存在

API - 【触点/点餐】桌台解析(NFC

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/nfc_resolve

请求参数

参数类型描述默认值是否必须
nfc_tag_id string NFC 标签 ID
visitor_key string 匿名访客标识 空 非必须

返回参数

参数类型描述
data object 结构同

状态码说明

状态码描述
0 成功
100 标签未绑定或触点停用

API - 【触点】统一解析(NFC/二维码/触点码)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/touchpoint_resolve

请求参数

参数类型描述默认值是否必须
nfc_tag_id string NFC 标签 空
qr_key string 二维码 key 空
touchpoint_code string 触点编码 TP 开头
visitor_key string 匿名访客标识 空 非必须

返回参数

参数类型描述
data object 结构同

状态码说明

状态码描述
0 成功
100 参数错误或触点不存在

API - 【触点】访问事件上报

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/touchpoint_visit

请求参数

参数类型描述默认值是否必须
touchpoint_id int 触点ID 无 必须
visitor_key string 访客标识 空 非必须
event_type string resolve/lead/content_view/share 空 非必须

API - 【触点】私域留资

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/touchpoint_lead_submit

请求参数

参数类型描述默认值是否必须
touchpoint_id int 触点ID 无 必须
phone string 手机号 无 必须
visitor_key string 访客标识 空 非必须
nickname string 昵称 空 非必须
remark string 备注 空 非必须

API - 【触点】内容页素材

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/touchpoint_content

请求参数

参数类型描述默认值是否必须
material_id int 素材ID 无 必须
shop_id int 门店ID 无 必须

API - 【点餐】门店菜单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/menu_list

请求参数

参数类型描述默认值是否必须
shop_id int 门店ID 0 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.category_list array 分类树(含
data.shop object 门店信息(含

状态码说明

状态码描述
0 成功

API - 【点餐】外卖门店信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/takeout_config

请求参数

参数类型描述默认值是否必须
shop_id int 门店ID 0 必须

返回参数

参数类型描述
data.shop object 门店地址/经纬度(配送费请调

状态码说明

状态码描述
0 成功

API - 【点餐】购物车列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/cart_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
order_type int 订单类型(1堂食、2外卖) 1 必须
qr_key string 堂食桌台二维码标识 空 条件必填(order_type=1)
shop_id int 门店ID 0 条件必填(order_type=2)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.cart object 购物车头(无则为null)
data.items array 购物车明细
data.summary object 金额汇总
data.shop object 门店地址/经纬度(配送费请单独调

状态码说明

状态码描述
0 成功

API - 【点餐】购物车加购

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/cart_add

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
order_type int 订单类型(1堂食、2外卖) 1 必须
qr_key string 堂食桌台二维码标识 空 条件必填(order_type=1)
shop_id int 门店ID 0 条件必填(order_type=2)
product_id int 商品ID 0 必须
sku_id int 规格ID 0 可选
quantity int 数量 1 可选(最小1)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 购物车及金额汇总

状态码说明

状态码描述
0 成功

API - 【点餐】购物车修改数量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/cart_update

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
item_id int 购物车明细ID 0 必须
quantity int 数量(<=0时删除该行) 1 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 购物车及金额汇总

状态码说明

状态码描述
0 成功

API - 【点餐】购物车删除商品

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/cart_delete

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
item_id int 购物车明细ID 0 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 购物车及金额汇总

状态码说明

状态码描述
0 成功

API - 【点餐】购物车清空

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/cart_clear

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
order_type int 订单类型(1堂食、2外卖) 1 必须
qr_key string 堂食桌台二维码标识 空 条件必填(order_type=1)
shop_id int 门店ID 0 条件必填(order_type=2)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 购物车及金额汇总

状态码说明

状态码描述
0 成功

API - 【点餐】创建订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/order_create

请求参数

参数类型描述默认值是否必须
order_type int 订单类型(1堂食、2外卖) 1 必须
qr_key string 堂食桌台二维码标识 空 条件必填(order_type=1)
shop_id int 门店ID 0 条件必填(order_type=2)
items string 下单商品JSON数组 空 必须(元素含product_id、sku_id、quantity)
diners int 用餐人数 0 可选
remark string 备注 空 可选
receiver_name string 收货人 空 条件必填(order_type=2)
receiver_phone string 收货电话 空 条件必填(order_type=2)
receiver_address string 收货地址 空 条件必填(order_type=2)
buyer_openid string 用户openid(微信同城配发单) 空 可选(order_type=2)
receiver_lat number 收货纬度 空 可选(order_type=2)
receiver_lng number 收货经度 空 可选(order_type=2)
expect_time string 期望送达时间 空 可选(order_type=2)
delivery_fee number 配送费(元,来自达达询价 deliverFee) 0
package_fee number 打包费(元) 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果(order_id、order_no、order_type、pay_amount)

状态码说明

状态码描述
0 成功

API - 【点餐】创建支付

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/pay_create

请求参数

参数类型描述默认值是否必须
id number 点餐订单 shop_order.id 空
order_no string 订单号 空 非必须(与
pay_channel string 支付通道 huiju 可选(默认
price number 现金支付金额(同 xj)0 非必须(均未传分项时默认为全额现金)
xj number 现金金额别名 0 非必须(price
ye number 余额支付金额 0 非必须
dkq number 抵扣券支付金额 0 非必须
yhq number 消费金支付金额 0 非必须
xfq number 消费券支付金额 0 非必须
dkqdh number 抵扣券兑换支付金额 0 非必须
tmq number 特卖券支付金额 0 非必须
thq number 特惠券支付金额 0 非必须
q1_FrpCode string 汇聚支付通道(现金部分大于0时必填);云闪付 UNIONPAY_*;支付宝服务窗 ALIPAY_FWC
p8_ReturnUrl string 汇聚同步跳转地址(可选);云闪付仅 UNIONPAY_H5/UNIONPAY_WXMP 支持
qj_DJPlan string 汇聚点金计划 JSON(可选)
wx_code string 微信授权code(可选,后端可换取 openid)
q5_OpenId string 微信openid(可选)
q7_AppId string 微信/支付宝 appid(可选)
alipay_code string 支付宝服务窗授权 code(ALIPAY_FWC 时换
qb_buyerId string 支付宝买家 user_id(可选)
alipay_appid string 支付宝 appid(可选,详见 huijuMergeChannelIdsIntoMeta)
alipay_openid string 支付宝用户标识(可选)
delivery_no string 达达询价 deliveryNo(wx_intracity_pre_fee 返回,支付后

返回参数

参数类型描述
结构与 mixed Order_big::palayorder

状态码说明

状态码描述
0 成功

API - 【点餐】汇聚

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/huijuShopFoodPayNotify

API - 【点餐】支付回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/pay_notify

请求参数

参数类型描述默认值是否必须
pay_no string 支付单号 空 必须
trade_no string 三方交易号 空 可选
pay_status int 支付状态(1成功,其他失败) 0 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 响应数据(通常为空)

状态码说明

状态码描述
0 成功

API - 【点餐】外卖配送费询价(默认京东达达

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/wx_intracity_pre_fee

请求参数

参数类型描述默认值是否必须
shop_id int 门店ID 0 必须
provider string 运力:jdms(默认,京东达达) / wx(微信同城)
user_name string 收件人 空 必须
user_phone string 收件手机 空 必须
user_lng number 收货经度 空 必须
user_lat number 收货纬度 空 必须
user_address string 收货详细地址 空 必须
cargo_name string 商品概括名称 空 必须
cargo_weight number 总重量:默认按克传入,服务端会换算为达达所需千克 空 必须
cargo_price number 商品总价:默认按分传入,达达询价按元换算 0 必须
cargo_type int 达达物品类型,默认26 26 非必须
cargo_num int 件数 1 非必须
order_no string 预发布 origin_id,不传则自动生成 FD
items string 购物车商品JSON(product_id/sku_id/quantity),用于 product_list 空
product_list string 达达 product_list JSON,传则优先
info string 订单备注 空 非必须
use_sandbox int 是否沙箱1是0否(仅 provider=wx 时有效)

返回参数

参数类型描述
data object deliverFee/fee/deliveryNo/result

状态码说明

状态码描述
0 成功

API - 【点餐】微信同城配送状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_food/wx_intracity_notify

状态码说明

状态码描述
0 成功(微信要求

影音

API - 【影音】影音分类查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/category

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 分类列表(id、parentId

状态码说明

状态码描述
0 成功

API - 【影音】商品接口

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/productList

请求参数

参数类型描述默认值是否必须
waresName string 商品名称 空 可选
productClassify string 分类ID 空 可选
pageNum int 页码 1 可选
pageSize int 每页条数 20 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.total object 总条数

状态码说明

状态码描述
0 成功

API - 【影音】影音下单-直冲

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/sendOrder

请求参数

参数类型描述默认值是否必须
productid string 商品id 空 必须
account string 充值账号 空 必须
number int 下单数量 空 必须
billno string 交易流水号 空 必须
dprice number 对接商品单价 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果(orderSn、orderStatus、deductionsPrice、thirdPartyPrice、version、cards)

状态码说明

状态码描述
0 成功

API - 【影音】影音下单-卡密

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/sendCardOrder

请求参数

参数类型描述默认值是否必须
productid string 商品id 空 必须
number int 下单数量 空 必须
billno string 交易流水号 空 必须
dprice number 对接商品单价 空 可选(部分商品可能要求)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果(orderSn、orderStatus、cards等)

状态码说明

状态码描述
0 成功

API - 【影音】影音订单查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/queryOrder

请求参数

参数类型描述默认值是否必须
orderSn string 订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(orderSn、account、sumPrice、orderStatus、cards)

状态码说明

状态码描述
0 成功

API - 【影音】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_av/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型 空 必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须

大牌点餐

API - 大牌跳转列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/brand_jump

返回参数

参数类型描述
data array 品牌列表,mode=jump,用

状态码说明

状态码描述
0 成功

API - 【大牌点餐】点餐城市列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/citylist

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 城市列表

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】根据经纬度获取匹配的城市(点餐城市列表中距离最近的城市完整数据)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cityByLocation

请求参数

参数类型描述默认值是否必须
latitude number 纬度 空 必须
longitude number 经度 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 匹配到的城市完整数据(含id/cityId、name、lat、lng等)

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】附近店铺列表(聚合所有品牌)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/storelist

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须;合并影院时与
latitude number 纬度 空 必须;等同
longitude number 经度 空 必须;等同
keywords string 关键字 空 可选
page number 页码 1 可选
limit number 每页条数 20 可选
brands string 品牌筛选 空 可选;非空(trim
include_hotels number 是否合并附近酒店与影院 1 可选
hotel_page number 酒店列表页码 1 可选
hotel_row number 酒店每页条数 10 可选
movieDistrictId string 电影区域ID 空 可选
movieBrandId string 影院品牌ID 空 可选
debug number 调试信息 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 门店(及可选酒店、影院)合并分页列表;项含
total int 合并列表总条数;brands
brandLogos array 品牌

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】按城市获取店铺列表(聚合所有品牌)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/storelistByCity

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须
page number 页码 1 可选
limit number 每页条数 20 可选
brands string 品牌筛选 空 可选
latitude number 纬度 空 可选
longitude number 经度 空 可选
debug number 调试信息 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 门店列表(含
other.brandLogos array 品牌

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】门店详情及菜单(点开店后获取菜单)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/storemenu

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须
storeCode string 门店编码 空 非麦当劳外卖时必填;麦当劳外卖模式请勿传,只传经纬度
receiverLng string 经度 空 麦当劳外卖模式必填
receiverLat string 纬度 空 麦当劳外卖模式必填
orderType string 必胜客:类型0堂食1外带2外送 空 可选
orderCode string 必胜客:桌边二维码堂食必填 空 可选
delivery string 奈雪:是否外卖,true/delivery=外卖false/to_go=到店自取,奈雪必传 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 门店信息及菜单

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】商品详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/gooddetail

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须
storeCode string 门店编码(统一入参,奈雪/星巴克内部用storeId) 空 必须
itemNo string 商品编号(统一入参,各品牌内部映射为linkId/productId/goodId/itemId) 空 必须
orderType string 必胜客专用:业务标识0堂食1外带2外送 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 商品详情(含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】下单前校验

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/checkorder

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须(cudi/kfc/luckin/mcdonalds/nayuki/pizzahut/starbucks/tasting/bawang/dicos)
storeCode string 门店编码 空 视品牌而定(部分品牌用
storeId string 门店ID 空 视品牌而定
cityId string 城市ID 空 多数品牌必填
packFlag string 奈雪专用:0堂食1外带2外送 空 可选
orderType string 必胜客专用:业务标识 0堂食1外带2外送 空
receiverLng string 收货经度 空 外卖场景按品牌要求
receiverLat string 收货纬度 空 外卖场景按品牌要求
receiverName string 收货人姓名 空 可选
receiverPhone string 收货人电话 空 可选
receiverAddress string 收货地址 空 可选
goods array|string 商品列表(数组或 JSON 字符串)空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 校验结果

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】创建订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/createorder

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须(cudi/kfc/luckin/mcdonalds/nayuki/pizzahut/starbucks/tasting/bawang/dicos)
outId string 外部订单ID 空 必须
phoneNo string 手机号 空 必须
floorPrice string 底价 空 必须
model string 取餐方式:0堂食 1自取 2外送(多数品牌)
packFlag string 奈雪专用:0堂食 1外带 2外送
orderType string 必胜客专用:0堂食 1外带 2外送
customerRemark string 客户备注 空 可选
storeCode string 门店编码 空 视品牌而定(部分品牌用
storeId string 门店ID 空 视品牌而定
cityId string 城市ID 空 必须
receiverLng string 收货经度 空 外卖场景按品牌要求
receiverLat string 收货纬度 空 外卖场景按品牌要求
receiverName string 收货人姓名 空 可选
receiverPhone string 收货人电话 空 可选
receiverAddress string 收货地址 空 可选
goods array|string 商品列表(数组或 JSON 字符串)空
defer_platform_pay number 先款后下单开关 1 可选
hxd_price number 本平台应付金额 空 可选
hxd_price_supply number 供货结算价 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 直下单时含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/orderdetail

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须(cudi/kfc/luckin/mcdonalds/nayuki/pizzahut/starbucks/tasting/bawang/dicos)
outId string 外部订单ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 订单详情

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】订单详情同步(按本平台订单拉取来一票并写入

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/orderdetailsync

请求参数

参数类型描述默认值是否必须
hxdOrderId number 本平台订单 id 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/ordercallback

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型 空 非必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须(嵌套:orderCode、entPara、data.status

API - 【大牌点餐】单店购物车-列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartList

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须
cityId string 城市ID 空 必须
storeCode string 门店编码 空 视品牌
storeId string 门店ID 空 视品牌
model number 取餐方式:0堂食1打包/自取2外送 空 可选(用于区分购物车分组)
packFlag string 奈雪:0堂食1外带2外送 空 可选(用于区分购物车分组)
orderType string 必胜客:0堂食1外带2外送 空 可选(用于区分购物车分组)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-更新抬头(取餐方式/外卖收货/备注等)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartHeaderUpdate

请求参数

参数类型描述默认值是否必须
cart_id number 购物车id 空 必须
model number 取餐方式 0 可选
packFlag string 奈雪 0堂食1外带2外送 空
orderType string 必胜客 0堂食1外带2外送 空
customerRemark string 客户备注 空 可选
receiverLng string 收货经度 空 可选
receiverLat string 收货纬度 空 可选
receiverName string 收货人姓名 空 可选
receiverPhone string 收货人电话 空 可选
receiverAddress string 收货地址 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-加购(单行)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartAdd

请求参数

参数类型描述默认值是否必须
brandKey string 品牌key 空 必须
cityId string 城市ID 空 必须
storeCode string 门店编码 空 视品牌
storeId string 门店ID 空 视品牌
good array|object|string 一行商品对象(同 checkorder/createorder 的
lineKey string 行唯一键 空 可选
merge number 同 lineKey 时是否合并数量
model number 取餐方式:0堂食1打包/自取2外送 空 可选(用于区分购物车分组)
packFlag string 奈雪:0堂食1外带2外送 空 可选(用于区分购物车分组)
orderType string 必胜客:0堂食1外带2外送 空 可选(用于区分购物车分组)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-删除行

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartRemove

请求参数

参数类型描述默认值是否必须
item_id number 购物车行id 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-清空

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartClear

请求参数

参数类型描述默认值是否必须
cart_id number 购物车id 空 必须
item_ids mixed 购物车行 id 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-下单前校验(汇总购物车调来一票

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartCheckorder

请求参数

参数类型描述默认值是否必须
cart_id number 购物车id 空 必须
item_ids mixed 购物车行 id 空
phoneNo string 手机号 空 可选(不传时可由
address_id number 地址簿 id 空
customerRemark string 客户备注 空 可选(兼容
create_local_order number 是否创建本地待支付订单,默认1;传0/false/no时仅调来一票checkOrder并返回算价,不落库order(data.hxdOrderId为null,含defer_payload便于再次提交) 1 可选;
product_info string 商品信息 JSON 字符串,写入

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 校验结果

状态码说明

状态码描述
0 成功
其他 失败

API - 【大牌点餐】单店购物车-创建订单(汇总购物车

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_brand/cartCreateorder

请求参数

参数类型描述默认值是否必须
hxdOrderId number 本平台订单id(cartCheckorder 返回) 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

干洗

API - 【干洗】干洗分类列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/classify

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 分类列表(groupId、parentId

状态码说明

状态码描述
0 成功

API - 【干洗】干洗商品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/productList

请求参数

参数类型描述默认值是否必须
categoryId string 分类ID 空 可选
categoryName string 分类名称 空 可选
productName string 商品名称 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 商品列表(productId、categoryId

状态码说明

状态码描述
0 成功

API - 【干洗】创建订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/createOrder

请求参数

参数类型描述默认值是否必须
orderId string 订单id 空 必须
userName string 下单人姓名 空 必须
userPhone string 下单人手机号 空 必须
sendUserName string 发货人姓名 空 必须
sendUserPhone string 发货人手机号 空 必须
sendProvince string 发货人省 空 必须
sendCity string 发货人市 空 必须
sendArea string 发货人区 空 必须
sendUserAddress string 发货人地址 空 必须
recUserName string 收货人姓名 空 必须
recUserPhone string 收货人手机号 空 必须
recProvince string 收货人省 空 必须
recCity string 收货人市 空 必须
recArea string 收货人区 空 必须
recUserAddress string 收货人地址 空 必须
reservationDate string 预约日期 空 必须
reservationStartTime string 预约起始时间 空 必须
reservationEndTime string 预约结束时间 空 必须
orderItems string 订单商品列表 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果(orderId、orderNo、status)

状态码说明

状态码描述
0 成功

API - 【干洗】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/cancelOrder

请求参数

参数类型描述默认值是否必须
orderNo string 订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 返回结果(通常为空对象/空值)

状态码说明

状态码描述
0 成功

API - 【干洗】订单列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/orderList

请求参数

参数类型描述默认值是否必须
orderNo string 订单号 空 可选
status string 状态 空 可选
pageNo int 页码 1 可选
pageSize int 每页条数 10 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 列表结果(total、rows)

状态码说明

状态码描述
0 成功

API - 【干洗】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_dryclean/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型 空 必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(orderNo、status、expNo、rawData)

状态码说明

状态码描述
0 成功

酒店

API - 【酒店】城市列表查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/cityList

请求参数

参数类型描述默认值是否必须
page int 页码 1 必须
row int 每页大小 100 必须
cityCode string 城市编码 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 城市列表(pinyinName、province、cityCode、cityName)

状态码说明

状态码描述
0 成功

API - 【酒店】按经纬度搜酒店(只传经纬度,内部解析

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/cityByLocation

请求参数

参数类型描述默认值是否必须
latitude number 纬度 空
longitude number 经度 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.total object 总数

状态码说明

状态码描述
0 成功

API - nearbyHotelsDataForApiMerge

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/nearbyHotelsDataForApiMerge

返回参数

参数类型描述
array{ok:bool,msg:string,data:?array,cityCode:string,hotelCity:?array}

API - 【酒店】酒店列表查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/hotelList

请求参数

参数类型描述默认值是否必须
cityCode string 城市编码 空 必须
checkInDate string 入住日期 空 必须
checkOutDate string 离店日期 空 必须
page int 页码 1 必须
row int 每页条数 10 必须
keyword string 关键词 空 可选
minPrice number 最低价格 空 可选
maxPrice number 最高价格 空 可选
sortType string 排序 空 可选
ranks array 星级 空 可选
latitude number 纬度 空 可选
longitude number 经度 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.total object 总数

状态码说明

状态码描述
0 成功

API - 【酒店】酒店详情查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/hotelDetail

请求参数

参数类型描述默认值是否必须
hotelCode string 酒店编码 空 必须
checkInDate string 入住日期 空 必须
checkOutDate string 离店日期 空 必须
adultCount int 成人数量 空 可选
childCount int 儿童数量 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 酒店详情(含

状态码说明

状态码描述
0 成功

API - 【酒店】预下单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/createOrder

请求参数

参数类型描述默认值是否必须
partnerOrderNo string 合作商单号 空 必须
checkInDate string 入住日期 空 必须
checkOutDate string 离店日期 空 必须
hotelCode string 酒店编码 空 必须
uniqueId string 酒店详情返回的唯一ID 空 必须
arriveEarlyTime string 最早入住时间 空 必须
arriveLastTime string 最晚到店时间 空 必须
contacterName string 联系人姓名 空 必须
contacterPhone string 联系人手机号 空 必须
roomList array 房间列表 空 必须
guests array 客人列表 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 预下单结果(orderNo、partnerOrderNo)

状态码说明

状态码描述
0 成功

API - 【酒店】支付订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/payOrder

请求参数

参数类型描述默认值是否必须
hotelOrderNo string 业务订单编码 空 必须
partnerOrderNo string 合作商订单编码 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 支付结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【酒店】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/cancelOrder

请求参数

参数类型描述默认值是否必须
hotelOrderNo string 业务订单编码 空 必须
partnerOrderNo string 合作商订单编码 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 取消结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【酒店】申请退款

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/applyReturnOrder

请求参数

参数类型描述默认值是否必须
hotelOrderNo string 业务订单编码 空 必须
partnerOrderNo string 合作商订单编码 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 退款申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【酒店】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/orderDetail

请求参数

参数类型描述默认值是否必须
hotelOrderNo string 业务订单编码 空 必须
partnerOrderNo string 合作商订单编码 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【酒店】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_hotel/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型 空 必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(orderNo、orderStatus、otherOrderStatus、refundAmount)

状态码说明

状态码描述
0 成功

电影

API - 【电影】获取城市列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/citylist

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 城市列表(含

状态码说明

状态码描述
0 成功

API - 【电影】获取影院过滤列表(城市影院品牌和区域信息)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/cinemaFilter

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.brands object 影院品牌列表
data.district object 区域列表

状态码说明

状态码描述
0 成功

API - 【电影】获取影院列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/cinemaList

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须
districtId string 区域ID 空 可选
brandId string 品牌 空 可选
lat string 纬度 空 可选
lng string 经度 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 影院列表(含

状态码说明

状态码描述
0 成功

API - cinemasDataForStorelistMerge

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/cinemasDataForStorelistMerge

返回参数

参数类型描述
array{ok:bool,msg:string,rows:array}

API - 【电影】获取广告列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/adConfig

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 广告列表(含

状态码说明

状态码描述
0 成功

API - 【电影】热映电影

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/hotMovie

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 热映电影列表(含

状态码说明

状态码描述
0 成功

API - 【电影】即将上映电影

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/comingMovie

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 即将上映电影列表(含

状态码说明

状态码描述
0 成功

API - 【电影】获取电影的影院列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/movieCinema

请求参数

参数类型描述默认值是否必须
movieId string 电影ID 空 必须
cityId string 城市ID 空 必须
districtId string 区域ID 空 可选
brandId string 品牌 空 可选
lat string 纬度 空 可选
lng string 经度 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功

API - 【电影】获取电影详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/movieDetail

请求参数

参数类型描述默认值是否必须
movieId string 电影ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 电影详情(含

状态码说明

状态码描述
0 成功

API - 【电影】获取影院某个电影的排片列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/schedule

请求参数

参数类型描述默认值是否必须
cinemaId string 影院Code 空 必须
movieId string 电影Code 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功

API - 【电影】获取电影场次(座位)详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/showDetail

请求参数

参数类型描述默认值是否必须
sessionId string 场次ID 空 必须
cinemaId string 影院Code 空 必须
movieId string 电影Code 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 场次详情(含

状态码说明

状态码描述
0 成功

API - 【电影】创建电影票订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/createOrder

请求参数

参数类型描述默认值是否必须
orderId string 第三方订单号 空 必须
cinemaCode string 影院编码 空 必须
movieCode string 影片编码 空 必须
cityName string 城市名称 空 必须
cinemaName string 影院名称 空 必须
hallName string 影厅名称 空 必须
movieName string 影片名称 空 必须
seatNames string 座位名称 空 必须
switchSeat bool 是否可调座 空 必须
cinemaAddress string 影院地址 空 可选
sessionBeginTime string 场次开始时间 空 必须
sessionEndTime string 场次结束时间 空 可选
movieVersion string 影片版本 空 可选
originPrice number 原价 空 必须
fastTicket bool 是否快速票 空 可选
postImageUrl string 影片海报 空 可选
userMobile string 用户手机号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data string 业务订单号

状态码说明

状态码描述
0 成功

API - 【电影】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/orderInfo

请求参数

参数类型描述默认值是否必须
entOrderId string 第三方订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(含

状态码说明

状态码描述
0 成功

API - 【电影】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_movie/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户应用编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型编码 空 必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调关键信息(含

状态码说明

状态码描述
0 成功

打车

API - 【打车】获取城市列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/cityList

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 城市列表(id、name、code)

状态码说明

状态码描述
0 成功

API - 【打车】接入用户登录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/userLogin

请求参数

参数类型描述默认值是否必须
data object|array 业务体:channelType、uid、isvip、type(1打车v1 2打车v2);可与整包 JSON

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 登录结果(accessToken、expiresIn、userId

状态码说明

状态码描述
0 成功

API - 【打车】获取打车预估价(estimatePrice)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/estimate

请求参数

参数类型描述默认值是否必须
data object|array 业务体,可与整包JSON同级或放在根上;字段:channelType、token或uid(uid时可选isvip默认0,走Redis自动登录)、serviceType、companyId、passengerName、passengerPhone、departCityCode、departLng、departLat、departLocationName、departLocation、destCityCode、destLng、destLat、destLocationName、destLocation、departTime;兼容旧字段cityCode/startLat/startLng/endLat/endLng/startAddress/endAddress 空 必须(除地点文案可空外按来一票要求)
type int 打车类型,1打车v1;2打车v2,写入来一票data.type 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 预估价结果(以接口文档为准)

状态码说明

状态码描述
0 成功

API - 【打车】获取当前登录账号手机号(非脱敏)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/currentPhone

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.uid object 用户ID
data.phone object 手机号(完整)

状态码说明

状态码描述
0 成功

API - 【打车】打车下单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/createOrder

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
token string 令牌 空 必须
uid string 用户唯一标识 空 可选
isvip string 是否会员 0 可选
orderId string 接入方自定义订单号 空 必须
unique string 预估车价唯一标识 空 必须
cTransportList string 预估车价列表 空 必须
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果(orderCode、orderStatus)

状态码说明

状态码描述
0 成功

API - 【打车】订单支付

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/orderPay

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
token string 令牌 空 必须
uid string 用户唯一标识 空 可选
isvip string 是否会员 0 可选
orderCode string 订单号 空 必须
payAmount string 支付金额 空 必须
payResult string 支付结果 空 必须
payMsg string 支付信息 空 必须
outTradeNo string 第三方支付订单号 空 必须
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 支付结果(orderCode、orderStatus、deductionPrice)

状态码说明

状态码描述
0 成功

API - 【打车】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/orderDetail

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
token string 令牌 空 必须
uid string 用户唯一标识 空 可选
isvip string 是否会员 0 可选
orderCode string 订单号 空 必须
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(含

状态码说明

状态码描述
0 成功

API - 【打车】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/cancelOrder

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
token string 令牌 空 必须
uid string 用户唯一标识 空 可选
isvip string 是否会员 0 可选
orderCode string 订单号 空 必须
reason string 取消原因 空 必须
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 取消结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【打车】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型 空 必须
interfaceCode string 接口编码 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(orderCode、orderStatus、orderMoney、refundMoney、status、extent)

状态码说明

状态码描述
0 成功

API - 【打车】实时订单查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/orderFind

请求参数

参数类型描述默认值是否必须
channelType string 接入类型 1 必须
token string 令牌 空 必须
uid string 用户唯一标识 空 可选
isvip string 是否会员 0 可选
orderCode string 订单号 空 可选
type int 打车类型 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 实时订单结果(orders/hasLoadingOrder/driverLocation/route)

状态码说明

状态码描述
0 成功

API - 【腾讯地图】逆地址解析(坐标转地址)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/tencentReverseGeocode

请求参数

参数类型描述默认值是否必须
location string 坐标(纬度,经度)如 31.944629985548865,118.86784675187597 空
latitude string 纬度(兼容参数) 空 非必须
longitude string 经度(兼容参数) 空 非必须
getPoi int 是否返回POI 0 可选
radius int 吸附半径 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 腾讯逆地址解析返回结果

状态码说明

状态码描述
0 成功

API - 【腾讯地图】路线规划(驾车/公交/步行/骑行)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/tencentRoutePlan

请求参数

参数类型描述默认值是否必须
mode string 规划类型 driving 可选
fromLat string 起点纬度 空 必须
fromLng string 起点经度 空 必须
toLat string 终点纬度 空 必须
toLng string 终点经度 空 必须
policy string 策略 空 可选
waypoints string 途经点 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 腾讯路线规划返回结果

状态码说明

状态码描述
0 成功

API - 【腾讯地图】关键词输入提示

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_taxi/tencentSuggestion

请求参数

参数类型描述默认值是否必须
keyword string 关键词 空 必须
region string 城市范围 空 可选
regionFix int 是否限定城市 0 可选
location string 定位点 空 可选
pageIndex int 页码 1 可选
pageSize int 每页 10 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 腾讯关键词提示结果

状态码说明

状态码描述
0 成功

机票

API - 【机票(国内)】获取城市

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/cityList

请求参数

参数类型描述默认值是否必须
cityCode string 城市三字码,筛选城市 空 可选
airportCode string 机场三字码,筛选机场 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 机场列表(airportName、airportCode、city

状态码说明

状态码描述
0 成功

API - 【机票(国内)】获取航班列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/flightList

请求参数

参数类型描述默认值是否必须
passengerType string 乘客类型,ADULT成人 CHILDREN儿童 ADULT_CHILED成人+儿童
routeType string 航线类型,OW单程 RT往返 空
depDate string 起飞日期,格式 yyyy-MM-dd 空
depAirport string 起飞机场/城市编码 空 必须
arrAirport string 到达机场/城市编码 空 必须
carrier string 航空公司代码 空 可选
returnDate string 返程日期,往返时必填 空 可选
returnDepAirport string 返程起飞机场 空 可选
returnArrAirport string 返程到达机场 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 航班列表(含

状态码说明

状态码描述
0 成功

API - 【机票(国内)】获取航班详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/flightDetail

请求参数

参数类型描述默认值是否必须
routeId string 航线ID,可从 flightList 获取

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 航班详情(含

状态码说明

状态码描述
0 成功

API - 【机票(国内)】客规查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/passengerRule

请求参数

参数类型描述默认值是否必须
depDate string 起飞日期,格式 yyyy-MM-dd 空
depAirportCode string 起飞机场三字码 空 必须
arrAirportCode string 到达机场三字码 空 必须
flightNo string 航班号 空 必须
policyId string 政策ID,从 flightDetail 的
passengerType string 乘客类型,ADULT/CHILDREN/INFANT 空 必须
seatCode string 座位号,舱位代码如 Y/K/D 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 客规信息(luggage、luggageDetails、simpleDetails

状态码说明

状态码描述
0 成功

API - 【机票(国内)】校验价格

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/verifyPrice

请求参数

参数类型描述默认值是否必须
routeType string 航线类型,OW单程 RT往返 空
routes string 行程信息(JSON 数组),每项含 tripType(DEPART/RETURN)、policyId、segments;segment

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 含

状态码说明

状态码描述
0 成功

API - 【机票(国内)】预下单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/createOrder

请求参数

参数类型描述默认值是否必须
routeType string 航线类型,OW单程 RT往返 空
orders string 订单信息(数组或 JSON 字符串),每项含
defer_platform_pay number 先款后下单,传1 时生成本平台待支付单(需 HTTP_HXDTOKEN、hxd_price)1
hxd_price number 本平台应付金额,defer_platform_pay=1 时必填 空
hxd_price_supply number 供货结算价,默认同 hxd_price 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 下单结果(tripType、orderId、airOrderNo)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】支付前校验

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/checkBeforePay

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 支付前校验结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】支付订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/payOrder

请求参数

参数类型描述默认值是否必须
orderType string 订单类型,默认 NORMAL 空
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作商订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 支付结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/cancelOrder

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作商订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 取消结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】申请退款

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/applyRefund

请求参数

参数类型描述默认值是否必须
orderNo string 订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须
refundType string 退票类型,R1-R10 空 必须
reason string 申请原因描述 空 必须
applyType string 申请类型,REFUND_TICKET/REFUND_DIFF 空 必须
images string 凭证图片数组,JSON 数组 空
segments string 航段信息,JSON 数组 空
passengers string 乘客信息,JSON 数组 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 退款申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/orderDetail

请求参数

参数类型描述默认值是否必须
orderId string 平台订单号 空 必须
orderNo string 机票订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】改签航班查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/ctmtSearchFlight

请求参数

参数类型描述默认值是否必须
orderNo string 订单号 空 必须
routeId string 航线ID 空 必须
changeDepDate string 改签日期 空 必须
passengerType string 乘客类型,ADULT/CHILDREN/INFANT 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 改签航班列表(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】改签航班详情查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/ctmtSearchFlightInfo

请求参数

参数类型描述默认值是否必须
orderNo string 订单号 空 必须
routeId string 航线ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 改签航班详情(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】申请改签

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/applyChange

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 商户订单号 空 必须
changeType string 改签类型 空 必须
reason string 改签原因 空 可选
routeId string 航段标识 空 必须
segments string 航段信息,JSON 数组 空
passengers string 乘客信息,JSON 数组 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 改签申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型,domestic_air_tickets_interface 空 必须
interfaceCode string 接口编码,orderPush 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(orderNo、status、orderStatus、refundOrderNo、rebookingOrderNo、orderDetails)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】航班状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/flightChangesCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型,domestic_air_tickets_interface 空 必须
interfaceCode string 接口编码,flightChanges 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(orderNo、partnerOrderNo、flightInfos)

状态码说明

状态码描述
0 成功

API - 【机票(国内)】常用乘机人-列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/passengerList

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.list array 乘机人列表(camelCase,便于拼

状态码说明

状态码描述
0 成功
其他 失败

API - 【机票(国内)】常用乘机人-新增

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/passengerAdd

请求参数

参数类型描述默认值是否必须
passengerName string 乘客姓名 空 必须
passengerType string 乘客类型,ADULT/CHILDREN/INFANT 空 必须
passengerCardType string 证件类型,0身份证1护照 空 必须
cardNumbers string 证件号 空 必须
passengerPhone string 手机号 空 必须
birthday string 生日 空 必须
priceId string 价格ID,以验价返回为准,模板可空 空 可选
price string 价格 空 可选
airportTax string 基建费 空 可选
fuelTax string 燃油费 空 可选
gender string 乘客性别,MALE/FEMALE 空 可选
expireDate string 证件有效期,非身份证必填 空 可选
firstName string 英文名,护照必填 空 可选
lastName string 英文姓,护照必填 空 可选
issueCountry string 签发国二字码,非身份证必填 空 可选
country string 国籍二字码,非身份证必填 空 可选
sortOrder number 排序,越小越靠前 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【机票(国内)】常用乘机人-更新

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/passengerUpdate

请求参数

参数类型描述默认值是否必须
id number 记录id 空 必须
passengerName string 乘客姓名 空 可选
passengerType string 乘客类型,ADULT/CHILDREN/INFANT 空 可选
passengerCardType string 证件类型,0身份证1护照 空 可选
cardNumbers string 证件号,变更时不可与同用户其他记录冲突 空 可选
passengerPhone string 手机号 空 可选
birthday string 生日 空 可选
priceId string 价格ID 空 可选
price string 价格 空 可选
airportTax string 基建费 空 可选
fuelTax string 燃油费 空 可选
gender string 乘客性别,MALE/FEMALE 空 可选
expireDate string 证件有效期 空 可选
firstName string 英文名 空 可选
lastName string 英文姓 空 可选
issueCountry string 签发国二字码 空 可选
country string 国籍二字码 空 可选
sortOrder number 排序 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.passenger object 更新后的乘机人

状态码说明

状态码描述
0 成功
其他 失败

API - 【机票(国内)】常用乘机人-删除

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_ticket/passengerDelete

请求参数

参数类型描述默认值是否必须
id number 记录id 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

旅游

API - 【旅游】获取旅游城市

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/cityList

请求参数

参数类型描述默认值是否必须
cityName string 城市名称 空 必须
pageNo int 页码 1 可选
pageSize int 每页条数 10 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 城市列表(cityId、cityName、cityCode、cityParentId、cityExtra)

状态码说明

状态码描述
0 成功

API - 【旅游】获取旅游景区列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/scenicList

请求参数

参数类型描述默认值是否必须
cityId string 城市ID 空 必须
pageNo int 页码 1 可选
pageSize int 每页条数 10 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 景区列表

状态码说明

状态码描述
0 成功

API - 【旅游】获取景区详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/scenicDetail

请求参数

参数类型描述默认值是否必须
travelScenicAreaId string 景区ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 景区详情

状态码说明

状态码描述
0 成功

API - 【旅游】旅游景区-门票/活动产品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/productTicketList

请求参数

参数类型描述默认值是否必须
travelScenicAreaId string 景区ID 空 可选
categoryId int 品类ID 空 可选
business string 业务类型 空 可选
sortOrder string 排序 空 可选
filtrationNames string 标题过滤 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 产品列表

状态码说明

状态码描述
0 成功

API - 【旅游】旅游景区产品详情/旅游产品详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/productDetail

请求参数

参数类型描述默认值是否必须
productIds string 产品ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 产品详情列表

状态码说明

状态码描述
0 成功

API - 【旅游】旅游景区产品价格/旅游产品价格

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/productPrice

请求参数

参数类型描述默认值是否必须
productIds string 产品ID 空 必须
appointmentTime string 预约日期 空 可选
day string 价格后续天数 1 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 价格列表(含

状态码说明

状态码描述
0 成功

API - 【旅游】(旅游产品类)旅游产品分类

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/productCategory

请求参数

参数类型描述默认值是否必须
parentId int 父级分类ID 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 分类列表

状态码说明

状态码描述
0 成功

API - 【旅游】(旅游产品类)旅游产品列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/travelProductList

请求参数

参数类型描述默认值是否必须
categoryId int 分类ID 空 可选
pageNo int 页码 1 可选
pageSize int 每页条数 10 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 旅游产品列表

状态码说明

状态码描述
0 成功

API - 【旅游】获取下单必填参数

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/filloutProfile

请求参数

参数类型描述默认值是否必须
productId string 产品ID 空 必须
packageId string 套餐ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单必填项(contact、passengerQuestionList)

状态码说明

状态码描述
0 成功

API - 【旅游】旅游景区下单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/saveTravelOrder

请求参数

参数类型描述默认值是否必须
travelScenicAreaId string 景区ID 空 必须
contact object 联系人信息 空 必须
passengerList array 出行人信息列表 空 必须
basicOrder object 基础订单信息 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果

状态码说明

状态码描述
0 成功

API - 【旅游】旅游产品下单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/saveTravelProductOrder

请求参数

参数类型描述默认值是否必须
productID string 产品ID 空 必须
contact object 联系人信息 空 必须
passengerList array 出行人信息列表 空 必须
basicOrder object 基础订单信息 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 下单结果

状态码说明

状态码描述
0 成功

API - 【旅游】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/travelOrderDetail

请求参数

参数类型描述默认值是否必须
orderCode string 订单编号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情

状态码说明

状态码描述
0 成功

API - 【旅游】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/cancelTravelOrder

请求参数

参数类型描述默认值是否必须
orderCode string 订单编号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 取消结果

状态码说明

状态码描述
0 成功

API - 【旅游】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_tourism/travelOrderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceCode string 接口编码 空 必须
data object 业务数据 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调核心字段(含

状态码说明

状态码描述
0 成功

火车票(免登)

API - 【火车票免登】车站查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/stationList

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 车站列表(stationCode、stationName、stationPinYin、firstLetter、jianpin、stationCity)

状态码说明

状态码描述
0 成功

API - 【火车票免登】车次查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/trainList

请求参数

参数类型描述默认值是否必须
trainDate string 出发日期,格式 yyyy-MM-dd 空
fromStationName string 出发站名称,如武昌 空 必须
toStationName string 到达站名称,如汉口 空 必须
fromStationCode string 出发站编码,如 WCN,从 stationList
toStationCode string 到达站编码,如 HKN 空
ticketType int 票种类型,1-正常票 2-学生票 1

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 车次列表(含

状态码说明

状态码描述
0 成功

API - 【火车票免登】车次时刻列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/schedule

请求参数

参数类型描述默认值是否必须
trainDate string 出发日期,格式 yyyy-MM-dd 空
fromStationName string 出发站名称,如武昌 空 必须
toStationName string 到达站名称,如汉口 空 必须
fromStationCode string 出发站编码,如 WCN 空
toStationCode string 到达站编码,如 HKN 空
trainNo string 车次号,如 T182、D5792 空
trainCode string 车次内部编码,从 trainList 的

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 经停站列表(stationName、stationNo、startTime、stopTime、arriveTime、dayDiff)

状态码说明

状态码描述
0 成功

API - 【火车票免登】创建订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/createOrder

请求参数

参数类型描述默认值是否必须
uniqueId string 唯一标识 空 必须
partnerOrderNo string 合作方订单号 空 必须
trainNo string 车次编号 空 必须
fromStationCode string 出发站编码 空 必须
fromStationName string 出发站名称 空 必须
toStationCode string 到达站编码 空 必须
toStationName string 到达站名称 空 必须
fromTime string 出发时间 空 必须
toTime string 到达时间 空 必须
startDate string 出发日期 空 必须
acceptNoSeat bool 是否接受无座 空 必须
deadline string 支付截止时间 空 必须
contact string 联系人 空 必须
contactPhone string 联系人手机号 空 必须
orderPassengers string 乘客信息(数组或 JSON 字符串),元素为

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 创建结果(orderNo、partnerOrderNo

状态码说明

状态码描述
0 成功

API - 【火车票免登】取消订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/cancelOrder

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 取消结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】确认出票

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/issueTicket

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 出票确认结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】退票申请

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/refundTicket

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须
orderPassengers string 乘客信息,JSON数组 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 退票申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】改签申请

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/changeTicket

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须
changeDepartDate string 改签日期 空 必须
changeSeatName string 改签坐席名称 空 必须
changeTrainNo string 改签车次号 空 必须
changeToStationName string 改签到达站名称 空 必须
changeFromStationName string 改签出发站名称 空 必须
changeFromTime string 改签出发时刻 空 必须
changeToTime string 改签到达时刻 空 必须
orderPassengers string 乘客信息,JSON 数组 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 改签申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】改签确认

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/confirmChange

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 改签确认结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】订单详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/orderDetail

请求参数

参数类型描述默认值是否必须
orderNo string 平台订单号 空 必须
partnerOrderNo string 合作方订单号 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 订单详情(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】常用旅客-列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/passengerList

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.list array 旅客列表(camelCase

状态码说明

状态码描述
0 成功
其他 失败

API - 【火车票免登】常用旅客-新增

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/passengerAdd

请求参数

参数类型描述默认值是否必须
passengerName string 乘客姓名 空 必须
passengerPhone string 乘客手机号 空 必须
cardNumbers string 证件号码 空 必须
cardTypeCode string 证件类型编码,1身份证3港澳居民来往内地通行证4台湾居民来往大陆通行证5护照6外国人永久居留身份证7港澳台居民居住证 空 必须
passengerTypeCode string 乘客类型编码,1成人票2儿童票3学生票4残军 空 必须
passengerIndex string 常旅客ID 空 可选
ticketPrice number 票价 空 可选
seatInfoId string 座位信息ID,下单前通常需与车次坐席一并填写 空 可选
seatCode string 座位编码 空 可选
gender string 性别,MALE/FEMALE 空 可选
passengerEmail string 邮箱 空 可选
country string 国籍 空 可选
birthday string 出生日期 空 可选
expireDate string 证件有效期 空 可选
sortOrder number 排序,越小越靠前 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 含

状态码说明

状态码描述
0 成功
其他 失败

API - 【火车票免登】常用旅客-更新

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/passengerUpdate

请求参数

参数类型描述默认值是否必须
id number 记录id 空 必须
passengerName string 乘客姓名 空 可选
passengerPhone string 乘客手机号 空 可选
cardNumbers string 证件号码,变更时不可与同用户其他记录冲突 空 可选
cardTypeCode string 证件类型编码,与 passengerAdd 相同(1身份证3港澳居民来往内地通行证4台湾居民来往大陆通行证5护照6外国人永久居留身份证7港澳台居民居住证)
passengerTypeCode string 乘客类型编码,取值同新增(1成人票2儿童票3学生票4残军) 空 可选
passengerIndex string 常旅客ID 空 可选
ticketPrice number 票价,传空字符串可清空为 NULL 空
seatInfoId string 座位信息ID 空 可选
seatCode string 座位编码 空 可选
gender string 性别 空 可选
passengerEmail string 邮箱 空 可选
country string 国籍 空 可选
birthday string 出生日期 空 可选
expireDate string 证件有效期 空 可选
sortOrder number 排序 空 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.passenger object 更新后的旅客

状态码说明

状态码描述
0 成功
其他 失败

API - 【火车票免登】常用旅客-删除

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/passengerDelete

请求参数

参数类型描述默认值是否必须
id number 记录id 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 【火车票免登】订单状态回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/orderCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型,train_lite_interface 空 必须
interfaceCode string 接口编码,orderPush 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(含状态映射与

状态码说明

状态码描述
0 成功

API - 【火车票免登】申请开票

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/applyInvoice

请求参数

参数类型描述默认值是否必须
partnerApplyNo string 合作方申请单号 空 必须
invoicePriceType string 价格类型,取值 1/2/3 空
companyName string 公司/个人抬头 空 必须
companyCode string 税号 空 可选
titleType string 抬头类别,E1/E2 空 必须
passengerName string 旅客名称 空 必须
passengerCardNo string 证件号 空 必须
email string 邮箱 空 必须
cardTypeCode string 证件类型,1身份证3港澳居民来往内地通行证4台湾居民来往大陆通行证5护照6外国人永久居留身份证7港澳台居民居住证 空 必须
ticketSerialNo string 票号 空 必须
picture string 人脸图片 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 开票申请结果(以接口实际返回为准)

状态码说明

状态码描述
0 成功

API - 【火车票免登】开票结果回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_lyp_train/applyInvoiceCallBack

请求参数

参数类型描述默认值是否必须
tenantAppId string 租户编码 空 必须
timestamp string 时间戳(13位) 空 必须
nonceStr string 随机字符串 空 必须
signature string 签名 空 必须
interfaceTypeCode string 接口类型,train_lite_interface 空 必须
interfaceCode string 接口编码,invoicePush/applyInvoicePush/orderPush 空 必须
data object 回调业务体 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object 回调解析结果(applyNo、partnerApplyNo、applyStatus、fiInvoiceList)

状态码说明

状态码描述
0 成功

模式公共(法大大回调等)

API - 法大大协议签约异步回调

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_model/fdd_sign_callback

外部平台用户绑定登录

API - 钳智莱用户登录汇享多(服务端调用)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_partner/qzl_login

请求参数

参数类型描述默认值是否必须
ext_uid int 钳智莱用户id 无 必须
mobile string 钳智莱用户已验证手机号 无 必须
timestamp int 秒级时间戳,与服务器相差不超过300秒 无 必须
nonce string 随机串 无 必须
sign string hash_hmac('sha256', "ext_uid=..&mobile=..&nonce=..×tamp=..", secret)

返回参数

参数类型描述
data.token string 汇享多用户
data.hxdtoken string 请求头
data.uid int 汇享多用户id
data.phone string 汇享多手机号
data.created int 1=本次在汇享多新注册
data.bound_now int 1=本次新建绑定

状态码说明

状态码描述
0 成功

线下公共

API - 店铺列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/shoplist

请求参数

参数类型描述默认值是否必须
name string 名称搜索 空 必须
type string 类型搜索 0 必须
page number 页数20条固定 0 必须
name number 名称搜索 0 必须
longitude string 地址坐标 0 必须
latitude string 地址坐标 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 店铺详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/getshopid

请求参数

参数类型描述默认值是否必须
id string 店铺下单 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 店铺类别

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/gettype

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 二维码key查询门店与二维码信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/erwei_shopinfo

请求参数

参数类型描述默认值是否必须
key string 二维码或设备key 无 必须
type number 类型1二维码2设备 1 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 接口返回数据

状态码说明

状态码描述
0 成功
其他 失败

API - 收款二维码生成

请求方式: GET

请求地址:https://apply.buyql.com/index.php/api/Public_shop/erwei

请求参数

参数类型描述默认值是否必须
key string key 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 汇聚支付-创建线下订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderCreate

请求参数

参数类型描述默认值是否必须
amount number 订单总金额(元),须≥0.01,勿用 price 以免与活动
name string 商品或订单标题 无 非必须
shop_id number 店铺id 0 必须(平台收款须指定门店以关联二级商户)
erwei_id number 收款二维码 shop_erwei.id 无
key string 收款二维码 key(与 erwei_shopinfo

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 接口返回数据

状态码说明

状态码描述
0 成功
其他 失败

API - 汇聚支付-支付前算价

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderJsprice

请求参数

参数类型描述默认值是否必须
order_id number 本地订单 id 无
pay_key string 创建订单返回的密钥 无 必须

状态码说明

状态码描述
0 成功

API - 汇聚支付-查询支付结果

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderPayStatus

请求参数

参数类型描述默认值是否必须
order_id number 本地订单 id 无
pay_key string 创建订单返回的密钥 无 必须

返回参数

参数类型描述
data.zt int 0
data.pay_done bool 是否已整单完成支付(与
data.pay_status string 简码:unpaid/await_cash/cancelled/paid
data.jf_zt int 线下:本地已扣款
data.xj_zt int 线下:第三方现金已到账
data.order array 订单主表
data.order_in array id、msg(已解析

状态码说明

状态码描述
0 成功

API - 汇聚支付-汇聚订单查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderJoinpayQuery

请求参数

参数类型描述默认值是否必须
order_id number 本地订单 id 无
pay_key string 无 必须

返回参数

参数类型描述
data.joinpay_verify_ok bool 应答
data.joinpay_paid bool ra_Status
data.joinpay_response array|null 汇聚

状态码说明

状态码描述
0 成功(含未发起过
其他 查单异常

API - 汇聚支付-取消线下待支付订单

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderCancel

请求参数

参数类型描述默认值是否必须
order_id number 本地订单id 无 必须
pay_key string 创建订单返回的密钥 无 必须

状态码说明

状态码描述
0 成功

API - 汇聚支付-发起

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huiju_payOrderPay

请求参数

参数类型描述默认值是否必须
order_id number 本地订单id 无 必须
pay_key string 创建订单返回的密钥 无 必须
xj number 现金/第三方金额(元),缺省按 0 0
ye number 余额 0 非必须
dkq number 抵扣券 0 非必须
yhq number 消费金 0 非必须
token string 使用余额/抵扣券/消费金时必填(POST 或 HXDTOKEN);可先调
q1_FrpCode string 支付通道 **仅 xj(现金)>0
p8_ReturnUrl string 同步跳转 **仅 xj>0
q4_IsShowPic string 主扫传 1 则额外返回二维码图片
qk_DisablePayModel string 禁用支付方式(可选,仅云闪付除聚分期外可用,如 no_credit 禁用信用卡)
qm_ContractId string 无感支付签约ID(可选,仅 UNIONPAY_WXMP)
qj_DJPlan string 点金计划配置 JSON(可选,传了则透传给汇聚,见文档 7.5.7)
wx_code string 微信网页授权 code(后端自动换取公众号 openid,不再需要前端传
q5_OpenId string 微信 openid(可选,传了则直接用,不传时用 wx_code
q7_AppId string 微信/支付宝 appid(可选;ALIPAY_FWC 不传则用
alipay_code string 支付宝服务窗授权 code(ALIPAY_FWC 时后端换
qb_buyerId string 支付宝买家 user_id(可选,已换好则可直接传,不再用 code)

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 接口返回数据

状态码说明

状态码描述
0 成功
其他 失败

API - 微信APP支付-异步通知(线下)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/wxAppPayNotify

API - 汇聚支付-异步通知

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huijuPayNotify

状态码说明

状态码描述
0 成功(响应体
其他 失败(响应体

API - 汇聚二级商户-异步通知(回查

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huijuAltFundsNotify

API - 微信内容安全检测(测试用)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/wxSecCheck

请求参数

参数类型描述默认值是否必须
type string 检测类型:text=文字 image=图片
content string type=text 时传,待检测文本
file media

状态码说明

状态码描述
0 内容安全
其他 包含敏感内容

API - 微信JS-SDK签名配置

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/wxConfig

请求参数

参数类型描述默认值是否必须
url string 当前页面完整URL(不含#及其后部分) 必须

返回参数

参数类型描述
appId string 公众号唯一标识
timestamp int 时间戳
nonceStr string 随机串
signature string 签名
jsApiList array JS接口列表

状态码说明

状态码描述
0 成功
其他 失败

API - 汇聚分账-异步通知

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/huijuFzNotify

API - 京东秒送_订单状态回调接收

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_shop/jdms_order_callback

状态码说明

状态码描述
0 ok
其他 fail

用户公共

API - 单个用户所有可领取

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/cardlist

请求参数

参数类型描述默认值是否必须
uid int 用户id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 密码登录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/login_password

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须
password string 登录密码 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 商务宝密码登录(业务员)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/login_password_swbb

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须
password string 登录密码 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data object token/img/levels/levelsname/access_via(levels|platform_agent|brand_agent)

状态码说明

状态码描述
0 成功
其他 失败

API - 获取验证码[找回登录密码]

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/zlogin_code

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 找回登录密码

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/update_login

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须
code int 验证码 无 必须
password string 新登录密码 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 微信小程序一键注册登录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/reglogin

请求参数

参数类型描述默认值是否必须
pid int 推荐人用户id 0 必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 支付宝小程序一键注册登录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/alipay_reglogin

请求参数

参数类型描述默认值是否必须
response string 手机号授权密文(getPhoneNumber) 空 必须
sign string 密文签名 空 必须
pid int 推荐人用户id 0 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.token string 用户

状态码说明

状态码描述
0 成功
其他 失败

API - 用户导入(模拟注册并强制绑定推荐人)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/user_import

请求参数

参数类型描述默认值是否必须
phone string 注册手机号 无 必须
tj_phone string 推荐人手机号 无 必须
password string 登录密码(仅新注册时写入,默认111111) 无 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data.token array 用户
data.id int 用户
data.created int 是否新注册:1
data.pid int 推荐人用户
data.pids string 推荐链

状态码说明

状态码描述
0 成功
其他 失败

API - 获取验证码

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/codes

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 验证码、注册/登录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/getuser

请求参数

参数类型描述默认值是否必须
phone int 用户手机号 无 必须
code int 验证码 无 必须
pid string 推荐人id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 获取数据token

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/getkeytoken

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 根据id获取账户信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/getphone

请求参数

参数类型描述默认值是否必须
id string 用户id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 激励视频广告完成回调

请求方式: GET

请求地址:https://apply.buyql.com/index.php/api/Public_user/ad_reward_callback

请求参数

参数类型描述默认值是否必须
adpid string 广告位ID 无 必须
platform string 平台(android/ios/weixin等) 无 必须
provider string 渠道(china/google等) 无 必须
trans_id string 广告平台返回的订单/流水号 无 必须
user_id string 前端透传的用户ID 无 必须
extra string 前端透传的扩展参数(如任务ID等) 无 非必须
sign string uni-ad 回调签名 无

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 返回包含uid及广告相关信息,后续逻辑由业务自行处理

状态码说明

状态码描述
0 回调验证成功,允许发放奖励
100 参数错误或签名失败

API - 赠送合伙人资格-可选地址范围(匹配

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/partner_gift_tier_address_scope

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
partner_gift_id int 赠送记录id(model_partner_gift.id,须为待领取) 无 必须
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选
province_id int 省 address.id(deep=0) 空
city_id int 市 address.id(deep=1) 空
district_id int 区/县 address.id(deep=2) 空
street_id int 街道/乡镇 address.id(deep=3) 空
address_id int 任意一级 address.id(与上面四级二选一,取最深) 空
keyword string 地址名称关键词(亦可用 name) 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.gift object 赠送资格摘要
data.address_scope object 地址级联选择范围(与
data.filter object 本次生效的搜索条件回显
data.regions array 当前页区域列表(含
data.page int 当前页
data.limit int 每页条数
data.total int 总条数
num int 总条数(与

状态码说明

状态码描述
0 成功
1024 未登录
100 参数或业务失败

API - 赠送合伙人资格-解析档位

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/partner_gift_resolve_agent_tier_id

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
partner_gift_id int 赠送记录 id(model_partner_gift.id) 无
address_id int 用户选中的地址 id(address.id,层级须与赠送区域一致) 无

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.agent_tier_id int 匹配的
data.gift object 赠送资格摘要
data.address object 选中地址
data.tier object 档位及余席信息

状态码说明

状态码描述
0 成功
1024 未登录
100 参数或业务失败

API - 领取合伙人席位申请资格(生成

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_user/agent_partner_seat_apply

请求参数

参数类型描述默认值是否必须
agent_tier_id int 独家档位id(agent_exclusive_tier.id) 无 必须
partner_gift_id int 赠送资格id(model_partner_gift.id,建议传入) 无 可选
brand_id int 品牌id 0 可选(品牌策略时传)
force_new int 传1时不复用同档位待支付单 0 可选

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.order_id array 申请单
data.reused int 是否复用已有待支付单:1

状态码说明

状态码描述
0 成功
1024 未登录
100 参数或业务失败

云分账公共

API - 云分账-异步通知

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Public_yunfz/yunFzNotify

实体店

API - 实体店铺激活

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/addshop

请求参数

参数类型描述默认值是否必须
msg string 店铺说明、主营经营信息 空 必须
phone number 联系手机 0 必须
address number 详细地址 0 必须
lon number 地址坐标 0 必须
lat string 地址坐标 0 必须
tj string 推荐人手机 0 非必须
type string 店铺类型三级用-隔开拼接 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 实体店商家后台账号创建或修改

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/merchant_account_save

请求参数

参数类型描述默认值是否必须
account string 登录账号(数字字母) 空 必须
password string 登录密码 空 条件必填(首次创建必填;已存在时不传则不改密码,传则修改且不少于6位)
name string 账号名称 空 非必须
phone string 手机号 空 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object merchant_user_id、shop_id、account(不含密码)

状态码说明

状态码描述
0 成功
其他 失败

API - 获取实体店商家后台账号信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/merchant_account_info

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data object shop_id、has_merchant_account;若已创建含

状态码说明

状态码描述
0 成功
其他 失败

API - 实体店铺修改

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/updateshop

请求参数

参数类型描述默认值是否必须
msg string 店铺说明、主营经营信息 空 必须
phone number 联系手机 0 必须
address number 详细地址 0 必须
lon number 地址坐标 0 必须
lat string 地址坐标 0 必须
tj string 推荐人手机、没有推荐可改 0 非必须
type string 店铺类型三级用-隔开拼接 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 添加店铺照片

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/addimg

请求参数

参数类型描述默认值是否必须
img string 图片 空 必须
x number 序号 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 修改店铺照片

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/updateimg

请求参数

参数类型描述默认值是否必须
img string 图片 空 必须
x number 序号 0 必须
id number 数据id 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 删除店铺照片

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/delimg

请求参数

参数类型描述默认值是否必须
id number 数据id 0 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 生成二维码key

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/adderiweikey

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 二维码、设备列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/erweilist

请求参数

参数类型描述默认值是否必须
type number 类型1二维码2设备 1 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 添加二维码、设备

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/adderwei

请求参数

参数类型描述默认值是否必须
key string 二维码key 空 非必须
type number 类型1二维码2设备 1 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 绑定、取消绑定设备

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/addeaudio

请求参数

参数类型描述默认值是否必须
auid number 设备id 空 必须
id number 二维码id 空 非必须
type number 1绑定2删除绑定 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 二维码、设备已绑定列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/erweiaudio

请求参数

参数类型描述默认值是否必须
auid number 二维码、设备 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 修改二维码参数

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/erweiupdate

请求参数

参数类型描述默认值是否必须
id number 数据id 空 必须
rl number 让利5~30 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 删除二维码、设备

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/erweidel

请求参数

参数类型描述默认值是否必须
id number 数据id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 播报设备连接测试

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop/testaudio

请求参数

参数类型描述默认值是否必须
id number 数据id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

线下支付

API - 身份证正面识别读取信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay/shenfenzhengzhengmian

请求参数

参数类型描述默认值是否必须
image string 正面图片 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 身份证反面识别读取信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay/shenfenzhengfanmian

请求参数

参数类型描述默认值是否必须
image string 反面图片 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 营业执照识别读取信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay/yingyezhizhao

请求参数

参数类型描述默认值是否必须
image string 反面图片 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

汇聚进件与签约

API - 汇聚二级商户添加

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchCreate

请求参数

参数类型描述默认值是否必须
token string token 空 必须
alt_mch_name string 商户全称 无 必须
alt_mch_short_name string 商户简称 无 非必须
alt_merchant_type string 商户类型(非负整数,与汇聚 JSON number
login_name string 登录账号 无 非必须
bussiness_type string 业务类型 无 非必须
busi_contact_name string 联系人姓名 无 必须
busi_contact_mobile_no string 联系人手机号 无 必须
province string 省 无 非必须
city string 市 无 非必须
county string 区县 无 非必须
manage_scope string 经营范围 无 非必须
manage_addr string 经营地址 无 非必须
legal_person string 法人姓名 无 必须
phone_no string 法人手机号 无 必须
id_card_no string 法人身份证号 无 必须
id_card_valid_time_begin string 身份证开始日期(可多种写法;默认规范为 yyyy-MM-dd,[huiju] id_card_date_format=Ymd
id_card_valid_time_end string 身份证结束日期(同上;长期可传 长期)无 非必须
id_doc_copy string 身份证图片mediaId 无 非必须
id_card_national string 法人身份证国徽页照片fileId 无 非必须
id_career string 职业代码(非负整数,与汇聚 JSON number
beneficiary_owner string 实际受益人 无 非必须
signer_name string 签署人姓名 无 非必须(与下列三项须同时传或同时不传;不传则汇聚默认法人签署)
signer_phone string 签署人手机号 无 非必须
signer_card_type string 签署人证件类型 无 非必须
signer_card_id string 签署人证件编号 无 非必须
license_no string 营业执照号 无 非必须
license_expiry string 营业执照到期日 无 非必须
trade_licence string 贸易许可证mediaId 无 非必须
special_licence_one string 特殊许可证一mediaId 无 非必须
special_licence_two string 特殊许可证二mediaId 无 非必须
sett_mode string 结算方式 无 非必须
sett_date_type string 结算日期类型 无 非必须
risk_day string 风险延迟天数 无 非必须
bank_account_type string 结算卡类型 无 必须
bank_account_name string 结算卡户名 无 必须
bank_account_no string 结算卡号 无 必须
bank_channel_no string 开户行联行号 无 非必须
open_account_licence string 开户许可证mediaId 无 非必须
beneficiary_name string 受益人姓名 无 非必须
beneficiary_no string 受益人证件号 无 非必须
beneficiary_type string 受益人类型 无 非必须
beneficiary_time_begin string 受益人开始日期 无 非必须
beneficiary_time_end string 受益人结束日期 无 非必须
beneficiary_address string 受益人地址 无 非必须
sales_mini_name string 小程序名称 无 非必须
sales_mini_compic string 小程序封面mediaId 无 非必须
sales_mini_authpic string 小程序认证图片mediaId 无 非必须
sales_door_photo string 门店门头照mediaId 无 非必须
sales_environment_photo string 门店环境照mediaId 无 非必须
sales_co_agreement string 合作协议文件mediaId 无 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功(汇聚同步
100 失败(汇聚非
1023 未登录

API - 汇聚二级商户修改

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchModify

请求参数

参数类型描述默认值是否必须
token string token 空 必须
alt_mch_no string 二级商户号 无 必须
notify_url string 异步通知地址 无 非必须(不传则默认与进件
alt_mch_name string 商户全称 无 非必须
busi_contact_name string 联系人姓名 无 非必须
busi_contact_mobile_no string 联系人手机号 无 非必须
legal_person string 法人姓名 无 非必须
phone_no string 法人手机号 无 非必须
id_card_no string 法人身份证号 无 非必须
id_card_valid_time_begin string 身份证开始日期(可多种写法;默认规范为 yyyy-MM-dd,[huiju] id_card_date_format=Ymd
id_card_valid_time_end string 身份证结束日期(同上;长期可传 长期)无 非必须
id_doc_copy string 身份证图片mediaId 无 非必须
id_card_national string 法人身份证国徽页照片fileId 无 非必须
id_career string 职业代码(非负整数,与汇聚 JSON number
beneficiary_owner string 实际受益人 无 非必须
license_no string 营业执照号 无 非必须
license_expiry string 营业执照到期日 无 非必须
trade_licence string 贸易许可证mediaId 无 非必须
special_licence_one string 特殊许可证一mediaId 无 非必须
special_licence_two string 特殊许可证二mediaId 无 非必须
sett_mode string 结算方式 无 非必须
sett_date_type string 结算日期类型 无 非必须
risk_day string 风险延迟天数 无 非必须
bank_account_type string 结算卡类型 无 非必须
bank_account_name string 结算卡户名 无 非必须
bank_account_no string 结算卡号 无 非必须
bank_channel_no string 开户行联行号 无 非必须
open_account_licence string 开户许可证mediaId 无 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚二级商户查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchQuery

请求参数

参数类型描述默认值是否必须
token string token 空 必须
mch_order_no string 商户订单号 无 非必须
alt_mch_no string 二级商户号 无 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚二级商户图片上传

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchPicUpload

请求参数

参数类型描述默认值是否必须
token string token 空 必须
img_base64 string 图片 base64 无

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚二级商户签约创建

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchSignCreate

请求参数

参数类型描述默认值是否必须
token string token 空 必须
alt_mch_no string 二级商户号 无 必须
contract_type string 协议类型 无 非必须
signer_name string 签署人姓名 无 必须
signer_phone string 签署人手机号 无 必须
signer_card_type string 签署人证件类型 无 必须
signer_card_id string 签署人证件编号 无 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚二级商户签约撤销

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchSignRevoke

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚二级商户签约查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_secondaryMchSignQuery

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚分账方账户余额查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_altAccountGet

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚分账方结算查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_altSettleGet

请求参数

参数类型描述默认值是否必须
token string token 空 必须
mch_order_no string 结算订单号 无 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚自动结算查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_altSettleGetAutoSettle

请求参数

参数类型描述默认值是否必须
token string token 空 必须
settle_date string 结算日期 yyyy-mm-dd 无

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚返回(已脱敏

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚手工提现(结算到银行卡)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_altSettleLaunch

请求参数

参数类型描述默认值是否必须
token string token 空 必须
settle_amount string 结算金额(元,保留两位小数,必须大于0) 空 必须
mch_order_no string 商户结算单号(16~32位,仅英文字母/数字/下划线) 自动生成 不必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 汇聚同步返回(biz_code、biz_msg、mch_order_no)

状态码说明

状态码描述
0 受理成功(需继续查询到账状态)
100 失败(汇聚拒绝或参数错误,见
1023 未登录

API - 商家线下交易订单列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/offlineOrderList

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页码 1 不必须
limit int 每页条数(最大100) 20 不必须
zt int 订单状态筛选(0待支付 1已支付 2已完成
start_date string 开始日期(yyyy-mm-dd,对应下单时间) 空 不必须
end_date string 结束日期(yyyy-mm-dd,含当天) 空 不必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.list array 订单列表(id/price/xj/price_rl/zt/time/time_zf/fz_num/fz_ynum/fz_snum/fz_sxf/fz_rl/fz_orderid)
data.total int 符合条件的总条数
data.page int 当前页码
data.limit int 每页条数

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 订单分账明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/orderFzDetail

请求参数

参数类型描述默认值是否必须
token string token 空 必须
order_id int 订单ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.order array 订单基本信息(id/price/xj/price_rl/zt/time/time_zf)
data.fz array|null 分账汇总(num/ynum/sxf/snum/rl/orderid),无分账记录时为
data.logs array 分账流水列表(id/num/lsid/zt/zt_text/sid/time/alt_main_status/biz_msg)

状态码说明

状态码描述
0 成功
100 失败(订单不存在/无权访问)
1023 未登录

API - 汇聚报备图片上传

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingPicUpload

请求参数

参数类型描述默认值是否必须
token string token 空 必须
img_base64 string 图片 base64 无

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚报备商户录入并报备

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingMchApply

请求参数

参数类型描述默认值是否必须
token string token 空 必须
full_name string 商户全称 无 必须
short_name string 商户简称 无 必须
service_phone string 客服电话 无 必须
category string 行业类别 无 必须
address string 经营地址 无 必须
province string 省编码 无 必须
city string 市编码 无 必须
county string 区县编码 无 必须
merchant_type string 主体类型 无 必须
legal_person_cem_type string 法人证件类型 无 必须
legal_person_name string 法人姓名 无 必须
legal_person_cem_num string 法人证件号 无 必须
legal_person_valid_date string 法人证件有效期 JSON 无
id_nomal_pic string 身份证人像面 image_id 无
id_reverse_pic string 身份证国徽面 image_id 无
contact_name string 联系人 无 必须
contact_mobile string 联系人手机 无 必须
contact_certfiticate_num string 联系人证件号 无 必须
contact_certfiticate_type string 联系人证件类型 无 必须
contact_valid_date string 联系人证件有效期 JSON 无
card_num string 结算卡号 无 必须
user_name string 结算户名 无 必须
card_num_type string 结算卡类型 0个人1对公 无
use_scenes string 商户属性 2 非必须
product_code string 报备产品 wxpay,alipay 非必须

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚报备商户结果查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingMchQuery

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚报备商户信息修改

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingMchModify

请求参数

参数类型描述默认值是否必须
token string token 空 必须
merchant_type string 主体类型 无 必须
short_name string 商户简称 无 非必须
service_phone string 客服电话 无 非必须
address string 经营地址 无 非必须
province string 省编码 无 非必须
city string 市编码 无 非必须
county string 区县编码 无 非必须

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚报备产品报备

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingProductApply

请求参数

参数类型描述默认值是否必须
token string token 空 必须
product_code string 产品编码 wxpay /

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚报备终端信息采集

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingTerminalCollect

请求参数

参数类型描述默认值是否必须
token string token 空 必须
operation_id string 操作标识 00新增 02注销
product_code string 产品 wxpay,alipay 默认
terminal_serial_num string 终端序列号 无 非必须
terminal_no string 终端设备号 无 非必须
terminal_type string 终端类型 无 非必须
terminal_address string 布放地址 无 非必须

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚微信特约-配置子商户

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingWeixinApplyAppid

请求参数

参数类型描述默认值是否必须
token string token 空 必须
sub_appid string 子 APPID(公众号/小程序/APP 支付
notify_url string appid 审核回调地址 无

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚微信特约-配置支付授权目录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingWeixinApplyJsapiPath

请求参数

参数类型描述默认值是否必须
token string token 空 必须
jsapi_path string JSAPI 支付授权目录 无

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 汇聚微信特约-配置查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_palay_msg/huiju_filingWeixinQuery

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

云分账账户

API - 云分账账户-查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_yunfz/yunfz_account_get

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 账户与结算模式
data.settle_mode string yunfz|huiju|none
data.enabled int 是否启用云分账
data.account_no string 卡号
data.account_name string 户名
data.account_type string 1对公
data.branch_code string 支行联行号
data.receiver_bank_code string 总行编码
data.bank_name string 开户行
data.tax_rate string 税率小数

状态码说明

状态码描述
0 成功
100 失败
1024 身份验证失败

API - 云分账账户-保存(进件可选绑卡)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_yunfz/yunfz_account_save

请求参数

参数类型描述默认值是否必须
token string token 空 必须
enabled int 1启用云分账 0关闭 1
account_no string 收款银行卡号 无 enabled=1时必须(兼容别名
account_name string 开户名 无 enabled=1时必须(兼容别名
account_type string 1对公 2对私 2
branch_code string 支行联行号 无 对公必须(兼容别名
receiver_bank_code string 总行编码如 ICBC/CCB 无
bank_name string 开户行名称 无 enabled=1时必须
tax_rate string 税率小数如 0.0600 空

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 账户与结算模式

状态码说明

状态码描述
0 成功
100 失败
1024 身份验证失败

API - 云分账-按日结算查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_yunfz/yunfz_settle_day

请求参数

参数类型描述默认值是否必须
token string token 空 必须
settle_date string 结算日期 yyyy-mm-dd 无

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.settle_date string 查询日期
data.settle_count int 成功结算笔数
data.settle_amount string 成功结算总额(税前应分合计)
data.pay_amount string 成功实际到账合计(扣税后)
data.tax_amount string 成功扣税合计
data.account array 本店收款账户摘要(脱敏卡号)
data.list array 当日流水明细

状态码说明

状态码描述
0 成功
100 失败
1024 身份验证失败

API - 云分账-订单代付明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Shop_yunfz/yunfz_order_detail

请求参数

参数类型描述默认值是否必须
token string token 空 必须
order_id int 订单ID 空 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.order array 订单基本信息
data.fz array|null 分账池摘要,无则
data.logs array 云分账代付流水
data.settle_mode string 当前店结算模式

状态码说明

状态码描述
0 成功
100 失败(订单不存在/无权访问)
1024 身份验证失败

补贴

API - 贡献凭证明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/doudetail

请求参数

参数类型描述默认值是否必须
id number 数据id筛选多个,隔开 空 非必须
page number 页数 空 必须
limit number 条数 空 必须
type number 类型 空 非必须
class number 所属板块 空 非必须
class_group string 板块组 online=线上交易(3/4/5/6/7/20-29) 空
time_start string 开始时间时间戳 空 非必须
time_end string 结束时间时间戳 空 非必须
time_sort string 按时间排序 asc=旧到新 desc=新到旧
sort string 按积分 jf 排序

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据;每条含
count int 合并收入+扣减后的总条数(分页用)

状态码说明

状态码描述
0成功
其他 失败

API - 贡献凭证类型、板块

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/doutype

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 贡献凭证不同类型总数量

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/douStatistics

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 消费总数据_类型汇总

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/dou_type_sum

返回参数

参数类型描述
data.total string 累计消费数据(jf×倍率
data.total_gross string 累计获得(jf×倍率,未扣减)
data.deduct_total string 扣减合计(fh_sum
data.dou string 当期可用消费数据
data.hongbao_total string 红包合计(已释放
data.types array 消费/店主/推广/公司/历史:jf=数据
data.filters array 明细筛选项(给底部

状态码说明

状态码描述
0 成功

API - 贡献凭证补贴明细(按日期)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/quanList

请求参数

参数类型描述默认值是否必须
page number 页数 空 必须
limit number 条数 空 必须
time_start string 开始时间时间戳 空 非必须
time_end string 结束时间时间戳 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 贡献凭证补贴明细(单笔积分)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/quanDetails

请求参数

参数类型描述默认值是否必须
id number 共享凭证数据id 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 红包未领取数据

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/rldata

请求参数

参数类型描述默认值是否必须
limit number 获取条数 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 红包已经领取数据(记录)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/rldatalist

请求参数

参数类型描述默认值是否必须
page number 页数每页固定20条 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

API - 赠送红包一键领取/单个

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Subsidy/rldatalq

请求参数

参数类型描述默认值是否必须
id int 数据id单个领取时候传 空 非必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0成功
其他 失败

商务宝(业务员)

API - 商务宝_获取数据token

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/getkeytoken

请求参数

参数类型描述默认值是否必须
token string 用户登录 token 无

返回参数

参数类型描述
data string 加密后的

状态码说明

状态码描述
0 成功
1023 token
1000 账号状态异常
100 无商务级别/平台代理/品牌代理

API - 商务宝_文件上传

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/upfile

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
file file 图片文件 无 必须

状态码说明

状态码描述
0 成功
1024 未登录
100 非业务员或上传失败

API - 商务宝_修改登录密码

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/update_password

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
passwordy string 原登录密码 无 否(仍为默认占位密码111111时可不传)
password string 新登录密码 无 必须
password_confirm string 确认新密码 无 必须

返回参数

参数类型描述
data.token object 新令牌(修改后需更新本地登录态)

状态码说明

状态码描述
0 成功
100 参数或业务失败

API - 商务宝_商务部部门列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/dept_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
keywords string 城市名称关键词 空 非必须

返回参数

参数类型描述
data array 可选城市及部门名称

状态码说明

状态码描述
0 成功

API - 商务宝_选择部门生成工号

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/work_no_generate

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
dept_city_id int 城市 address.id(deep=1) 无
save int 是否落库 1 非必须(默认0仅预览;1则写入

返回参数

参数类型描述
data.work_no string 工号(城市区划6位+uid6位)
data.department string 部门名称(如南京市商务部)

状态码说明

状态码描述
0 成功

API - 商务宝_个人名片信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/user_card_info

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

返回参数

参数类型描述
data.name string 姓名
data.work_no string 工号
data.department string 部门
data.account string 账号(手机号)

状态码说明

状态码描述
0 成功

API - 商务宝_当前登录用户信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/user_info

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

返回参数

参数类型描述
data.name string 姓名
data.work_no string 工号
data.department string 部门
data.account string 账号(手机号)
data.phone string 手机号
data.levels int 商务等级id
data.levels_name string 商务等级名称
data.img_url string 头像地址
data.nickname string 昵称(user.name,与实名姓名独立)
data.realname_status int 实名状态
data.bank_bound int 是否已绑银行卡
data.login_password_set int 是否已设置登录密码(非初始111111)

状态码说明

状态码描述
0 成功

API - 商务宝_修改昵称与头像

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/user_profile_update

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
nickname string 昵称 无 非必须(与
img string 头像 Minio 相对路径或完整

返回参数

参数类型描述
data.nickname string 昵称
data.img string 头像相对路径
data.img_url string 头像完整

状态码说明

状态码描述
0 成功
100 参数或业务失败

API - 商务宝_实名认证信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/realname_info

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

返回参数

参数类型描述
data object 实名信息;未提交时各字段为空、status=-1

状态码说明

状态码描述
0 成功

API - 商务宝_提交实名认证(商务申请)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/realname_submit

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
id_card_front string 身份证人像页路径 无 必须
id_card_back string 身份证国徽页路径 无 必须
name string 姓名 无 必须
sex string 性别(先生/女士) 无 必须
birthday string 出生年月(yyyy-MM 或 yyyy-MM-dd)
nation string 民族 无 必须
region_address string 地区id链(如320000,320200000000) 无 必须(与
address1 int 省id 无 非必须
address2 int 市id 无 非必须
address3 int 区id 无 非必须
address4 int 街道id 无 非必须
address_detail string 详细地址 无 必须
id_card_no string 身份证号码 无 必须
dept_city_id int 商务部城市 address.id 无

状态码说明

状态码描述
0 成功
100 参数或业务失败

API - 商务宝_银行卡信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/bank_info

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

状态码说明

状态码描述
0 成功

API - 商务宝_绑定/修改银行卡

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/bank_save

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
card_front string 银行卡正面路径 无 必须
card_back string 银行卡背面路径 无 必须
card_no string 银行卡号 无 必须
bank_name string 银行名称 无 必须
bank_branch string 开户行名称 无 必须

状态码说明

状态码描述
0 成功

API - 商务宝_提交店铺拜访信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/visit_submit

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
visit_time string 拜访时间(yyyy-MM-dd HH:mm:ss) 无
shop_name string 拜访店铺名称 无 必须
entry_status int 进件状态:0未进件 1已进件 无
companions string 随行商务 JSON 数组或逗号分隔(姓名/工号)
visit_result string 拜访结果及过程 无 必须

状态码说明

状态码描述
0 成功

API - 商务宝_店铺拜访列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/visit_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选
shop_name string 店铺名称模糊搜索 空 可选
stat_month string 月份 YYYY-MM 空

状态码说明

状态码描述
0 成功

API - 商务宝_店铺拜访详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/visit_detail

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
id int 拜访记录id 无 必须

状态码说明

状态码描述
0 成功

API - 商务宝_无人服务商家列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_unserved_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选
keywords string 店铺名称关键词 空 可选

返回参数

参数类型描述
data array 可认领商家列表(shop.pid=0,店主在本人推荐链路内,且店主直属推荐人无商务等级)

状态码说明

状态码描述
0 成功

API - 商务宝_认领无人服务商家

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_claim

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
shop_id int 店铺id 无 必须

状态码说明

状态码描述
0 成功

API - 商务宝_绩效规则配置(只读)

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/perf_config_info

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

API - 商务宝_生成绩效测试种子数据

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/perf_test_seed

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空
uid int 目标商务uid 空 非必须(默认当前登录用户;仅

状态码说明

状态码描述
0 成功
100 失败或非测试环境

API - 商务宝_清除绩效测试种子数据

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/perf_test_seed_clean

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
uid int 目标商务uid 空 非必须(默认当前登录用户;仅

状态码说明

状态码描述
0 成功
100 失败或非测试环境

API - 商务宝_我的月度绩效

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/perf_my_month

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空

API - 商务宝_商务职位标准列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/levels_standard

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

API - 商务宝_目标管理总览

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/target_dashboard

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 统计月份 YYYY-MM 空

返回参数

参数类型描述
data.user object 姓名/部门/等级
data.metrics array 个人业绩、团队业绩、活跃商家、团队成员(目标值/当前值/达成率)

状态码说明

状态码描述
0 成功

API - 商务宝_历史店铺业绩趋势

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/target_trend

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
days int 近N日 7 非必须(3~31,默认7)

返回参数

参数类型描述
data.series array 按日个人/团队让利
data.personal_total string 个人累计
data.team_total string 团队累计

状态码说明

状态码描述
0 成功

API - 商务宝_团队内个人直推月业绩排行

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/target_direct_rank

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空
limit int 条数 50 非必须

状态码说明

状态码描述
0 成功

API - 商务宝_商务部团队月业绩排行

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/target_team_rank

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空
limit int 条数 50 非必须
city string 城市筛选 空 非必须(默认取本人实名/地址城市)

状态码说明

状态码描述
0 成功

API - 商务宝_商务部个人月业绩排行

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/target_personal_rank

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空
limit int 条数 50 非必须
city string 城市筛选 空 非必须(默认取本人实名/地址城市)

状态码说明

状态码描述
0 成功

API - 商务宝_店铺管理首页

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_manage_home

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 统计月份 YYYY-MM 空

返回参数

参数类型描述
data.shop object 店铺总数/月活跃数/活跃占比
data.entry_month object 本月进件(个人)
data.visit_month object 月拜访总数/首次拜访/服务商家数

状态码说明

状态码描述
0 成功

API - 商务宝_关联店铺列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_linked_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选
keywords string 店铺名称关键词 空 可选
period string 让利统计区间 month/week/today 空
shop_filter string 店铺筛选 all/active/new 空

状态码说明

状态码描述
0 成功

API - 商务宝_省市区街道列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/addressListcy

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
type int 级数:1省、2市、3区县、4街道 空 必须
pid int 上级地址 id(type>1 时必传)

返回参数

参数类型描述
data array 地址列表(address

状态码说明

状态码描述
0 成功

API - 商务宝_代理区域席位查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/agent_region_seat_query

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
province_id int 省 address.id(deep=0) 空
city_id int 市 address.id(deep=1) 空
district_id int 区/县address.id(deep=2) 空 非必须(亦可用
street_id int 街道 address.id(deep=3) 空
address_id int 区域 address.id 空
strategy_type int 策略类型 0区策略/1品牌策略 空
brand_id int 品牌 id 空

返回参数

参数类型描述
data.agent object 区域服务概况(零售总额、架构人数等)
data.seat_summary object 席位合计
data.seat_list array 各席位类型占用与未认领(agent_partners_config
data.strategy_list array 区域全部策略档位扁平列表(按
data.seat_list[].tiers[].agent_amount_config_id int 金额配置模板
data.seat_list[].tiers[].agent_amount_config_name string 金额配置名称
data.seat_list[].tiers[].config_standard_amount string 配置标准费用(分)
data.seat_list[].tiers[].config_standard_amount_display string 配置标准费用展示(万/元)
data.seat_list[].tiers[].config_discounted_amount string 配置折后费用(分)
data.seat_list[].tiers[].config_discounted_amount_display string 配置折后费用展示
data.seat_list[].tiers[].config_proportion string 配置分润比例

状态码说明

状态码描述
0 成功

API - 商务宝_街道公司营业执照列表(首席GP/联席LP

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/street_company_list

请求参数

参数类型描述默认值是否必须
page int 页码 空 必须
limit int 每页 空 必须
status int 0待补充1已补充 空 非必须

返回参数

参数类型描述
data.list array 公司列表
data.count int 总数

状态码说明

状态码描述
0 成功

API - 商务宝_街道公司营业执照详情

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/street_company_get

请求参数

参数类型描述默认值是否必须
address_id int 街道 address.id 空

状态码说明

状态码描述
0 成功

API - 商务宝_街道公司营业执照补填

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/street_company_save

请求参数

参数类型描述默认值是否必须
address_id int 街道 address.id 空
company_name string 公司名称 空 必须
contact_name string 联系人 空 必须
phone string 电话 空 必须
email string 邮箱 空 非必须
company_address string 公司地址 空 非必须(齐全则标已补充)
id_name string 身份姓名 空 非必须
id_no string 证件号 空 非必须
license_no string 执照号 空 非必须
license_pic string 执照图(上传后路径) 空 非必须

状态码说明

状态码描述
0 成功

API - 商务宝_品牌下拉列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/brand_select_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选
keywords string 品牌名称/编码关键词 空 非必须(亦可用
province_id int 省 address.id(deep=0) 空
city_id int 市 address.id(deep=1) 空
district_id int 区/县 address.id(deep=2) 空
street_id int 街道 address.id(deep=3) 空
address_id int 区域 address.id 空

返回参数

参数类型描述
data array 品牌项列表

状态码说明

状态码描述
0 成功

API - 商务宝_品牌代理席位查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/agent_brand_seat_query

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
province_id int 省 address.id(deep=0) 空
city_id int 市 address.id(deep=1) 空
district_id int 区/县 address.id(deep=2) 空
street_id int 街道 address.id(deep=3) 空
address_id int 区域 address.id 空
keywords string 品牌名称/编码关键词 空 非必须
brand_id int 指定品牌 id 空
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选

返回参数

参数类型描述
data.strategy_list array 该区域品牌策略档位(tier
data.seat_summary object 区域品牌策略席位合计
data.brand_list array 品牌列表(含
data.brand_count int 品牌总数

状态码说明

状态码描述
0 成功

API - 商务宝_店铺业绩总览

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_perf_summary

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空

返回参数

参数类型描述
data.shop_total_rl string 店铺总业绩
data.shop_month_rl string 店铺月业绩

状态码说明

状态码描述
0 成功

API - 商务宝_业绩明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/perf_detail

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
period string 时间范围 yesterday/week/month 空
date_start string 自定义开始日期 YYYY-MM-DD 空
date_end string 自定义结束日期 YYYY-MM-DD 空
page int 页码 1 可选
limit int 每页条数(最大100) 20 可选

返回参数

参数类型描述
data.total_rl string 当前业绩总和
data.list array 明细列表(订单让利)

状态码说明

状态码描述
0 成功

API - 商务宝_历史店铺业绩趋势

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_perf_trend

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
days int 近N日 7 非必须(3~31)

返回参数

参数类型描述
data.series array 按日让利
data.personal_total string 个人累计(服务店铺)
data.team_total string 团队累计

状态码说明

状态码描述
0 成功

API - 商务宝_本月进件明细

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_entry_month_list

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)
stat_month string 月份 YYYY-MM 空
page int 页码 1 可选
limit int 每页条数 20 可选

状态码说明

状态码描述
0 成功

API - 商务宝_实体商家入驻分享

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_settle_share

请求参数

参数类型描述默认值是否必须
HXDTOKEN string 用户令牌 空 必须(请求头)

返回参数

参数类型描述
data.share_url string 入驻H5链接(含推荐人手机号
data.qrcode_url string 入驻二维码图片地址(可保存分享)
data.tj_phone string 推荐人手机号
data.referrer_uid int 推荐人用户id

状态码说明

状态码描述
0 成功

API - 商务宝_实体入驻二维码图片

请求方式: GET

请求地址:https://apply.buyql.com/index.php/api/Swbb/shop_settle_qrcode

请求参数

参数类型描述默认值是否必须
uid int 推荐人用户id 无 必须
sign string 签名 无 必须(由

兑换可信数据

API - 兑换可信数据_可用余额与配置

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Trust_data/info

返回参数

参数类型描述
data.dou string 可用消费数据
data.dh_sum string 已兑换累计
data.fee_rate int 手续费%
data.enabled int 功能开关
data.rate_desc string 汇率说明
data.dou_name string 名称

状态码说明

状态码描述
0 成功

API - 兑换可信数据_报价

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Trust_data/quote

请求参数

参数类型描述默认值是否必须
amount number 到账A数量(正整数) 空 必须

返回参数

参数类型描述
data.amount_a int 到账A
data.fee_dou int 手续费(消费数据)
data.amount_dou int 扣减消费数据合计
data.fee_rate int 费率
data.dou_available string 当前可用
data.dou_after string 兑换后可用

状态码说明

状态码描述
0 成功

API - 兑换可信数据_提交兑换

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Trust_data/exchange

请求参数

参数类型描述默认值是否必须
amount number 到账A数量(正整数) 空 必须

返回参数

参数类型描述
data.order_no string 兑换单号
data.amount_a int 到账A
data.amount_dou int 扣减消费数据
data.fee_dou int 手续费
data.dou_after string 兑换后可用消费数据
data.balance_a string 链上A余额(若查询成功)

状态码说明

状态码描述
0 成功

API - 兑换可信数据_记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Trust_data/records

请求参数

参数类型描述默认值是否必须
page number 页码 1 必须
limit number 条数 20 必须

返回参数

参数类型描述
data.list array 记录
data.count int 总数

状态码说明

状态码描述
0 成功

API - 兑换可信数据_查询链上A余额

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Trust_data/balance

返回参数

参数类型描述
data.balance string A余额
data.identity string 链身份
data.phone string 手机号

状态码说明

状态码描述
0 成功

用户

API - 获取用户信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/msg

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data.login_password_set int 是否已设置登录密码:1

状态码说明

状态码描述
0 成功
其他 失败

API - 代理系统权限

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/agent_permission

请求参数

参数类型描述默认值是否必须
token string 令牌 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 修改头像

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/update_img

请求参数

参数类型描述默认值是否必须
token string token 空 必须
file string 图片文件 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 修改登录密码

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/update_password

请求参数

参数类型描述默认值是否必须
token string token 空 必须
passwordy number 原登录密码 无 否(password
password number 新登录密码 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 绑定推荐人

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/bdtjr

请求参数

参数类型描述默认值是否必须
token string token 空 必须
phone string 推荐人手机账号 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 我的团队

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/team

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page number 页数 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 直推列表项含

状态码说明

状态码描述
0 成功
其他 失败

API - 获取地址省市县列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_list

请求参数

参数类型描述默认值是否必须
type string 几级1、2、3、4 空 必须
pid string 上级id非一级必传 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 获取用户资金记录

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/jinbi_list

请求参数

参数类型描述默认值是否必须
type string 类型 空 必须
msg string 说明 空 必须
zhi string 金额 空 必须
time_start string 开始时间时间戳 空 必须
time_end string 结束时间时间戳 空 必须
limit number 条数 空 必须
page number 页数 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 获取用户资金类型

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/jinbi_type

请求参数

参数类型描述默认值是否必须
type string 类型 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息

状态码说明

状态码描述
0 成功
其他 失败

API - 获取用户收货地址列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_list_user

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 添加收货地址

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_user_add

请求参数

参数类型描述默认值是否必须
token string token 空 必须
name string 收货人 无 必须
phone int 收货人手机号 无 必须
sex string 性别(先生、女士) 无 必须
address1 int 省ID 无 必须
address2 int 市、区ID 无 必须
address3 int 县ID 无 非必须
address4 int 县ID 无 非必须
address int 详细地址 无 必须
lon int 经度 无 必须
lat int 纬度 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 修改收货地址

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_user_update

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id string 收货地址数据ID 无 必须
name string 收货人 无 必须
phone int 收货人手机号 无 必须
sex string 性别(先生、女士) 无 必须
address1 int 省ID 无 必须
address2 int 市、区ID 无 必须
address3 int 县ID 无 非必须
address4 int 县ID 无 非必须
address int 详细地址 无 必须
lon int 经度 无 必须
lat int 纬度 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 删除收货地址

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_user_del

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id int 收货地址ID 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 设置收货地址默认

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/address_user_mo

请求参数

参数类型描述默认值是否必须
token string token 空 必须
id int 收货地址ID 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 文件上传

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/upfile

请求参数

参数类型描述默认值是否必须
token string token 空 必须
file file 上传的文件 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
1023 未登录
其他 失败

API - 注册店铺

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/addshop

请求参数

参数类型描述默认值是否必须
name string 店铺名称 无 必须
img string 头像链接除域名外后缀 无 必须
address1 number 地址省id 无 必须
address2 number 地址市id 无 必须
address3 number 地址区id 无 必须
address4 number 地址街道id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data.shop_id int 店铺id
data.cloud_zt int 云店已激活为1
data.cloud_level int 0普通云店
data.cloud_time string 激活时间
data.cloud_end_time string 到期时间(注册即送一年)

状态码说明

状态码描述
0 成功
其他 失败

API - 店铺基础资料修改

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/updateshop

请求参数

参数类型描述默认值是否必须
name string 店铺名称 无 必须
img string 头像链接除域名外后缀 无 必须
address1 number 地址省id 无 必须
address2 number 地址市id 无 必须
address3 number 地址区id 无 必须
address4 number 地址街道id 无 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 获取店铺信息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/msgshop

请求参数

参数类型描述默认值是否必须
token string token 空 必须

返回参数

参数类型描述
code int 状态码(具体参见状态码说明)
msg string 提示信息
data array 数据

状态码说明

状态码描述
0 成功
其他 失败

API - 用户缓存-按类型查询

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/cache_get

请求参数

参数类型描述默认值是否必须
token string token 空 必须
type int 类型(纯数字)无 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array|null 无记录时为

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 用户缓存-写入或覆盖

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/cache_set

请求参数

参数类型描述默认值是否必须
token string token 空 必须
type int 类型(纯数字)无 必须
msg string 内容 无 必须(可传
title string 说明 无 非必须(新增时写入;修改时传入则覆盖,不传则保留原说明)

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array 含

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

API - 用户缓存-按类型删除

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/User/cache_clear

请求参数

参数类型描述默认值是否必须
token string token 空 必须
type int 类型(纯数字)无 必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data array deleted

状态码说明

状态码描述
0 成功
100 失败
1023 未登录

营销模块

API - 平台配置-列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/platform_list

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功

API - 平台配置-保存

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/platform_save

请求参数

参数类型描述默认值是否必须
token string token 空 必须
platform_id string 平台标识 空 必须
enabled int 启用状态 空 可选
app_key string AppKey 空 可选
app_secret string AppSecret 空 可选
access_token string AccessToken 空 可选
refresh_token string RefreshToken 空 可选
cookie string Cookie 空 可选
status string 连接状态 空 可选

状态码说明

状态码描述
0 成功

API - 平台配置-切换启用

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/platform_toggle

请求参数

参数类型描述默认值是否必须
token string token 空 必须
platform_id string 平台标识 空 必须
enabled int 启用状态 空 必须

状态码说明

状态码描述
0 成功

API - 平台配置-删除

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/platform_delete

请求参数

参数类型描述默认值是否必须
token string token 空 必须
platform_id string 平台标识 空 必须

状态码说明

状态码描述
0 成功

API - AI配置-预留说明

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/ai_reserved_config

请求参数

参数类型描述默认值是否必须
token string token 空 必须

状态码说明

状态码描述
0 成功

API - AI对话-创建会话

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/chat_session_create

请求参数

参数类型描述默认值是否必须
token string token 空 必须
title string 会话标题 空 可选
model string 模型 空 可选

状态码说明

状态码描述
0 成功

API - AI对话-发送消息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/chat_send

请求参数

参数类型描述默认值是否必须
token string token 空 必须
session_id string 会话ID 空 必须
content string 用户消息 空 必须
ai_platform_id string AI平台ID 空 可选(AI配置走预留配置,不占用视频发布平台配置)
model string 模型 空 可选
save_material int 是否入素材库 空 可选

状态码说明

状态码描述
0 成功

API - AI对话-生成视频

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/chat_generate_video

请求参数

参数类型描述默认值是否必须
token string token 空 必须
session_id string 会话ID 空 必须
prompt string 视频创作需求 空 必须
ai_platform_id string 文本模型平台 空 可选(AI配置走预留配置)
model string 文本模型 空 可选
video_platform_id string 视频模型平台 空 可选(AI配置走预留配置)
video_model string 视频模型 空 可选
video_tier string 视频模型档位 空 可选
save_material int 是否入素材库 空 可选

状态码说明

状态码描述
0 成功

API - AI对话-历史消息

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/chat_history

请求参数

参数类型描述默认值是否必须
token string token 空 必须
session_id string 会话ID 空 必须
page int 页码 空 可选
limit int 每页数量 空 可选

状态码说明

状态码描述
0 成功

API - AI对话-会话列表

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/chat_sessions

请求参数

参数类型描述默认值是否必须
token string token 空 必须
page int 页码 空 可选
limit int 每页数量 空 可选

状态码说明

状态码描述
0 成功

API - 订单让利_按地区日汇总执行(等同

请求方式: POST

请求地址:https://apply.buyql.com/index.php/api/Yx_marketing/order_brand_rl_stat_run

请求参数

参数类型描述默认值是否必须
token string 令牌 无 必须
confirm string 固定传run 无 必须
start_date string 起始日Y-m-d 无 非必须,默认昨日;从当日
end_date string 结束日Y-m-d 无 非必须,默认到当前时刻;含当日
exec_secret与env string order_brand_rl_stat_secret一致时允许执行 无 非必须

返回参数

参数类型描述
code int 状态码
msg string 提示信息
data.stats object 汇总统计(orders_scanned、lines_upserted_order、lines_upserted_receive、pools_created

状态码说明

状态码描述
0 成功
100 参数错误或汇总失败