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

更新时间 2024-08-02 10:05:02

我的收藏

通过接口查询商品线上数据列表

使用限制

查询本client_key（或绑定的账号）创建的商品线上列表。

处于在线、下线、封禁状态的数据可以通过该接口查询到。

支持代运营服务商/技术服务商查询商户在来客创建的商品数据。

商家自研角色应用可返回全量商品数据，包含来客创建的商品，授权服务商所创建的商品。

单个应用调用接口最大qps为50。

接口说明

无

基本信息

HTTP URL	https://open.douyin.com/goodlife/v1/akte/goods/product/online/query/
HTTP Method	GET
申请权限	商品查询
权限要求	•需要申请权限，路径：抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案 •需要商家授权，路径：抖音来客>店铺管理>第三方应用授权

请求头

参数	描述	必须
Content-Type	application/json	是
access-token	根据这个地址获取的token	是

请求参数

Query 请求

参数名称	参数类型	是否必传	参数描述
cursor	string	FALSE	第一页不传，之后用前一次返回的next_cursor传入进行翻页
count	int	FALSE	分页数量，不传默认为5，最大上限50
status	int	FALSE	筛选在线状态，1-在线 2-下线 3-封禁
account_id	string	TRUE	商家ID，传入时服务商须与该商家满足授权关系
goods_creator_type	int	FALSE	区分商品创建者的查询方式 0 - 查询服务商/开发者创建的商品 1 - 查询商家（account_id）创建的商品
query_all_poi	bool	FALSE	是否查询商品全量关联门店设置为true时，分页数量最大上限为20
goods_query_type	int	FALSE	新商品查询参数，仅支持ka自研开发者使用，当前参数生效时goods_creator_type参数不再生效 1 - 可查询归属于ka自研的所有商品，包括非ka自研创建的商品
product_type_list	list<int>	FALSE	商品类型筛选列表，可支持类型包括团购 - 1 代金券 - 11 次卡 - 15
poi_ids	list<int>	FALSE	门店ID list，可支持最多传入100家门店
ext_ids	list<int>	FALSE	外部门店ID list，可支持最多传入100家门店
product_name	string	FALSE	商品名称（长度不超过30，支持模糊搜索）

请求示例

js复制
curl --location 'https://open.douyin.com/goodlife/v1/akte/goods/product/online/query/?access_token=clt.fbf20fbdd88a69ef7e52bf7c953b2d94aJghqCfoYQJsiuCM43y9f8dK9Pmh&account_id=7166966001467131917&count=5&goods_creator_type=1&status=1' \
--header 'Cookie: passport_csrf_token=07a8ffb6d249f30aaacb663c962296d4; passport_csrf_token_default=07a8ffb6d249f30aaacb663c962296d4'

响应参数

参数名称	参数类型	是否必传	参数描述
•data	struct	TRUE	业务参数
◦next_cursor	string	TRUE	用于查询下一页
◦has_more	bool	TRUE	是否有下一页
◦products	list < struct >	TRUE	线上数据列表
▪online_status	int	TRUE	product在线状态 1-在线 2-下线 3-封禁
▪product	ProductStruct	TRUE	商品
•product_id	string	TRUE	商品Id
•out_id	string	TRUE	外部商品id
•product_name	string	TRUE	商品名
•category_full_name	string	TRUE	品类全名
•category_id	int	TRUE	品类id
•product_type	int	TRUE	商品类型 1-团购 11-代金券 15-次卡
•biz_line	int	TRUE	业务线 1-闭环自研开发者 5-小程序
•account_name	string	TRUE	商家名
•sold_start_time	int64	FALSE	售卖开始时间
•sold_end_time	int64	FALSE	售卖结束时间
•create_time	int64	FALSE	创建时间
•update_time	int64	FALSE	更新时间
•out_url	string	FALSE	第三方跳转链接，小程序商品返回
•version	int64	FALSE	商品版本号
•pois	list < struct >	TRUE	店铺列表
◦supplier_ext_id	string	TRUE	接入方店铺id
◦poi_id	string	FALSE	poi id
◦supplier_id	int64	FALSE	店铺id
•attr_key_value_map	map < string,string >	FALSE	商品属性KV, 参考商品发布和查询能力的关键属性介绍。
▪sku	struct	TRUE	售卖单元
•sku_id	string	TRUE	sku id
•sku_name	string	TRUE	sku名
•origin_amount	int	TRUE	原价
•actual_amount	int	TRUE	实际支付价格
•stock	struct	TRUE	库存信息
◦limit_type	int	TRUE	库存上限类型，为2时stock_qty字段无意义 1-有限库存 2-无限库存
◦stock_qty	int	TRUE	总库存，limit_type=2时无意义
•out_sku_id	string	TRUE	第三方id
•status	int	TRUE	sku状态 1-在线 -1-删除
▪commission_info	struct	TRUE
•platform_take_rate	int64	TRUE	平台服务费率
◦error_code	int	TRUE	错误码
◦description	string	TRUE	错误描述
•extra	struct	TRUE	响应额外信息
◦error_code	int	TRUE	错误码
◦description	string	TRUE	错误描述
◦sub_error_code	int	TRUE	（弃用）子错误码
◦sub_description	string	TRUE	（弃用）子错误描述
◦now	int64	TRUE	（弃用）时间戳
◦logid	string	TRUE	请求日志ID

