生活服务商家应用 OpenAPI SDK 总览

OpenAPI

接入前准备

通用接口

餐饮

大交通

酒旅

会员通手机号格式说明&国家区号拆分能力

酒店通用错误码

酒店行业日历房解决方案

酒店行业新预售券解决方案

酒店行业新预售券常见枚举值

酒店静态信息自助获取

酒店会员管理

住宿预售券交易正向

酒旅商品上架和下架信息推送

物理房型静态信息自助获取

物理房型上下架

住宿预售券创建和更新

预售券线上开票

住宿预售券交易逆向

主动拉取价量态

物理房型静态信息匹配/创建/更新

房价/房态/房量更新

酒店静态信息匹配/创建/更新

酒店账单详情查询

度假行业解决方案

景区行业日历票解决方案

景区团购（在线预约）

景区团购三方码方案

综合

历史版本文档（不推荐）

可订检查
收藏
我的收藏

接口说明

抖音侧调用第三方进行可订检查。如果检查结果不可订，第三方需要返回价量信息进行价量更新

基本信息

Scope	life.capacity.trip_trade_order
权限要求	住宿预售券交易正向能力

请求头

•

Content-Type：application/json

•

X-Bytedance-Logid: 请求 logid，用于问题排查

•

x-life-clientkey: 服务商应用的 client_key

•

X-life-sign: 请求签名，签名规则

请求体

参数名称	参数类型	必须参数	备注
» rate_plan_id	string	必填	抖音售卖房型ID
» biz_type	int	必填	2011：酒店预售券 2012:酒店预约单 2021:日历房
» check_in_date	string	必填	入住日期 yyyy-MM-dd
» check_out_date	string	必填	离店日期 yyyy-MM-dd
» daily_rates	list	选填	单日单间价格
»» original_amount	int	必填	原始价格(分)，对于非中国大陆商家，代表税后价支持传0和-1，表示清除价格
»» amount_before_tax	int	选填	税前价，非中国大陆商家使用
»» currency	string	选填	发单价格币种，CNY，USD国际标准枚举值非中国大陆商家必填
»» period_start_date	string	必填	时间段开始时间yyyy-MM-dd
»» period_end_date	string	必填	时间段结束时间yyyy-MM-dd
»» period_start_time	string	选填	开始时间点，新增选择钟点房时为必填,格式 yyyy-MM-dd hh:mm:ss 钟点房第一次可订检查（提单）时无此时间，第二次可订检查（下单）时会传此时间，此时为必填
»» period_end_time	string	选填	结束时间点，新增选择钟点房时为必填，格式 yyyy-MM-dd hh:mm:ss 钟点房第一次可订检查（提单）时无此时间，第二次可订检查（下单）时会传此时间，此时为必填
»» usage_duration	int	选填	使用时长选择钟点房时为必填校验逻辑： 1.时长校验：1-23 2.支持填写最小时间为1，取整数，例如：使用1小时，使用2小时
» meals	list	选填	餐食信息
»» meal_type	Int	选填	餐食类型 1:早餐 2：中餐 3：晚餐 4:无餐食
»» meal_num	int	选填	餐食数量
» number_of_units	int	必填	预订间数
» number_of_guests	int	必填	入住人数，默认 1，可订时还未确定具体入住人
» total_amount	int	必填	总预约房型原始价格(分)，对于非中国大陆商家，代表税后价（取自三方同步到预约房型上的价格）
» amount_before_tax	int	选填	税前价，非中国大陆商家使用
» currency	string	选填	发单价格币种，CNY，USD国际标准枚举值非中国大陆商家必填
» occupancies	list<struct>	选填	入住人列表
»» first_name	string	选填	姓
»» last_name	string	选填	名
»» name	string	必填	姓名，加密
»» phone	string	必填	联系电话，加密
»» license_type	int	选填	1:身份证，2:港澳通行证，3:台湾通行证，4:回乡证，5:台胞证，6:护照，7:外籍护照
»» license_id	string	选填	证件 ID，加密
»»sex	int	选填	1:男，2：女
»»birthday	string	选填	出生日期，格式 yyyy-MM-dd
»»license_validity	string	选填	证件有效期，格式 yyyy-MM-dd，当证件类型不为身份证时，该字段必填
» sales_type	int	选填	售卖形式：默认为全日房；全日房：1 钟点房：2
»member_info	object	选填	会员信息
»»member_level	int	必填	会员等级
»»member_id	string	选填	会员卡号
»»member_name	string	选填	会员姓名
»»member_phone	string	选填	会员手机号（加密传输）
»order_tag	int	选填	订单标签：通兑:2

