查询门店匹配关系

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

我的收藏

通过三方门店 id，查询与抖音门店 id 的匹配关系。

使用限制

无

接口说明

•

前提条件：

◦

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

基本信息

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

请求头

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

请求参数

Query

名称	类型	是否必填	描述	示例值
ext_ids	string	是	三方门店 id 列表，多个使用,分隔，单次请求 <= 200	202304271524,202305051538

请求示例

js复制
curl --location 'https://open.douyin.com/goodlife/v1/poi/match/relation/query/?ext_ids=202304271524%2C202305051538' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.5c61decfa50003fb24650363dac8805cjmcS0UbhDp6zqbrd3u1Y0HCOOZyw' \

响应参数

名称			类型	说明
data			struct
	relations		struct[]
		ext_id	string	三方门店 id
		match_poi_id	string	匹配上的抖音门店 id
		match_relation_status	int	匹配状态 2 - 已匹配 3 - 未匹配
	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": {
        "relations": [
            {
                "ext_id": "202305051538",
                "match_poi_id": "7229580912508274746",
                "match_relation_status": 2
            },
            {
                "match_relation_status": 2,
                "ext_id": "202304271524",
                "match_poi_id": "7226627105931413559"
            }
        ],
        "error_code": 0,
        "description": "success"
    },
    "extra": {
        "error_code": 0,
        "description": "success",
        "sub_error_code": 0,
        "sub_description": "",
        "logid": "202307041610015E4B5F210E79E113B5C0",
        "now": 1688458202
    }
}

异常示例

JSON复制
{
    "data": {
        "error_code": 3000001,
        "description": "查询数量>200"
    },
    "extra": {
        "error_code": 3000001,
        "description": "查询数量>200",
        "sub_error_code": 0,
        "sub_description": "",
        "logid": "20230704161346585BE9A34385D217D346",
        "now": 1688458427
    }
}