抖音开放平台Logo
控制台

餐饮团购-查询商品线上数据

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

  1. 使用商品 ID 或外部商品 ID 查询商品线上数据。
  2. 线上数据是指:通过审核后可以被用户看到的数据,包括在线、下线状态的数据。
  3. 服务商角色应用,可以查询通过开放平台 OpenAPI 方式创建的商品数据,也可以查询商户通过来客方式创建发布的商品(由于脱敏要求,该部分商品仅返回以下字段:商品名称、商品ID、商品划线价、顾客实际需支付价格、商品套餐搭配、售卖日期范围),并且商品需要在商服关系授权之后创建的才会返回对应的商品数据。
  4. 商家自研角色应用可返回全量商品数据,包含来客创建商品(不包含其他服务商通过开放平台 OpenAPI 方式创建的商品),如果自研商家需要查询抖音来客创建的商品,需要使用product_ids,out_ids 不生效。
  5. 单次请求最多查询 10 个在线数据。

基本信息

名称描述
HTTP URL
HTTP Method
GET
Scope
life.capacity.goods.query
权限要求
  • 需要申请权限 ,路径:抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案
  • 需要商家授权,路径:抖音来客>店铺管理>第三方应用授权

请求头

名称字段类型是否必填示例描述
access-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
account_idString

抖音来客商家根账户 ID

传入时服务商须与该商家满足授权关系;

请求示例

curl --location 'https://open.douyin.com/goodlife/v1/akte/goods/product/online/get/?access_token=clt.fbf20fbdd88a69ef7e52bf7c953b2d94aJghqCfoYQJsiuCM43y9f8dK9Pmh&out_id=akte_goods_demo&account_id=7166966001467131917' \
--header 'Cookie: passport_csrf_token=07a8ffb6d249f30aaacb663c962296d4; passport_csrf_token_default=07a8ffb6d249f30aaacb663c962296d4' 

响应参数

Body

名称字段类型是否必填示例描述

响应示例

正常响应示例

{
  "extra": {
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "now": 1658200003,
    "logid": "xxx",
    "error_code": 0
  },
  "data": {
    "description": "",
    "error_code": 0,
    "product_onlines": [
      {
        "commission_info": {
          "platform_take_rate": 350
        },
        "online_status": 1,
        "product": {
          "biz_line": 1,
          "out_id": "akte_goods_demo",
          "product_id": "7119054118261606444",
          "telephone": [
            "1234-4321"
          ],
          "account_name": "lh测试商家",
          "attr_key_value_map": {
            "Images": "[\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505021658382380\",\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505050439696428\"]",
            "IsConfirmImme": "true",
            "Notification": "[{\"title\":\"标题\",\"content\":\"运动健身1.1\"}]",
            "SortWeight": "0",
            "customer_reserved_info": "{\"allow\":true,\"allow_tel\":true,\"allow_name\":true,\"allow_identity\":true,\"require_for_tel\":true,\"need_for_all\":true,\"reserved_reason\":\"留资原因\"}",
            "description_rich_text": "[{\"note_type\":1,\"content\":\"其他说明信息-运动健身团购\"}]",
            "environment_image_list": "[{\"url\":\"http://p-boe-sign.bytedance.net/obj/aweme-upload-image/7038504987084734508?x-orig-authkey=boeorigin&x-orig-expires=1658221200&x-orig-sign=TLe6dfqJ0a7i9VA4Zbh3Cu7qAV8%3D\"}]",
            "image_list": "[{\"url\":\"http://p-boe-sign.bytedance.net/obj/aweme-upload-image/7038505021658382380?x-orig-authkey=boeorigin&x-orig-expires=1658221200&x-orig-sign=ygn%2FI0ORgkAJdomj7liPXpK9v3s%3D\"},{\"url\":\"http://p-boe-sign.bytedance.net/obj/aweme-upload-image/7038505050439696428?x-orig-authkey=boeorigin&x-orig-expires=1658221200&x-orig-sign=QGvp6oDAMSW%2F3xA4L7ASboxnYoM%3D\"}]",
            "DateRule": "{\"unavailable_date\":{\"date_list\":[\"2022-03-08\",\"2022-03-09\"],\"weekday_list\":[7,1,2,3,4],\"not_available_on_holidays\":true}}",
            "OrderValidEnd": "1993478399",
            "can_no_use_date": "{\"enable\":true,\"days_of_week\":[7,1,2,3,4],\"holidays\":[1,2,3,4,5],\"date_list\":[\"2022-03-08\",\"2022-03-09\"],\"holiday_dates\":{\"1\":\"2022.01.01-2022.01.03\"}}",
            "real_name_info": "{\"enable\":true,\"scene\":1}",
            "Description": "[\"商品描述-运动健身\"]",
            "EntryType": "1",
            "OrderValidStart": "1638720000",
            "SupplierExtIdList": "[\"goods_v1_poi_001\"]",
            "refund_need_merchant_confirm": "true",
            "show_channel": "2",
            "use_date": "{\"use_date_type\":1,\"use_start_date\":\"2021-12-06\",\"use_end_date\":\"2033-03-03\"}",
            "FrontCategoryTag": "[\"美食套餐\"]",
            "RecommendWord": "推荐语",
            "RefundPolicy": "2",
            "TagList": "标签列表-待填写",
            "appointment": "{\"need_appointment\":true,\"external_link\":\"urlxxx\",\"order_appointment_time_url\":\"urlxxx\",\"ahead_time_type\":1,\"ahead_day_num\":1}",
            "use_time": "{\"use_time_type\":1}"
          },
          "sold_start_time": 1646724999,
          "category_full_name": "运动健身·游泳馆·游泳馆",
          "category_id": 3001001,
          "creator_account_id": 7107571250087643000,
          "product_name": "life测试-0223-011",
          "sold_end_time": 1799607528,
          "owner_account_id": 7113893944009705000,
          "pois": [
            {
              "supplier_ext_id": "goods_v1_poi_001",
              "supplier_id": 7112378515013585000,
              "poi_id": 6601137575719602000
            }
          ],
          "product_type": 1
        },
        "sku": {
          "create_time": 1657694409,
          "sku_id": "7119054118261606444",
          "sku_name": "life测试-0223-011",
          "status": 1,
          "update_time": 1657769323,
          "actual_amount": 996,
          "origin_amount": 1399,
          "stock": {
            "limit_type": 1,
            "stock_qty": 88
          },
          "attr_key_value_map": {
            "market_price": "1900",
            "settle_type": "1",
            "use_type": "1",
            "code_source_type": "1",
            "limit_rule": "{\"is_limit\":true,\"total_buy_num\":9}"
          }
        }
      }
    ]
  }
}

