查询商品线上数据
用于查询商品线上数据。
使用限制
无
接口说明
1、使用商品 ID 或外部商品 ID 查询商品线上数据。
2、线上数据是指:通过审核后可以被用户看到的数据,包括在线、下线状态的数据。
基本信息
HTTP URL | https://open.douyin.com/life/goods/product/online/get/ | |||
HTTP Method | GET | |||
Scope |
| |||
权限要求 |
|
请求头
无
请求参数
参数名称 | 参数类型 | 是否必传 | 参数描述 |
access_token | string | TRUE | 调用/oauth/client_token/生成的token,此token不需要用户授权。 |
product_ids | string | FALSE | 商品ID列表(逗号分隔) |
out_ids | string | FALSE | 外部商品ID列表(逗号分隔) |
请求示例
curl --location --request GET 'https://open.douyin.com/life/goods/product/online/get/?access_token=clt.xxxxx&out_ids=test-out-id'
响应参数
body 结构体:
参数名称 | 参数类型 | 是否必传 | 参数描述 |
data | struct | TRUE | 业务参数 |
- product_online_list | list < ProductOnline > | TRUE | 线上列表 |
-- online_status | int | TRUE | 在线状态 1-在线 2-下线 3-封禁 |
-- 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 | 第三方跳转链接,小程序商品必填 |
--- poi_list | 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 | 商品属性KV |
-- sku | SkuStruct | 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表示删除 |
-- commission_info | CommissionInfoStruct | TRUE | |
--- platform_take_rate | int64 | TRUE | 软件服务费率 |
base | struct | TRUE | 公共参数 |
- log_id | string | TRUE | 日志id |
- gateway_code | int | TRUE | 网关状态码 |
- gateway_msg | string | TRUE | 网关状态信息 |
- biz_code | int | TRUE | 业务状态码 |
- biz_msg | string | TRUE | 业务状态信息 |
响应示例
正常示例
暂无。
异常示例
暂无。
错误码
HTTP 状态码 | 错误码 | 描述 | 排查建议 |