查询商品草稿数据列表收藏我的收藏
收藏
我的收藏用于查询商品草稿数据列表。
使用限制
无
接口说明
1、查询本 client_key(或绑定的账号)对应的商品草稿列表。
2、处于审核中、或审核成功、失败的数据可以通过该接口查询到。
3、服务商角色应用,只能查询通过开放平台 openapi 方式创建的商品数据,商户通过来客方式创建发布的商品无法返回
并且商品需要在商服关系授权之后创建的才会返回对应的商品数据。
4、商家自研角色应用可返回全量商品数据,包含来客创建商品。
基本信息
HTTP URL | ||||
HTTP Method | GET | |||
Scope | 商品查询 | |||
权限要求 |
|
请求头
参数 | 描述 | 必须 |
Content-Type | application/json | 是 |
access-token | 是 |
请求参数
Query 请求
参数名称 | 参数类型 | 是否必传 | 参数描述 |
cursor | string | FALSE | 第一页不传,之后用前一次返回的next_cursor传入进行翻页 |
count | int | FALSE | 分页数量,不传默认为5 |
status | int | FALSE | 过滤草稿状态,10-审核中 12-审核失败 1-审核通过 |
account_id | string | TRUE | 商家ID,传入时服务商须与该商家满足授权关系 |
请求示例
https://open.douyin.com/goodlife/v1/goods/product/draft/query/?status=12&count=10&account_id=123123123
响应参数
参数名称 | 参数类型 | 是否必传 | 参数描述 |
data | struct | TRUE | 业务参数 |
- next_cursor | string | TRUE | 用于查询下一页 |
- has_more | bool | TRUE | 是否有下一页 |
- products | list < ProductDraft > | TRUE | 草稿列表 |
-- draft_status | int | TRUE | 草稿状态 10-审核中 12-审核失败 1-审核通过 11-审核通过 20-商家审核中(老库存量数据,新接口保存后擦除) |
-- product | ProductStruct | TRUE | 商品 |
--- product_id | string | TRUE | 商品Id,创建时不必填写,更新时如有out_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-代金券 |
--- biz_line | int | TRUE | 业务线 1-闭环自研开发者 3-直连服务商 5-小程序 |
--- account_name | string | TRUE | 商家名 |
--- sold_start_time | int | FALSE | 售卖开始时间 |
--- sold_end_time | int | FALSE | 售卖结束时间 |
--- create_time | int | FALSE | 创建时间,保存时不必填写 |
--- update_time | int | FALSE | 更新时间,保存时不必填写 |
--- out_url | string | FALSE | 第三方跳转链接,小程序商品必填 |
--- pois | list < PoiStruct > | TRUE | 店铺列表 |
---- supplier_ext_id | string | TRUE | 接入方店铺id,保存时必传 |
---- poi_id | int | FALSE | poi id,保存时不必填写 |
---- supplier_id | int | FALSE | 店铺id,保存时不必填写 |
--- attr_key_value_map | map < string,string > | FALSE | |
-- sku | string | TRUE | 售卖单元 |
--- sku_id | string | TRUE | sku id,创建时不必填写 |
--- sku_name | string | TRUE | sku名 |
--- origin_amount | int | TRUE | 原价,团购创建时可不填,会根据商品搭配计算原价 |
--- actual_amount | int | TRUE | 实际支付价格 |
--- stock | StockStruct | TRUE | 库存信息 |
---- limit_type | int | TRUE | 库存上限类型,为2时stock_qty和avail_qty字段无意义 1-有限库存 2-无限库存 |
---- stock_qty | int | TRUE | 总库存,limit_type=2时无意义 |
---- avail_qty | int | TRUE | 可用库存,limit_type=2时无意义,始终保证stock_qty=avail_qty+frozen_qty+sold_qty |
---- frozen_qty | int | TRUE | 冻结库存,保存SKU时不填 |
---- sold_qty | int | TRUE | 售卖库存, 退款回滚,保存SKU时不填 |
---- sold_count | int | TRUE | 销量,退款不回滚,保存SKU时不填 |
--- out_sku_id | string | TRUE | 第三方id |
--- status | int | TRUE | 状态 1-在线 -1-删除 |
- 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 | int | TRUE | (弃用)时间戳 |
- logid | string | TRUE | 请求日志ID |
响应示例
正常示例
{ "data": { "description": "", "error_code": 0, "has_more": true, "next_cursor": "4", "products": [ { "draft_status": 10, "product": { "pois": [ { "poi_id": 6601137575719602180, "supplier_ext_id": "goods_v1_poi_001", "supplier_id": 7112378515013584941 } ], "product_name": "life测试-0223-011", "telephone": ["1234-4321"], "account_name": "lh测试商家", "category_full_name": "运动健身·游泳馆·游泳馆", "creator_account_id": 7107571250087643180, "category_id": 3001001, "product_id": "7119054118278268972", "product_type": 1, "attr_key_value_map": { "Notification": "[{\"title\":\"标题\",\"content\":\"运动健身1.1\"}]", "RefundPolicy": "2", "SupplierExtIdList": "[\"goods_v1_poi_001\"]", "description_rich_text": "[{\"note_type\":1,\"content\":\"其他说明信息-运动健身团购\"}]", "show_channel": "2", "RecommendWord": "推荐语", "TagList": "标签列表-待填写", "DateRule": "{\"unavailable_date\":{\"date_list\":[\"2022-03-08\",\"2022-03-09\"],\"weekday_list\":[7,1,2,3,4],\"not_available_on_holidays\":true}}", "EntryType": "1", "FrontCategoryTag": "[\"美食套餐\"]", "Images": "[\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505021658382380\",\"http://tosv.boe.byted.org/obj/aweme-upload-image/7038505050439696428\"]", "IsConfirmImme": "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\"}}", "customer_reserved_info": "{\"allow\":true,\"allow_tel\":true,\"allow_name\":true,\"allow_identity\":true,\"require_for_tel\":true,\"need_for_all\":true,\"reserved_reason\":\"留资原因\"}", "real_name_info": "{\"enable\":true,\"scene\":1}", "Description": "[\"商品描述-运动健身\"]", "OrderValidStart": "1638720000", "SortWeight": "0", "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}", "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\"}]", "refund_need_merchant_confirm": "true", "use_date": "{\"use_date_type\":1,\"use_start_date\":\"2021-12-06\",\"use_end_date\":\"2033-03-03\"}" }, "biz_line": 1, "out_id": "hch-life-0314-tg11", "sold_end_time": 1745607528, "sold_start_time": 1646724999 }, "sku": { "sku_name": "我改了", "status": 1, "stock": { "limit_type": 0, "stock_qty": 500 }, "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" }, "origin_amount": 1399, "sku_id": "7119054118278268972" }, "audit_msg": "" } ] }, "extra": { "description": "", "sub_error_code": 0, "sub_description": "", "now": 1658199933, "logid": "202207191105330101742511840402D90D", "error_code": 0 } }
错误码
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 | 联系抖音处理 |