响应示例

正常示例

json复制
{
  "data": {
    "has_more": true,
    "next_cursor": "2",
    "products": [
      {
        "product": {
          "category_full_name": "运动健身·游泳馆·游泳馆",
          "out_id": "hch-life-0314-tg09",
          "owner_account_id": 7166966001467131917,
          "attr_key_value_map": {
            "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\"}]",
            "show_channel": "2",
            "use_time": "{\"use_time_type\":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\":\"其他说明信息-运动健身团购\"}]",
            "SupplierExtIdList": "[\"goods_v1_poi_001\"]",
            "appointment": "{\"need_appointment\":true,\"external_link\":\"urlxxx\",\"order_appointment_time_url\":\"urlxxx\",\"ahead_time_type\":1,\"ahead_day_num\":1}",
            "real_name_info": "{\"enable\":true,\"scene\":1}",
            "refund_need_merchant_confirm": "true",
            "EntryType": "1",
            "Images": "[\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505021658382380\",\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505050439696428\"]",
            "IsConfirmImme": "true",
            "OrderValidStart": "1638720000",
            "RefundPolicy": "2",
            "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\"}}",
            "use_date": "{\"use_date_type\":1,\"use_start_date\":\"2021-12-06\",\"use_end_date\":\"2033-03-03\"}",
            "DateRule": "{\"unavailable_date\":{\"date_list\":[\"2022-03-08\",\"2022-03-09\"],\"weekday_list\":[7,1,2,3,4],\"not_available_on_holidays\":true}}",
            "Description": "[\"商品描述-运动健身\"]",
            "Notification": "[{\"title\":\"标题\",\"content\":\"运动健身1.1\"}]",
            "TagList": "标签列表-待填写",
            "FrontCategoryTag": "[\"美食套餐\"]",
            "OrderValidEnd": "1993478399",
            "RecommendWord": "推荐语"
          },
          "category_id": 3001001,
          "product_id": "7119054118261606444",
          "biz_line": 1,
          "creator_account_id": 7107571250087643180,
          "product_type": 1,
          "account_name": "lh测试商家",
          "pois": [
            {
              "poi_id": 6601137575719602180,
              "supplier_ext_id": "goods_v1_poi_001",
              "supplier_id": 7112378515013584941
            }
          ],
          "product_name": "life测试-0223-011",
          "sold_end_time": 1799607528,
          "sold_start_time": 1646724999,
          "telephone": ["1234-4321"]
        },
        "sku": {
          "actual_amount": 996,
          "attr_key_value_map": {
            "limit_rule": "{\"is_limit\":true,\"total_buy_num\":9}",
            "market_price": "1900",
            "settle_type": "1",
            "use_type": "1",
            "code_source_type": "1"
          },
          "status": 1,
          "update_time": 1657769323,
          "create_time": 1657694409,
          "origin_amount": 1399,
          "sku_id": "7119054118261606444",
          "sku_name": "life测试-0223-011",
          "stock": {
            "limit_type": 1,
            "stock_qty": 88
          }
        },
        "commission_info": {
          "platform_take_rate": 0
        },
        "online_status": 1
      }
    ],
    "description": "",
    "error_code": 0
  },
  "extra": {
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "now": 1658200058,
    "logid": "202207191107380102252431250703EA46"
  }
}

异常示例

错误码

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		联系抖音处理