开发 行业对接说明 本地生活业务对接 对接说明 单体小程序对接 POI对接
# 向POI申请商品挂载权限
更新时间:2023-02-08 11:00:04
# 接口说明
获取快手POIID后,需要调用申请挂载权限接口 。 在某一个POI申请挂载权限时,快手侧需要服务商/小程序传入一定的信息,如POI对应商家的标签等,开发者可通过POI信息编辑接口申请修改该类信息 。
审核结果的通知机制为 :通过回调地址回调结果,也可支持通过审核状态查询接口主动查询 。
# 1、POI申请挂载权限接口
项目 | 值 |
---|---|
域名 | 线上环境:https://open.kuaishou.com (opens new window) |
接口说明 | 申请某POI下的商品上传权限,若已拥有此poi的权限则会报错,参考错误码说明 |
Path | /openapi/mp/developer/poi/mount |
Method | POST |
Request Param
参数名 | 类型 | 位置 | 是否必填 | 备注 |
---|---|---|---|---|
app_id | string | request param | 是 | 小程序id |
access_token | string | request param | 是 | 小程序授权token |
以下参数作为body发送
{
"poi_id": "6724909395445513704", // 想要挂载的POI的id,必选参数
"quality_labels" : [1,2], //店铺品质标签
"grade_label" : 1, //店铺等级标签
"attach" : "type:MT", //附加信息,由开发者自定义
"notify_url": "http://www.youdomain.com/notify/path" // 回调地址,必选参数
}
body参数说明
参数名 | 类型 | 是否必填 | 备注 |
poi_id | string | 是 | 要挂载的快手侧poiId |
quality_labels | number数组 | 否 | poi品质标签,可多选 |
grade_label | number | 否 | poi等级标签,单选。(若不传则默认为未定义) |
attach | string | 否 | 附加信息,会在回调通知时原样回传,详见快手小程序发送body 注意:不允许超过200个字符 |
notify_url | string | 是 | 审核结果通知地址,长度不允许超过200详情见小程序审核结果发送协议 |
poi品质标签
值 | 含义 |
---|---|
1 | 网红 |
2 | 热卖 |
3 | 大牌 |
4 | 热门 |
5 | 网友推荐 |
poi等级标签
值 | 含义 |
---|---|
0 | 未定义 |
1 | 全国连锁店 |
2 | 城市连锁店&城市网红店 |
3 | 区域店铺 |
Response
{
"result": 1, // 非1视为错误码,详见错误码说明
"error_msg": "success", // 错误提示信息
}
# 2、POI信息编辑接口
项目 | 值 |
---|---|
域名 | 线上环境:https://open.kuaishou.com (opens new window) |
接口说明 | poi申请的信息进行更新 |
Path | /openapi/mp/developer/poi/update |
Method | POST |
Request Param
参数名 | 类型 | 位置 | 是否必填 | 备注 |
---|---|---|---|---|
app_id | string | request param | 是 | 小程序id |
access_token | string | request param | 是 | 小程序授权token |
以下参数作为body发送
注意:仅传需要更新的字段,无需更新的字段不传或者传null
{
"poi_id": "6724909395445513704", // 想要编辑的POI的id,必选参数
"quality_labels" : [1,2], //店铺品质标签
"grade_label" : 1, //店铺等级标签
"attach" : "type:MT", //附加信息,由开发者自定义
"notify_url": "http://www.youdomain.com/notify/path" // 回调地址,必选参数
}
body参数说明
参数名 | 类型 | 是否必填 | 编辑是否需要审核 | 备注 |
poi_id | string | 是 | 非修改字段 | 要挂载的poiId |
quality_labels | number数组 | 否 | 否 | poi品质标签,可多选 注:若传了 quality_labels:[] 则代表将标签更新为空数组。 |
grade_label | number | 否 | 否 | poi等级标签,单选。 |
attach | string | 否 | 否 | 附加信息,会在回调通知时原样回传,详见小程序审核结果发送协议。不传则默认附加原attach信息,若修改成功,则作为之后的默认attach信息 注意:不允许超过200个字符 |
notify_url | string | 否 | 否 | 审核结果推送地址,长度不允许超过200。不传则默认按原回调地址回调,若修改成功,则作为之后的默认回调地址 详情见小程序审核结果发送协议 |
poi品质标签
值 | 含义 |
---|---|
1 | 网红 |
2 | 热卖 |
3 | 大牌 |
4 | 热门 |
5 | 网友推荐 |
poi等级标签
值 | 含义 |
---|---|
0 | 未定义 |
1 | 全国连锁店 |
2 | 城市连锁店&城市网红店 |
3 | 区域店铺 |
Response
{
"result": 1, // 非1视为错误码,详见错误码说明
"error_msg": "success", // 错误提示信息
"data" : {
"needAudit" : false //是否需要审核,如果为true,则审核结果会推送到notify_url
}
}
# 3、挂载权限审核状态查询接口
项目 | 值 |
---|---|
域名 | 线上环境:https://open.kuaishou.com (opens new window) |
接口说明 | 小程序POI权限申请状态查询接口 |
Path | /openapi/mp/developer/poi/status |
Method | POST |
Request Param
参数名 | 类型 | 位置 | 是否必填 | 备注 |
---|---|---|---|---|
app_id | string | request param | 是 | 小程序id |
access_token | string | request param | 是 | 小程序授权token |
以下参数作为body发送
{
"poi_ids":["6724909438339477816","6724909438339477819"]
}
body参数说明
参数名 | 类型 | 是否必填 | 备注 |
poi_ids | array | 是 | 要挂载的poiId 注:一次查询不可超过20个 |
Response
正常情况:
{
"result": 1, // 非1视为错误码,详见错误码说明
"error_msg": "success", // 错误提示信息
"data": [{
"appId": "ks682576822728817112",
"poiId":"6724909438339477816",
"status":"PASS", // DEFAULT:待审核 PASS:审核通过 REJECT:审核拒绝
"reason":"" // 如果审核未通过会展示原因
"code": 1, //code为1代表正常返回
"message": ""
},{
"appId": "ks682576822728817112",
"poiId":"6724909438339477819",
"status":"REJECT", // DEFAULT:待审核 PASS:审核通过 REJECT:审核拒绝
"reason":"" // 如果审核未通过会展示原因
"code": 1, //code为1代表正常返回
"message": ""
}]
}
有数据异常的情况:
{
"result": 1, // 非1视为错误码,详见错误码说明
"error_msg": "success", // 错误提示信息
"data": [{
"appId": "ks682576822728817112",
"poiId": "6724909438339",
"status": "",
"reason": "",
"code": 10000200, //code非1表示异常,错误码详见错误码说明
"message": "poiId 长度不正确" //错误描述
},
{
"appId": "ks682576822728817112",
"poiId": "672490943833947781",
"status": "",
"reason": "",
"code": 10000200, //code非1表示异常,错误码详见错误码说明
"message": "poiId 长度不正确" //错误描述
}]
}
上一篇:《POIID获取》
下一篇:《商品对接》
仍有疑问? 前往社区提问