提交门店匹配任务

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

我的收藏

将三方门店与抖音门店建立匹配关系。建立匹配关系后，开发者可通过三方门店 id 和抖音门店 id 对门店进行管理。

使用限制

无

接口说明

•

注意事项：

◦

此接口为异步接口，匹配结果需通过“查询门店匹配结果”获取。

◦

门店坐标经纬度信息需使用 GCJ-02 坐标系坐标，否则门店定位会有较大偏差，无法正确匹配。

◦

当门店已经完成匹配或者正在匹配中时，请不要重复提交匹配；匹配失败后，可再次发起匹配。

◦

匹配成功并不意味着匹配正确，需要自行核对匹配结果中的抖音门店是否为期望门店。

◦

咨询问题时，请提供请求响应返回的taskID。

◦

如需解绑已成功建立的匹配关系请提咨询问题做解绑处理。

基本信息

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

请求头

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

请求参数

Body

名称			类型	是否必填	描述	示例值
datas			struct[]	是	支持批量提交，单次请求数量<=200
	ext_id		string	是	三方门店 id	"1224121"
	poi_id		string	否	期望匹配的抖音门店 id	"7225909186624751650"
	poi_name		string	是	抖音门店名称	"我的店铺名称"
	province		string	否	省份名称	"新疆维吾尔自治区"
	city		string	否	城市名称	"阿克苏"
	address		string	是	门店地址	"庐山路华晨大拇指商业广场5楼"
	longitude		string	是	门店的经度，精度为小数点后6位，需使用 GCJ-02 坐标系统	"114.391591"
	latitude		string	是	门店的纬度，精度为小数点后6位，需使用 GCJ-02 坐标系统	"30.497991"
	head_image_urls		string[]	否	门店头图链接	["https://www.xx.com/1.jpg","https://www.xx.com/2.jpg"]
	industry_code		string	否	门店的行业类目 code	"011607"
	open_times		map	否	门店营业时间
		key	int	否	一周中的周几营业可选值有：1 ~ 7（分别对应周一到周日）	1
		value	string[]	否	门店营业时间段	["09:00-18:00", "19:00-23:00"]
	contact_tel		string	否	门店座机号码	61234567
	contact_phone		string	否	门店手机号码	13123456789

请求示例

JSON复制
curl --location 'https://open.douyin.com/goodlife/v1/poi/match/task/submit/' \
--header 'access-token: clt.3debb030490ecb3c0041fe429fbcabcdDHhnidu3N4umpDk2AvkfWn70U0Ri' \
--header 'Content-Type: application/json' \
--data '{
    "datas": [
        {
            "ext_id": "1224121",
            "poi_id": "7225909186624751650",
            "poi_name": "我的店铺名称",
            "province": "新疆维吾尔自治区",
            "city": "阿克苏",
            "address": "庐山路华晨大拇指商业广场5楼",
            "longitude": "114.391591",
            "latitude": "30.497991",
            "head_image_urls": [
                "https://www.xx.com/1.jpg",
                "https://www.xx.com/2.jpg"
            ],
            "industry_code": "011607",
            "open_times": {
                "1": [
                    "09:00-18:00"
                ],
                "2": [
                    "09:00-18:00"
                ]
            },
            "contact_tel": "61234567",
            "contact_phone": "13123456789"
        }
    ]
}'

响应参数

名称		类型	描述
data		struct
	task_id	int	匹配任务 id，咨询问题时需提供
	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": {
        "task_id": 7248591123814352935,
        "error_code": 0,
        "description": "success"
    },
    "extra": {
        "error_code": 0,
        "description": "success",
        "sub_error_code": 0,
        "sub_description": "",
        "logid": "202306261420441A17A89D364C3F21B86B",
        "now": 1687760445
    }
}

异常示例

JSON复制
{
    "data": {
        "error_code": 2100005,
        "description": "参数不合法"
    },
    "extra": {
        "error_code": 2100005,
        "description": "参数不合法",
        "sub_error_code": 0,
        "sub_description": "ext_id should be string",
        "logid": "20230704154135EAE35281703E3713D80C",
        "now": 1688456495773
    }
}