价量态拉取接口
收藏
我的收藏接口说明
抖音侧调用第三方主动拉取价量态信息。
基本信息
Scope | life.capacity.trip_hotel_ari_cron_pull | |||
权限要求 | 酒店日历房解决方案-主动拉取价量态能力 | |||
使用场景 | 根据服务商提供配置,定时触发。配置需咨询抖音研发。 |
请求头
- •Content-Type:
application/json
- •X-Bytedance-Logid: 请求 logid, 用于问题排查用
- •x-life-clientkey: 服务商应用的 client_key
- •X-life-sign: 请求签名,签名规则
请求体
参数名称 | 参数类型 | 必须参数 | 备注 |
» hotel_ids | list<string> | 必填 | 抖音酒店ID |
» rate_plan_ids | list<string> | 选填 | 抖音售卖房型 ID |
» date_range | object | 必填 | 拉取时间范围
|
»» end | string | 必填 | 结束日期 eg. 2022-01-04 |
»» start | string | 必填 | 开始日期 eg. 2022-01-01 |
抖音的拉取和推送接口都是增量更新,时间范围外的日期会保持不变
请求示例
{ "hotel_ids": [ "7643219873621464" ], "date_range": { "start": "2023-01-01", "end": "2023-05-01" } }
相应参数
参数名称 | 参数类型 | 必须参数 | 备注 |
data | struct | 必填 | |
» room_rates | list<object> | 必填 | 价量信息 |
»» rate_plan_id | string | 必填 | 抖音售卖计划ID |
»» rate_avail_infos | list<object> | 必填 | 售卖计划的价量信息 |
»»» timerange | object | 必填 | 时间范围
|
»»»» end | string | 必填 | 结束日期 eg. 2022-01-04,不得早于今天 |
»»»» start | string | 必填 | 开始日期 eg. 2022-01-01,不能超过365天外 |
»»» original_amount | int | 必填 | 房价 支持传0和-1,表示清除价格 |
»»» retail_amount | int | 选填 | 门市价,单位分
|
»»» currency | string | 选填 | 发单价格币种,CNY,USD国际标准枚举值 非国内大陆商家必填 |
»»» available | bool | 必填 | 房态 |
»»» inventory | int | 必填 | 房量 |
»»» fplos | string | 选填 | fplos=“0111011”,则表示允许连住2天,3天,4天,6天,7天;但是不允许连住1天,5天;
|
»»» length_of_stay | int | 选填 | 连住天数。适用于连住(LosRate)场景下,不同连住天数具有单独的连住ARI。
|
»»»los_rate_break_down | list<object> | 选填 | 连住模式下单日价格明细列表
|
»»»»day_original_amount | int | 选填 | 单天售卖原价 |
»»»»day_amount_before_tax | int | 选填 | 单天售卖税前价 |
»»»meals | list< object > | 选填 | 餐食信息 (动态价格模式必填,静态价格模式置空即可) |
»»»»num | int | 必填 | 餐食数额
|
»»»»type | enum | 必填 | 餐食类别,早/中/晚,不能重复传递,若有多餐更改对应数额 (结构见公共结构2.2.6) |
»»» stay_rules | object | 选填 | 连住规则 (仅动态模式需要填) |
»»»» min_los | int | 选填 | 最小连住天数 (若有值,需保证>=1) |
»»»» max_los | int | 选填 | 最大连住天数 |
»»» cancel_rules | list<object> | 选填 | 取消规则 (动态价格模式必填,静态价格模式置空即可) |
»»»» cancel_type | enum | 必填 | 取消订单规则 (结构见公共结构2.2.4) |
»»»» cancel_time_type | enum | 选填 | 若取消订单规则为限时取消,该字段表示取消订单需要参考的时间点,例如以入住时间为参考,判断用户是否可取消。 (结构见公共结构2.2.2) |
»»»» cancel_offset_time | object | 选填 | 若取消订单规则为限时取消,该字段表示取消订单需要参考的时间时间长度,例如以入住时间为参考,长度6小时,则用户最晚可在入住前6小时取消。 |
»»»»» day | int | 选填 | |
»»»»» hour | int | 选填 | |
»»»»» minute | int | 选填 | |
»»»» cut_type | enum | 选填 | 取消扣费类型 (结构见公共结构2.2.3) |
»»»» cut_value | int | 选填 | 取消扣费数额 可选 0% 10% 30% |
»»» book_rules | object | 选填 | 预约规则 (动态价格模式必填,静态价格模式置空即可) |
»»»» midnight_room | object | 选填 | 凌晨房设置(动态模式,开启T-1价量态拉取需联系开发配置) |
»»»»» is_midnight_room | bool | 选填 | 是否开启凌晨房 关闭:false,开启:true。默认为false关闭 |
»»»»» latest_booking_time | int | 选填 | 最晚预定时间 次日凌晨1-6点 |
»»»»»» max_advance_time | object | 选 填 | 最晚提前预定限制 |
»»»»»»» day | int | 选填 | 最早(最多)提前xx天预定
|
»»»» check_in_from | string | 选填 | 最早入住时间,仅支持整点,当和酒店入住时间保持一致可不传 |
»»»» check_out_to | string | 选填 | 最晚离店时间,仅支持整点,当和酒店入住时间保持一致可不传 |
»»»» check_in_to | string | 选填 | 最晚入住时间,仅支持整点,当和酒店入住时间保持一致可不传 |
»»»» applicable_people | list< object > | 选填 | 适用人 群,限制内宾或外宾(%不填默认为内外宾) (结构见公共结构2.2.5) |
»»»» max_quantity_limt | int | 选填 | 每单限购间数 |
»»» book_time_rules | object | 选填 | 预定时间规则
|
»»»» is_time_nextday | bool | 必填 | 预定时间段是否跨天
|
»»»» time_span | object | 必填 | 预定时间段 |
»»»»» from | string | 必填 | 可预定 开始时间
|
»»»»» to | string | 必填 | 可预定结束时间
|
»» status | bool | 必填 | 该售卖房型是否成功,成 功会更新该售卖房型 |
»» sub_error | string | 选填 | 子错误信息 |
»» sub_error_code | int | 选填 | 子错误码 |
» timestamp | string | 必填 | 秒时间戳,取服务商返回数据时的时间 |
响应示例
{ "data": { "error_code": 0, "description": null, "room_rates": [ { "rate_plan_id": "723587692345234534", "rate_avail_infos": [ { "timerange": { "start": "2023-01-01", "end": "2023-05-01" }, "original_amount": 10000, "available": true, "inventory": 20, "length_of_stay":2, // 仅动态模式需要传 "stay_rules": { "min_los": 2, "max_los": 10 }, // 仅动态模式必传 "book_rules": { // 表示用户需要提前【1,30】天预约 "min_advance_time": { "day": 1 }, "max_advance_time": { "day": 30 }, "check_in_from": "12:00", "check_in_to": "15:00", "check_out_to": "10:00", "max_quantity_limt": 10, "applicable_people": [ 1, 2 ] }, // 仅动态模式必传 "cancel_rules": [ { "cancel_type": 2, "cancel_time_type": 2, "cancel_offset_time": { "day": 0, "hour": 6, "minute": 0 }, "cut_type": 1, "cut_value": 10 } ], // 仅动态模式必传 "meals": [ { "type": 1, "num": 1 } ] } ], "status": true, "sub_error": "售卖计划ID错误", "sub_error_code": 60021 } ], "timestamp": "17346834298", "status": true, "errors": [ "错误" ] } }