异常响应示例

{
  "data": {
    "error_code": 2100004,
    "description": "系统繁忙,此时请开发者稍候再试"
  },
  "extra": {
    "logid": "20220616135636010225243100059D654D",
    "now": 1655358997504,
    "error_code": 2100004,
    "description": "系统繁忙,此时请开发者稍候再试",
    "sub_error_code": 0,
    "sub_description": "unknown error, please retry"
  }
}

错误码

http状态码错误码错误码描述排查建议
2002190002
access_token无效
调用接口重新生成access_token
2002190004
应用未获得该能力, 请去https://open.douyin.com/申请
应用申请接口权限
2002190008
access_token过期,请刷新或重新授权
规范token刷新机制,检查是否有测试环境在同步刷新token
2002119001
参数不合法
更换参数
2002119002
系统繁忙,请稍候再试
重试
2002119003
请求太过频繁,请稍后再试
重试
2002119005
应用未获商家授权
联系合作商家在商家后台发起授权,并在服务商后台同意授权
2003000001
根据实际业务错误返回
对照接口文档规范参数并重试
2004000001
根据实际业务错误返回
补充参数
2004000002
根据实际业务错误返回
对照接口文档规范参数并重试
2005000001
根据实际业务错误返回
联系抖音处理

错误码

HTTP 状态码
错误码
错误消息
排查建议
200​
2190002​
access_token无效​
调用接口重新生成access_token​
200​
2190004​
应用未获得该能力, 请去https://open.douyin.com/申请
应用申请接口权限​
200​
2190008​
access_token过期,请刷新或重新授权​
规范token刷新机制,检查是否有测试环境在同步刷新token​
200​
2119001​
参数不合法​
更换参数​
200​
2119002​
系统繁忙,请稍候再试​
重试​
200​
2119003​
请求太过频繁,请稍后再试​
重试​
200​
2119005​
应用未获商家授权​
联系合作商家在商家后台发起授权,并在服务商后台同意授权​
200​
3000001​
根据实际业务错误返回​
对照接口文档规范参数并重试​
200​
4000001​
补充参数​
200​
4000002​
对照接口文档规范参数并重试​
200​
5000001​
联系抖音处理​