查询门店匹配任务结果

更新时间 2024-07-24 02:58:49

我的收藏

使用“提交门店匹配任务”接口返回的 task_id，查询任务的结果信息。

使用限制

无

接口说明

•

前提条件：

◦

需要先使用“提交门店匹配任务”接口提交任务

•

注意事项：

◦

匹配结果通常在24小时内产出。

◦

仅允许查询同一clientKey提交的门店匹配任务结果信息。

基本信息

HTTP URL	https://open.douyin.com/goodlife/v1/poi/match/task/query/
HTTP Method	GET
权限要求	门店匹配
Scope	life.capacity.poi.match
权限申请	•申请权限，路径：抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案 •商家授权，路径：抖音来客>店铺管理>第三方应用授权

请求头

名称	类型	是否必填	描述
Content-Type	string	是	固定值："application/json"
access-token	string	是	接口调用凭证示例值："clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ" 了解更多：access_token获取方式

请求参数

Query

字段	类型	是否必填	描述	示例值
task_id	int	是	门店匹配任务 id	7249720568382113832

请求示例

js复制
curl --location 'https://open.douyin.com/goodlife/v1/poi/match/task/query/?task_id=7251601128935262247' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.41546fcd9852ca078bc73afdcf814801zruuo3JgEC39iVy9Wh9mcjILP55l' \

响应参数

名称			类型	说明
data			struct
	results		struct[]	一个 task_id 对应一个 result
		ext_id	string	三方门店 id
		match_poi_id	string	已匹配的抖音门店 id
		match_status	int	匹配任务执行状态 1 - 等待执行 2 - 匹配进行中 5 - 匹配完成
		match_result	int	匹配任务执行结果 0 - 默认值 1 - 匹配成功 2 - 匹配失败 4 - 无效数据，请检查传参 5 - 重复提交 6 - 抖音门店 id 已与其他三方门店 id 建立匹配关系，无法绑定 7 - 三方门店 id 已与其他抖音门店id 建立匹配关系，无法绑定 8 - 超过每日匹配数量限制 9 - 经纬度信息填写错误，请检查传参
		match_message	string	匹配失败信息
	error_code		int	错误码，非 0 表示失败
	description		string	错误码描述
extra
	error_code		int	错误码，非 0 表示失败
	description		string	错误描述
	sub_error_code		int	子错误码，成功返回 0，此接口暂未使用
	sub_description		string	子错误描述，此接口暂未使用
	logid		string	抖音侧日志 id，咨询问题时需提供
	now		int	请求响应时间，秒级时间戳

响应示例

正常示例

JSON复制
{
    "data": {
        "results": [
            {
                "ext_id": "1224121",
                "match_message": "匹配不到门店，POI(7225909186624751650):POI已被合并;",
                "match_poi_id": "0",
                "match_result": 2,
                "match_status": 5
            }
        ],
        "error_code": 0,
        "description": "success"
    },
    "extra": {
        "error_code": 0,
        "description": "success",
        "sub_error_code": 0,
        "sub_description": "",
        "logid": "202307041530249DDB4F42CA925B10222D",
        "now": 1688455824
    }
}

失败示例

JSON复制
{
    "data": {
        "error_code": 3000001,
        "description": "无效任务id"
    },
    "extra": {
        "error_code": 3000001,
        "description": "无效任务id",
        "sub_error_code": 0,
        "sub_description": "",
        "logid": "2023070415423534BA830ADD360D119CEB",
        "now": 1688456555
    }
}