- 生活服务商家应用 OpenAPI SDK 总览
- OpenAPI
- 门店管理
- 团购核销
- 团购对账
- 会员接入
- 订单查询
- 三方码
- 商品发布及查询
- 酒旅
- 预置码
- 代运营
- 接入前准备
- 餐饮团购
- 线索经营
- 团购退款
查询门店信息
更新时间 2024-07-24 02:58:49
收藏
我的收藏通过 抖音门店ID 或 生活服务商家账户 ID 查询已认领的门店信息列表,用于商家/服务商映射与抖音 POI 的门店关系。
使用限制
无
接口说明
- •注意事项:
- ◦account_id 可通过如下路径获取:
- ▪商家:从PC抖音来客右上角获得“账户ID”;从app抖音来客-我-置顶个人信息获得“账户ID”
- ▪服务商:从控制台-应用详情页-授权管理获得已经授权的商家的“账户ID”
基本信息
HTTP URL | |
HTTP Method | GET |
权限要求 | 门店管理 |
Scope | life.capacity.shop |
权限申请 |
|
请求头
名称 | 类型 | 是否必填 | 描述 |
Content-Type | string | 是 | 固定值:"application/json" |
access-token | string | 是 | 接口调用凭证 示例值:"clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ" |
请求参数
Query
名称 | 类型 | 是否必填 | 描述 | 示例值 |
account_id | string | 否 | 本地生活商家账户 ID (account_id和poi_id,二者必填其一,若都填写,account_id优先) | "7248591123814352935" |
poi_id | string | 否 | 抖音门店 ID (account_id和poi_id,二者必填其一,若都填写,account_id优先) | "6248514573814352935" |
page | int64 | 是 | 页码 ,(从1开始) | 1 |
size | int64 | 是 | 页大小 数值范围:[1, 100] | 10 |
请求示例
js复制curl --location 'https://open.douyin.com/goodlife/v1/shop/poi/query/?poi_id=7237783383823091746&page=1&size=10' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.c8cba3d43db3aa0dd4881f84f9823366cO7xqxE5Dmz0KU1in6y9jMta6wDg' \
响应参数
名称 | 类型 | 描述 | |||
data | | | | struct | |
| pois | | | struct[] | 门店信息列表 |
| | poi | | struct | 门店信息 |
| | | poi_id | string | 抖音门店 ID |
| | | poi_name | string | 抖音门店名称 |
| | | address | string | 门店地址 |
| | | latitude | float | 门店坐标 - 纬度 |
| | | longitude | float | 门店坐标 - 经度 |
| | root_account | | struct | 生活服务商家账户信息 |
| | | account_id | string | 账户 ID |
| | | account_name | string | 账户名称 |
| total | | | int | 总数 |
| 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": {
"pois": [
{
"poi": {
"poi_id": "6994674961470212127",
"poi_name": "CHARLIE'S粉红汉堡(常熟路店)",
"address": "常熟路85号一层A6、A7号铺位",
"latitude": 82.580195,
"longitude": 40.101612
},
"root_account": {
"account_id": "7014065493820573710",
"account_name": "上海曾士餐饮有限公司",
}
}
],
"total": 1,
"error_code": 0,
"description": "success"
},
"extra": {
"error_code": 0,
"description": "success",
"sub_error_code": 0,
"sub_description": "",
"logid": "20230728153305C38E42BF588965058061",
"now": 1690529585
}
}
异常响应
JSON复制{
"data": {
"description": "该商家未授权",
"error_code": 3000004
},
"extra": {
"error_code": 3000004,
"description": "该商家未授权",
"sub_error_code": 0,
"sub_description": "",
"logid": "2023072815454631751395DF4A3C0004AD",
"now": 1690530346
}
}
错误码
HTTP 状态码 | 错误码 | 错误消息 | 排查建议 |
200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
200 | 2190004 | 应用申请接口权限 | |
200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
200 | 2119001 | 参数不合法 | 更换参数 |
200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
200 | 4000001 | 补充参数 | |
200 | 4000002 | 对照接口文档规范参数并重试 | |
200 | 5000001 | 联系抖音处理 | |
200 | 3000004 | 门店未查询到商家 | 检查商家账号是否有认领门店 |
200 | 4000004 | account_id,third_id,poi_id必须选择一个进行查询 | 检查入参并重新查询 |
点击纠错