请求示例

{
    "rate_plan_id": "1763526448072717",
    "check_in_date": "2023-04-20",
    "check_out_date": "2023-04-23",
    "number_of_units": 1,
    "number_of_guests": 1,
    "total_amount": 10000,
    "amount_before_tax": 10000,
    "currency":"CNY",
    "daily_rates": [
        {
            "period_start_date": "2023-04-20",
            "period_end_date": "2023-04-21",
            "original_amount": 1000,
            "amount_before_tax": 1000,
            "currency":"CNY",
        }
    ],
    "biz_type": 2011,
    "meals": [
        {
            "meal_type": 1,
            "meal_number": 1
        }
    ],
    "occupancies": [
        {
            "first_name":"",
            "last_name":"",
            "name": "test",
            "phone": "13111111111",
            "license_type": 1,
            "license_id": "422202000000000000"
        }
    ]
}

响应参数

ARI 数据为可用性检查失败之后价量态更新的途径，请务必返回 ari 数据以及时更新价量态数据。

参数名称	参数类型	必须参数	备注
data	struct	必填
» error_code	int	必填	错误码详见
» description	string	选填	描述信息
» ari	struct	选填	价量信息同商品价量同步接口结构，价量态异常必须返回
»» stock_and_amount	list<struct>	选填
»»» original_amount	int	选填	初始价格
»»»currency	string	选填	发单价格币种，CNY，USD国际标准枚举值非中国大陆商家必填
»»» available	bool	选填	房态开关
»»» inventory	int	选填	房量
»»» room_id	string	必填	物理房型ID
»»» days_of_week	list<struct>	选填	指定周几设定价格
»»» fplos	string	选填	fplos=“0111011”，则表示允许连住2天,3天,4天,6天,7天；但是不允许连住1天,5天； •抖音支持最长传入14天 •fplos中只要有“1”存在，那么总房态available就应该置为true
»»»length_of_stay	int	选填	连住天数。适用于连住（LosRate）场景下，不同连住天数具有单独的连住ARI。 •length_of_stay字段值应大于1，当不传或者传入1时，不会被认定为LosRate模式，而是当作单日ARI处理 •length_of_stay字段值最大不能超过7天
»»»los_rate_break_down	list<object>	选填	连住模式下单日价格明细列表 •列表长度需要和length_of_stay的值相等 •按列表顺序设定每天价格，即当length_of_stay = 3时，los_rate_break_down[0]为第一天的价格，los_rate_break_down[1]为第二天的价格，依此类推。
»»»»day_original_amount	int	选填	单天售卖原价
»»»»day_amount_before_tax	int	选填	单天售卖税前价
»»» rate_plan_id	string	必填	售卖房型ID
»»» timerange	struct	必填	时间范围
»»»» start	string	选填	开始日期 eg. 2022-01-01
»»»» end	string	选填	结束日期 eg. 2022-01-04

json示例

{
  "data":{
    "error_code": 1778188764,
    "description": "OZtOwrZBj3",
    "ari": {
        "stock_and_amount": [{
            "rate_plan_id": "Auw86n90Ou",
            "timerange": {
                "start": "j96XibaTfx",
                "end": "ZsncqfNiDM"
            },
            "original_amount": 4257910994464362029,
            "available": false,
            "inventory": 5360120789126629208,
            "room_id": "7zj9VniZFe",
            "days_of_week": [
                622971533106306810
            ]
        }]
    }
  }
}

错误码

枚举id	参数名称	备注
0	成功
1	房型不存在/失效	整个商品维度失效和不存在，请和 18 错误码区分使用。
2	入住总人数超过上限
3	不符合最大/最小连住天数限制
4	入住时段内已满
5	日期格式错误
6	姓名/联系电话格式错误
7	重复提交预订请求	如订单已经生成后收到重复请求，请返回成功，不要返回错误
8	价格与酒店实际价格不一致
9	订单不存在或状态异常
10	日期格式错误
11	手机号/证件号码已达到购买上限
12	购买该产品必须填写身份证号码
13	其他异常（服务商自定义）
14	会员信息不一致
18	日历房态关闭	日历维度的房态关闭
100	需要重试	三方如果需要重试传该code，目前在创单和支付通知场景生效

可订检查收藏我的收藏