库存拉取
收藏
我的收藏接口说明
- 1.实时生效。
- 2.日历库存、时段库存均为非覆盖更新:比如第一次设置了7月1号到3号库存,若第二次仅更新了7月3号的库存。则7月1号、2号库存仍然生效,3号库存数完成更新。
基本信息
Header
- •Content-Type:
application/json
- •X-Bytedance-Logid: 请求 logid, 用于问题排查用
- •x-life-clientkey: 服务商应用的 client_key
- •X-life-sign: 请求签名,签名规则
接口说明
- •抖音侧定期拉取库存,默认拉取间隔30分钟,如若修改拉取频次,可提前联系抖音对接人员
入参
request(请求入参) | ||||
字段 | 名称 | 是否必填 | 参数类型 | 字段规则说明 |
account_id | 商家ID | 是 | string | 来客商家id |
poi_id | 抖音门店Poiid | 是 | string | |
sku_info_list | sku信息列表 | 是 | List<SkuInfoStruct> | 需要被拉取的skuid |
-sku_id | 抖音侧skuId | 是 | string | |
-sku_out_id | 商家系统内skuId | 否 | string | |
start_date | 开始日期 | 是 | string | 格式 2025-07-07。 需要被拉取的日期(具体时段等内容)。 |
end_date | 结束日期 | 是 | string | 格式 2025-07-07。需要被拉取的日期(具体时段等内容)。之后spi请求商家时,商家需返回该日期范围内的时段库存信息。 若填写该字段 spi返回值需要有该日期内时段库存信息。 超过七天的则只支持天维度日历。七天内则支持时段库存以及天库存 可以by accountId 维度配置拉取多少天的 |
返回值
| response(接口返回值) | ||||
| 字段 | 名称 | 是否必填 | 参数类型 | 字段规则说明 |
data | | | | | |
| account_id | 商家ID | 是 | string | 商家在抖音平台的id |
| poi_id | 抖音门店Poiid | 是 | string | |
| sku_real_time_stock_list | 实时库 存信息 | 是 | List<SkuRealTimeStockStruct> | 结构体定义见下。list内一个元素为一个sku库存信息 |
SkuIntervalCalendarStockStruct | ||||
字段 | 名称 | 是否必填 | 参数类型 | 字段规则说明 |
sku_id | 抖音侧skuId | 否 | string | sku id 和 skuOutId至少填写一个,若都填抖音侧优先使用skuId |
sku_out_id | 商家系统内skuId | 否 | string | 建议优先使用 |
real_time_stock_list | 实时库存 | 是 | List<RealTimeStockStruct> | 时段库存信息 |
-date | 日历日期 | 是 | string | 格式"2024-07-07"。时段库存最大只支持7天范围(含今天)。天维度库存最大支持70天 |
-start_time | 开始时间(时分) | 否 | string | 格式"09:00" 仅商品sku创建更新接口时的time_slot为时段库存时才可输入且必填。(即time_slot非1440min(24H))。 开始-结束时间的时间差,可以整除库存间隔时长 每个时段的划分,必须是抖音侧划分时段的子集(比如在创建sku时 timeSlot是45分钟,在调用本接口时,起止时间必须为从零点开始的45分钟的倍数,比如00:45、01:30以此类推) |
-end_time | 结束时间(时分) | 否 | string | 格式"23:00"。同start_time |
-available_stock | 剩余可用库存 | 是 | int | 剩余可售卖库存,不是 总库存~ 结合start_time end_time的使用说明:在start_time和end_time的时间段内,按照时间间隔长度(本接口入参time_slot)均分,每一个分片的库存均为available_stock的值。举个例子,start_time end_time分别为9:00,10:00,available_stock是10,本spi入参time_slot为30分钟,则 09:00到09:30为10,09:30到10:00为10 |
JSON示例
入参JSON
{ "account_id": "7369336395019601964", "poi_id": "7386539938621163564", "start_date": "2024-07-01", "end_date": "2024-07-08", "sku_info_list": [ { "sku_id": "1803360221761603", "sku_out_id":"XXX" }, { "sku_id": "1803360221761619", "sku_out_id":"XXX" }, { "sku_id": "1803360221777923", "sku_out_id":"XXX" } ] }
出参JSON
//请注意 必须以data格式开头 { "data": { "error_code": 0, "description": "", "account_id": "7369336395019601964", "poi_id": "7386539938621163564", "sku_real_time_stock_list": [ { "sku_id": "1803360221761603", "real_time_stock_list": [ { "date": "2024-07-02", "start_time": "10:00", "end_time": "12:00", "available_stock": 888 } ] } ] } }