查询商品线上数据列表
接口说明
公告(公告日期:2025年5月13日):
为优化商户及技术服务商的体验,自2025年5月28日起,平台拟对【查询商品线上数据列表】接口进行优化,将对服务商角色返回授权商户下的全量商品(包含授权前创建的商品、代运营创建的商品),商户对此如有异议,请在公告后7日内通过在线客服联系平台。
- 查询本client_key(或绑定的账号)对应的商品线上列表
- 处于在线、下线、封禁状态的数据可以通过该接口查询到
- 支持查询来客上商家创建的商品数据 (其他服务商创建的商品查不到)
- 新增query_all_poi,支持商家查询全量poi
- 对于在创建商品接口中,一次审核都没有通过的商品,接口查询不到
使用限制
SLA:支持的最大QPS:20;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/goods/product/online/query/ |
| HTTP Method | GET |
| Scope | life.capacity.goods.query |
| 权限要求 | 1. 需要申请权限 ,路径:抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案
2. 需要商家授权,路径:抖音来客>店铺管理>第三方应用授权 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query展开全部子属性
account_idString
商家ID,传入时服务商须与该商家满足授权关系
countInt64
分页数量,不传默认为5,最大上限50
cursorString
第一页不传,之后用前一次返回的next_cursor传入进行翻页
ext_idsArray<Int64>
外部门店ID list,可支持最多传入100家门店
goods_creator_typeEnum
区分商品创建者的查询方式
0 - 查询服务商/开发者创建的商品
1 - 查询商家(account_id)创建的商品
展开子属性
goods_query_typeEnum
新商品查询参数,使用goods_query_type这个的时候,goods_creator_type不生效
自研商家goods_query_type传2(自研商家可以查询全量商品,包含自研商家自己创建以及代运营或服务商等身份创建的商品)
服务商goods_query_type传3
goods_query_type为1仅限餐饮KA商家可用,不推荐传1,可能会出现不返回信息的情况
展开子属性
poi_idsArray<Int64>
门店ID list,可支持最多传入100家门店
product_nameString
商品名称(长度不超过30,支持模糊搜索)
query_all_poiBool
是否查询商品全量关联门店
设置为true时,分页数量最大上限为20
statusEnum
筛选在线状态,1-在线 2-下线 3-封禁
展开子属性
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/goods/product/online/query/?goods_creator_type=1&product_name=WfJO9MgUGk&ext_ids=[2208948699571478565]&account_id=VhPYXHiPSQ&Base={"Client":"KSACTUCNsn","TrafficEnv":{"Open":false,"Env":"9DQ6YWlvJe"},"Extra":{"S7Mk9AfEXy":"CC0T2TUrOj"},"LogID":"f9WxMwHIZN","Caller":"SBgdvbHV8g","Addr":"YPVsA0LW4B"}&goods_query_type=1&cursor=1Wvs1BGpK1&status=1&poi_ids=[4608202038377612061]&count=2855227930280639001&query_all_poi=false' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
BaseResp必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
业务参数
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "has_more": false, "error_code": 0, "description": "", "products": [ { "online_status": 1, "sku": { "actual_amount": 8336785459429117000, "create_time": 1062887442936770300, "extra": "7JD6oupf7Z", "sku_ext": { "bind_skus_2c": { "6086788367474154267": [ 1345298239032568600 ] }, "discount_promo": { "PromoId": 2649305387007973400, "PlanId": 8026144808210901000, "BrandActivityId": 9204202820244903000 }, "bind_sku_id": 1906279662032836400, "rel_rule_list": [ { "BizId": 8142974875831079000, "SharedQty": 1001907767138503600, "StockRel": false, "PriceRel": false, "Coefficient": "AYQmuRYVKT", "ConstantVal": 2194725918723019300 } ], "takeaway_presale_info": { "takeaway_presale_product_id": 6392978248639516000, "takeaway_presale_sku_id": 1870404651538278000 }, "life_biz_code": "4lY2npexKd", "origin_stock_qty": 1362107483767810600, "bind_product_id": 33961313829454764, "c_mspu_id": 8677979871306126000, "use_sub_rel_stock": false, "settle_type": 2317104850011968000, "account_settle": false, "ori_skus": { "4146559015950663893": [ 1567204193549882400 ] }, "biz_id_2c_list": [ 296361837037168260 ] }, "bind_skus": [ "DTxhKmjej4" ], "update_time": 4982822667950509000, "sku_name": "jaNj6Algpj", "attr_key_value_map": { "8ZjjDvTvAM": "7CJ1p5hNba" }, "out_sku_id": "pmbPa8XigW", "origin_amount": 3671288837045189600, "stock": { "stock_qty": 8690943783932294000, "avail_qty": 2386109746989411300, "frozen_qty": 3209519998418082300, "sold_qty": 7074965457063148000, "sold_count": 7269795503877428000, "limit_type": 1 }, "status": 1, "sku_id": "dsfadfasdf-123rdfadsf" }, "commission_info": { "platform_take_rate": 1106762722427464100 }, "skus": [ { "sku_ext": { "discount_promo": { "PromoId": 8995961696122215000, "PlanId": 8106383441627096000, "BrandActivityId": 6071873427451763000 }, "biz_id_2c_list": [ 1787104514825795600 ], "settle_type": 1696447848123232300, "origin_stock_qty": 6131803440686239000, "bind_product_id": 2801096220052648000, "use_sub_rel_stock": false, "takeaway_presale_info": { "takeaway_presale_product_id": 1581053406826827500, "takeaway_presale_sku_id": 3634707095995203600 }, "rel_rule_list": [ { "Coefficient": "0dqWl5VZlG", "ConstantVal": 7544940895896628000, "BizId": 4063065416148884000, "SharedQty": 320065214457078800, "StockRel": false, "PriceRel": false } ], "ori_skus": { "5618475398412794721": [ 8740840305145690000 ] }, "bind_sku_id": 6533379781596333000, "c_mspu_id": 5234911135005401000, "account_settle": false, "life_biz_code": "0uHqORAECF", "bind_skus_2c": { "1180235846128695565": [ 9046289304774684000 ] } }, "sku_id": "dsfadfasdf-123rdfadsf", "update_time": 2166929800958051300, "origin_amount": 4650197161634469000, "extra": "YFHsrMe5dw", "sku_name": "9mtv7hFY3B", "create_time": 3175029795074178600, "actual_amount": 4356703159617585700, "out_sku_id": "d2pUvfTJQg", "status": 1, "stock": { "frozen_qty": 6197205597452928000, "sold_qty": 2467908613989093400, "sold_count": 9194516195780884000, "limit_type": 1, "stock_qty": 1345793799948401700, "avail_qty": 1325790758402817500 }, "bind_skus": [ "TEAsuYsMzA" ], "attr_key_value_map": { "kdOpe35ATD": "x9W4tJxDpC" } } ], "is_sell_out": false, "poi_sell_out_status": [ { "poi_id": "ai2vRnzJNP", "sell_out_status": 1, "sell_out_end_time": 4351929391471311400, "sell_out_start_time": 1627844547979261400 } ], "product": { "sold_end_time": 1712483222669542700, "product_ext": { "is_bind_clue_element": false, "eleme_extra_info": "RjYrNVus3l", "eleme_biz_code": "f7rcfsywwo", "agency_rate": 5678252799576778000, "test_extra": { "uids": [ "UOJXcbwsNO" ], "test_flag": false }, "display_price": { "high_price": 3068734472596935000, "low_price": 4051808846274691000 }, "auto_online": false, "category_out_id": "y9G907uNHh", "all_sku_sell_out": false }, "contact_name": "gLFXz4hIds", "open_biz_type": 1, "product_type": 1, "product_id": "dsfadfasdf-123rdfadsf", "category_id": 1076966769446394600, "biz_line": 1, "create_time": 3691154519199807500, "pois": [ { "poi_id": "PvB0tq1Lc4", "supplier_ext_id": "AGPoAgPT4S", "supplier_id": 5057328340801804000 } ], "product_sub_type": 1, "out_url": "4SeLxTZZJ8", "product_name": "zT7z6KlM51", "out_id": "kbshBb5kOY", "creator_account_id": 5085832657076972000, "sold_start_time": 6602025408142629000, "extra": "YIjkik9HQE", "telephone": [ "cYIqXBZ9lw" ], "update_time": 1369297610754936600, "account_name": "zUmDkOMmZx", "attr_key_value_map": { "1L5S5wiSXD": "0yU7FD7x3y" }, "version": 4067019615733048300, "owner_account_id": 3152047564481222000, "spu_id": "96CNPhLHvF", "category_full_name": "D0GY96DgXu", "desc": "DDd4W1PUZ8" } } ], "next_cursor": "5B32pJ5Soi" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20251105205901E07E98A11A39605296BD", "now": 1762347545 }, "BaseResp": { "StatusCode": 5998351915787571000, "Extra": { "GB4wGJg44d": "PpTIDJKmtt" }, "StatusMessage": "fPTjTB7M5q" } }
错误码
| 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 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
