文档中心 > API类目 > 酒店商品API

taobao.xhotel.rateplan.add (酒店产品库rateplan添加)

酒店产品库rateplan

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
rateplan_code String 必须 12345AAA
  • 最大长度:64
  • 卖家自己系统的Code,简称RateCode
    name String 必须 含早提前3天
  • 最大长度:64
  • 在淘宝搜索页面展示的房价名称。请注意名称里不要维护早餐信息,如果想设置早餐信息,请设置breakfast_count字段即可
    english_name String 可选 aaa
  • 最大长度:60
  • RP的英文名称
    payment_type Number 必须 1 支付类型,只支持:1:预付5:现付6: 信用住7:预付在线预约8:信用住在线预约。其中5,6,7,8四种类型需要申请权限
    breakfast_count Number 必须 1 -1:状态早餐,有具体几人价有关系,几人价是几份早餐;0:不含早1:含单早2:含双早N:含N早(-1-99可选)
    fee_breakfast_count Number 可选 1 废弃
    fee_breakfast_amount Number 可选 1 不推荐使用
    fee_gov_tax_amount Number 可选 1 不推荐使用
    fee_gov_tax_percent Number 可选 1 不推荐使用
    fee_service_amount Number 可选 150 不推荐使用
    fee_service_percent Number 可选 15 不推荐使用
    extend_fee String 可选 aaa
  • 最大长度:500
  • 不推荐使用
    min_days Number 可选 1
  • 默认值:1
  • 最小入住天数(1-90)。默认1,小时房RP请设置为1
    max_days Number 可选 90
  • 默认值:90
  • 最大入住天数(1-90)。默认90 信用住不超过9天,小时房RP请设置为1
    min_amount Number 可选 1
  • 默认值:1
  • 首日入住房间数(1-99)。默认1。【废弃】
    min_adv_hours Number 可选 1
  • 默认值:0
  • 最小提前预定小时数,从入住当天的24点往前计算。例如如果这个字段设置了48,代表必须至少提前两天预定,那么如果想预定24号入住,,必须在23号零点前下单。
    max_adv_hours Number 可选 3
  • 默认值:2160
  • 最大提前预定小时数,从入住当天的24点往前计算。例如如果这个字段设置了48,代表最多提前两天预定,那么如果想预定24号入住,,必须在23号零点以后下单。
    start_time String 可选 00:00
  • 默认值:00:00
  • 最大长度:5
  • 产品每日开始销售时间,start_time一定为当天时间
    end_time String 可选 00:00
  • 默认值:00:00
  • 最大长度:5
  • 产品每日结束销售时间,当end_time=12:00:00,表明可售时间从当天12点到次日的凌晨6点(扩展此信息主要为了描述尾房的rp)注意start_time一定是当天的时间。尾房18:00起可售
    cancel_policy String 必须 {"cancelPolicyType":1}|{"cancelPolicyType":2}|{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}|{"cancelPolicyType":5,"policyInfo":{"timeBefore":6}}|{"cancelPolicyType":6,"policyInfo":{"14":1}}
  • 最大长度:500
  • 退订政策字段,是个json串,参考示例值设置改字段的值。允许变更/取消:在XX年XX月XX日XX时前取消收取Y%的手续费,100>Y>=0允许变更/取消:在入住前X小时前取消收取Y%的手续费,100>Y>=0(不超过10条)。1.表示任意退{"cancelPolicyType":1};2.表示不能退{"cancelPolicyType":2};4.从入住当天24点往前推X小时前取消收取Y%手续费,否则不可取消{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}表示,从入住日24点往前推提前至少48小时取消,收取10%的手续费,从入住日24点往前推提前至少24小时取消,收取20%的手续费;5.从24点往前推多少小时可退{"cancelPolicyType":5,"policyInfo":{"timeBefore":6}}表示从入住日24点往前推至少6个小时即入住日18点前可免费取消;6.从入住日24点往前推,至少提前小时数扣取首晚房费{"cancelPolicyType":6,"policyInfo":{"14":1}}表示入住日24点往前推14小时,即入住日10点前取消收取首晚房费。 注意:支付类型为预付,那么可以使用所有的退订类型,但是必须是非担保;支付类型为面付或者信任住并且是无担保,那么只能使用1类型的退订;支付类型为面付或者信任住并且为担保,那么只能使用2,5类型的退订;支付类型为在线预约,那么只能使用1,2,5类型的退改。如果支付类型是面付或者信任住并且为担保,那么如果传了4或者6的退订,那么会强制转成类型5。支持多段时间,多间夜扣款。阶梯退手续费限制请查看https://hot.bbs.taobao.com/detail.html?postId=8892814
    extend String 可选 1
  • 最大长度:500
  • 个性化定制扩展信息的JSON。注:此字段的值需要ISV在接入前与淘宝沟通,且确认能解析
    status Number 必须 1 1:开启(默认)2:关闭。如果没传值那么默认默认值为1
    guarantee_type Number 可选 1 担保类型,只支持: 0 无担保 1 峰时首晚担保 2峰时全额担保 3全天首晚担保 4全天全额担保
    guarantee_start_time String 可选 18:00 分时担保每日开始担保时间。 (如果设置了峰时担保类型,那么峰时担保时间不能为空,并且必须大于等于8点)
    member_level String 可选 1,2,3,4,5
  • 最大长度:20
  • 双方映射后的会员等级。如需开通,需要申请权限,取值范围为:1,2,3,4,5,none。比如飞猪F3对应商家V4,则传4.(如果有疑问请联系对接技术支持)
    channel String 可选 A
  • 最大长度:20
  • 销售渠道。如需开通,需要申请权限。目前支持的渠道有 H:飞猪 O:钉钉商旅 A:集团内部商旅。如果只投放飞猪,改字段不用填写或者只填H;如果有多个用","分开。如果需要投放其他渠道,请联系飞猪运营或者技术支持。
    occupancy Number 可选 2 不推送则默认2人,如有低于2人的RP限制请推送该字段。
    vendor String 可选 taobao
  • 最大长度:50
  • 系统商,一般不填写,使用须申请
    first_stay Number 可选 1 需申请会员权限。是否是新用户首住优惠rp。1-代表是。0或者不填写代表否
    agreement Number 可选 2 废弃。价格类型字段:0.非协议价;1.集采协议价;如果不是协议价,请不要填写该字段。该字段有权限控制,如需使用,请联系阿里旅行运营。 如果不填写或者填写为0,默认是阿里旅行价
    cancel_before_day Number 可选 2
  • 最大长度:50
  • 不推荐使用,使用改规则
    cancel_before_hour String 可选 6
  • 最大长度:50
  • 不推荐使用,使用改规则
    breakfast_cal String 可选 [{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":0},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":1}] 在添加rateplan时,同时新增早餐日历。date:说明这条记录的早餐政策breakfast_count:这一天早餐的数量。>=-1,<=99。如果date为空,那么会去读取startDate和endDate(格式都为"yyyy-MM-dd"),即早餐正常属于一个时间段。-1为状态早餐,和最终绑定的几人价有关,如果是一人价那么就是我一份早餐,二人价就是两份早餐。请注意,该字段仅能维护从当前时间开始,10年以内的数据,如果超过10年,会报错。
    cancel_policy_cal String 可选 [{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":1} },{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}}] 在新增rateplan的同时新增取消政策日历。 json格式。 date:日历的某一天,格式为"yyyy-MM-dd" cancel_policy:日历某一天的价格政策。格式和限制同cancel_policy。 如果date为空,那么会读取startDate和endDate(格式都为"yyyy-MM-dd"),即取消政策属于某一个时间段。 注意:支付类型为预付,那么可以使用所有的退订类型,但是必须是非担保;支付类型为面付或者信任住并且是无担保,那么只能使用1类型的退订;支付类型为面付或者信任住并且为担保,那么只能使用2,5类型的退订;支付类型为在线预约,那么只能使用1,2,5类型的退改。如果支付类型是面付或者信任住并且为担保,那么如果传了4或者6的退订,那么会强制转成类型5。请注意,该字段仅能维护从当前时间开始,10年以内的数据,如果超过10年,会报错。阶梯退手续费限制请查看https://hot.bbs.taobao.com/detail.html?postId=8892814
    guarantee_cal String 可选 [{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":2,"guaranteeStartTime":"HH:mm"}},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":3,"guaranteeStartTime":"HH:mm"}}] 在新增rateplan的同时,新增担保日历。date:担保日历的某一天。guarantee:担保政策。其中有两个属性:guaranteeType,guaranteeStartTime。 guaranteeType的可选值同guaranteeType字段,详见guaranteeType字段。guaranteeStartTime格式为"HH:mm"。如果date为空,那么会读取startDate和endDate(格式都为"yyyy-MM-dd"),即担保政策属于某一个时间段。(如果设置了峰时担保类型,那么峰时担保时间不能为空,并且必须大于等于8点)。请注意,该字段仅能维护从当前时间开始,10年以内的数据,如果超过10年,会报错。
    effective_time Date 可选 2000-01-01 00:00:00 生效开始时间,用来控制此rateplan生效的开始时间,配合字段deadline_time一起限定rp的有效期
    deadline_time Date 可选 2000-01-01 00:00:00 生效截止时间,用来控制此rateplan生效的截止时间,配合字段effective_time一起限定rp的有效期
    rp_type String 可选 1 rp类型,1为小时房。目前只支持小时房。如果不是小时房rateplan,则不要填写。如果想要清空该字段可以传入none
    hourage String 可选 4 小时房入住时间跨度。小时房特有字段。比如4小时的小时房,那么值为4
    can_checkin_end String 可选 08:00 最早可选入住时间,小时房特有字段。格式为HH:mm
    can_checkin_start String 可选 16:00 最晚可选入住时间,小时房特有字段。格式为HH:mm
    max_child_age Number 可选 5 儿童最大年龄(0-18)
    min_child_age Number 可选 5 儿童最小年龄(0-18)
    max_infant_age Number 可选 5 婴儿最大年龄(0-18)
    min_infant_age Number 可选 5 婴儿最小年龄(0-18)
    dinning_desc String 可选 西餐 餐食描述
    is_student Number 可选 0 是否学生价,0:否;1:是。
    hid Number 可选 1 酒店id
    rid Number 可选 1 房型id
    out_hid String 可选 1 外部酒店id
    out_rid String 可选 1
  • 最大长度:64
  • 外部房型id
    super_rp_flag Number 可选 1 super rp标记,1是;0否
    base_rp_flag Number 可选 1 base rp标记,1是;0否
    guarantee_mode Number 可选 1 2 VCC担保 1 PCI担保 0 支付宝担保(信用住产品担保方式只能为支付宝担保)
    parent_rp_code String 可选 0 父rpid,使用场景:当一个rp发布变价rate的时候,记录父rp信息,用于下单时候传递约定的rpcode给外部
    parent_rpid Number 可选 0 父rpcode,使用场景:当一个rp发布变价rate的时候,用于下单时候传递约定的rpcode给外部
    operator String 可选 0 操作rateplan的来源
    tag_json String 可选 {"non-direct-RP":1,"super-could-price-change-RP":0,"base-could-derived-RP":1,"ebk-tail-room-RP":0} 新增RP时的 打标和去标 需求,
    source Number 可选 1 来源
    allotment_release_time String 可选 6 保留房提前x小时自动确认时间,比如设置为6 那么从入住当日24点往前推6小时即18:00以前可以自动确认有房,否则是待确认
    common_allot_release_time String 可选 6 普通保留房提前x小时自动确认时间,比如设置为6 那么从入住当日24点往前推6小时即18:00以前可以自动确认有房,否则是待确认
    resource_type String 可选 1 商品来源渠道。1:直采(直连酒店PMS), 1-1:直采(非直连) 2:携程系, 3:美团, 4:国内旅行社分销, 5:海外供应商。非酒店资源方卖家必须提供商品来源渠道,携程系包括携程、去哪儿、艺龙。
    bottom_price_flag Number 可选 0 是否底价加价,1是底价加价,0 非底价加价rp
    can_checkout_end String 可选 16:00 最晚可选离店时间,小时房特有字段。格式为HH:mm
    mem_disc_flag Number 可选 1 会员价支持标识,1表示支持会员价规则
    member_discount_cal String 可选 [{"c":"8","t":1,"s": "20191211","e":"20191225"}] 会员价加价规则。c:表示折扣百分比,例子8,意为会员价优惠8%,s:标识起始日期,e:表示截止日期,t:表示加价类型,0:代表折扣。会员价=售价*(1-c%)
    guest_limit String 可选 {"guestArea": 1,"guestSex": "MAN","guestAgeRange": "8-48"} RP入住人限制信息。JSON格式
    activity_type String 可选 1 RP参与的活动,3为尾房,4超级房券,8直连免房
    online_booking_binding_info String 可选 [{"itemId":1234235235,"skuId":1234235235,"priceRuleInfoList":[{"priceRuleNumber":"14235253"},{"priceRuleNumber":"14235253"},{"priceRuleNumber":"14235253"}]},{"itemId":1234235235,"skuId":1234235235,"priceRuleInfoList":[{"priceRuleNumber":"14235253"},{"priceRuleNumber":"14235253"},{"priceRuleNumber":"14235253"}]}] 在线预约关联关系推送,priceRuleNumber:加价规则序号

    响应参数

    名称 类型 示例值 描述
    rpid Number 200000 生成的rp id

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelRateplanAddRequest req = new XhotelRateplanAddRequest();
    req.setRateplanCode("12345AAA");
    req.setName("含早提前3天");
    req.setPaymentType(1L);
    req.setBreakfastCount(1L);
    req.setFeeBreakfastCount(1L);
    req.setFeeBreakfastAmount(1L);
    req.setFeeGovTaxAmount(1L);
    req.setFeeGovTaxPercent(1L);
    req.setFeeServiceAmount(150L);
    req.setFeeServicePercent(15L);
    req.setExtendFee("aaa");
    req.setMinDays(1L);
    req.setMaxDays(90L);
    req.setMinAmount(1L);
    req.setMinAdvHours(1L);
    req.setMaxAdvHours(3L);
    req.setStartTime("00:00");
    req.setEndTime("00:00");
    req.setCancelPolicy("{\"cancelPolicyType\":1}|{\"cancelPolicyType\":2}|{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}|{\"cancelPolicyType\":5,\"policyInfo\":{\"timeBefore\":6}}|{\"cancelPolicyType\":6,\"policyInfo\":{\"14\":1}}");
    req.setExtend("1");
    req.setStatus(1L);
    req.setEnglishName("aaa");
    req.setGuaranteeType(1L);
    req.setGuaranteeStartTime("18:00");
    req.setMemberLevel("1,2,3,4,5");
    req.setChannel("A");
    req.setOccupancy(2L);
    req.setVendor("taobao");
    req.setFirstStay(1L);
    req.setAgreement(2L);
    req.setBreakfastCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":0},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":1}]");
    req.setCancelPolicyCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":1} },{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}}]");
    req.setGuaranteeCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":2,\"guaranteeStartTime\":\"HH:mm\"}},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":3,\"guaranteeStartTime\":\"HH:mm\"}}]");
    req.setCancelBeforeHour("6");
    req.setCancelBeforeDay(2L);
    req.setEffectiveTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setDeadlineTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setRpType("1");
    req.setHourage("4");
    req.setCanCheckinEnd("08:00");
    req.setCanCheckinStart("16:00");
    req.setMaxChildAge(5L);
    req.setMinChildAge(5L);
    req.setMaxInfantAge(5L);
    req.setMinInfantAge(5L);
    req.setDinningDesc("西餐");
    req.setIsStudent(0L);
    req.setHid(1L);
    req.setRid(1L);
    req.setOutRid("1");
    req.setOutHid("1");
    req.setSuperRpFlag(1L);
    req.setBaseRpFlag(1L);
    req.setGuaranteeMode(1L);
    req.setParentRpCode("0");
    req.setParentRpid(0L);
    req.setOperator("0");
    req.setTagJson("{\"non-direct-RP\":1,\"super-could-price-change-RP\":0,\"base-could-derived-RP\":1,\"ebk-tail-room-RP\":0}");
    req.setSource(1L);
    req.setAllotmentReleaseTime("6");
    req.setCommonAllotReleaseTime("6");
    req.setResourceType("1");
    req.setBottomPriceFlag(0L);
    req.setCanCheckoutEnd("16:00");
    req.setMemDiscFlag(1L);
    req.setMemberDiscountCal("[{\"c\":\"8\",\"t\":1,\"s\": \"20191211\",\"e\":\"20191225\"}]");
    req.setGuestLimit("{\"guestArea\": 1,\"guestSex\": \"MAN\",\"guestAgeRange\": \"8-48\"}");
    req.setActivityType("1");
    req.setOnlineBookingBindingInfo("[{\"itemId\":1234235235,\"skuId\":1234235235,\"priceRuleInfoList\":[{\"priceRuleNumber\":\"14235253\"},{\"priceRuleNumber\":\"14235253\"},{\"priceRuleNumber\":\"14235253\"}]},{\"itemId\":1234235235,\"skuId\":1234235235,\"priceRuleInfoList\":[{\"priceRuleNumber\":\"14235253\"},{\"priceRuleNumber\":\"14235253\"},{\"priceRuleNumber\":\"14235253\"}]}]");
    XhotelRateplanAddResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_rateplan_add_response>
        <rpid>200000</rpid>
    </xhotel_rateplan_add_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部