文档中心 > API类目 > 门票-商品管理API

alitrip.ticket.rule.upload (【门票API2.0】景点门票规则维护接口)

景点门票规则维护接口。该接口同时支持新发规则和编辑现有规则,如果out_rule_id下没有发布过规则,则系统将判断为新发一个规则,否则认为是编辑现有规则。 对于新发布规则的情况,有些参数是必填的,请仔细查看各字段说明。对于编辑的情况,除out_rule_id外都是可选,编辑情况支持增量更新(某个参数不传则使用该规则上原有值)

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
out_rule_id String 必须 1234 商户票种规则id
out_rule_name String 可选 成人票规则 新发布规则时必填。商户票种规则名称
out_scenic_id String 可选 111 商户景点编码。新发布规则时必填,out_scenic_id与ali_scenic_id二选一,至少填写其中一个
ali_scenic_id Number 可选 24498 阿里旅行景点编码。新发布规则时必填,out_scenic_id与ali_scenic_id二选一,至少填写其中一个
rule_type Number 可选 0 可选,票种规则类型:0-实体票规则,1-电子票(包含手工票和直连票)规则。新发规则时不传 默认为1
rule_status Number 可选 0 可选,规则状态。0-生效,-1-失效。新发规则时不传 默认生效状态。
refund_type Number 可选 1 新发布规则时必填。退票类型。1-无条件退改, 2-有条件退改, 3-不可退改。
refund_desc String 可选 退票描述 (该字段已废弃,请使用结构化退改规则字段替代:refund_custom_rules)新发布规则时特殊选填。退票描述。当refund_type为2时,该字段必填
auto_refund_support Number 可选 1 可选,是否支持自动退款,0或为空时表示不支持。0-不支持,1-只支持"售中自动退款",2-只支持"过期未使用自动退款",3-同时支持"售中自动退款"和"过期未使用自动退款"
refund_custom_rules String 可选 [{type:1,days:2,hours:16,minutes:30,amount:20,unit:1},{type:2,hours:12,minutes:0,amount:50,unit:1},{type:3,hours:11,minutes:0,amount:60,unit:1},{type:4,days:7,hours:23,minutes:59,amount:80,unit:1},{type:5,amount:10000,unit:2}] 结构化自定义退款规则(json数组格式),当refund_type为2时,该字段必填。【type字段说明(特别注意:2和3不能同时存在):1(游玩日期前退改规则),2(游玩日期当日退改规则),3(区间票 游玩日期有效期内退改规则),4(游玩日期后退改规则),5(其他情况退改规则)。amount字段说明:收取的手续费。unit字段说明:手续费单位,1(票价百分比),2(固定金额,单位分)。】 【示例含义说明:1、游玩日期前2天16点30分前申请退款,每张票收取票价20%的手续费;2、(单日票)游玩日当天12点00分前申请退款,每张票收取票价50%手续费;3、(区间票)游玩日期有效期,最后一天11点00分前申请退款,每张票收取票价60%手续费;4、游玩日期后7天23点59分前申请退款,每张票收取票价80%手续费;5、其他情况,每张票收取固定100元手续费。】
visitor_require Number 可选 1 新发布规则时必填。出游人信息设置。1、不需要,2、仅需一位游客信息。3、需要所有游客信息。不填默认为1(不需要)。注:实体票(rule_type=2)不需要出游人信息,电子票(rule_type=1)一般是需要出游人信息
visitor_infos String 可选 2,3,4 新发布规则时特殊选填。需要的出游人信息,需要出游人信息时必填。 2:手机号,3:身份证,4:姓名,5:护照号码 6:护照姓名拼音。示例格式:2,3,4
visitor_limit_able Number 可选 1 新发布规则时必填。出游人 是否限购。1:限购,2:不限购
visitor_limit_mode Number 可选 1 新发布规则时特殊选填。限购模式:mode为1按天, mode为2按周, mode为3按月
visitor_limit_type Number 可选 0 新发布规则时特殊选填。限购类型。0-身份证限购, 1-手机号限购
visitor_limit_num Number 可选 2 新发布规则时特殊选填。限购数量
enter_type Number 可选 1 新发布规则时必填。入园类型。1-用兑换凭证直接入园,2-用兑换凭证换票入园
enter_voucher_type Number 可选 2 新发布规则时必填。入园使用的凭证类型。1、二维码,2、身份证,3、二维码或身份证,4:数字码,5、手机号,6、其它。当enter_type为1时,该字段只能选择1~3 。而当enterType为2时,该字段可设置1~6
enter_voucher_value String 可选 其他入园凭证类型 其他入园凭证类型。当enter_voucher_type=6时,填写其他入园凭证类型。
ticket_change_adderss String 可选 换票地址
  • 最大长度:200
  • 新发布规则时特殊选填。换票地址。当enter_type为2时,该字段必填。
    enter_address String 可选 景区入园地址 新发布规则时必填。景区入园地址。游客在景区的详细入园地址,请仔细填写。
    fee_include String 可选 门票费用包含 新发布规则时必填。门票费用包含,请详细说明该门票商品包含的费用信息。
    extra_desc String 可选 补充说明
  • 最大长度:800
  • 新发布规则时必填。门票商品一些游客须知的补充说明。800字符限制

    响应参数

    名称 类型 示例值 描述
    result ResultSet 1 result
    • first_result
    • TopTicketRuleResult
    • 1
    • 规则维护结果
    • └ id
    • Number
    • 1
    • 规则主键
    • └ out_rule_id
    • String
    • 1
    • 商家规则编码
    • └ name
    • String
    • 大门票不可退规则
    • 规则名称
    • └ ali_scenic_id
    • Number
    • 123
    • 阿里景点id
    • └ out_scenic_id
    • String
    • 123
    • 商家景点编码

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlitripTicketRuleUploadRequest req = new AlitripTicketRuleUploadRequest();
    req.setOutRuleId("1234");
    req.setOutRuleName("成人票规则");
    req.setOutScenicId("111");
    req.setAliScenicId(24498L);
    req.setRuleType(0L);
    req.setRuleStatus(0L);
    req.setRefundType(1L);
    req.setRefundDesc("退票描述");
    req.setAutoRefundSupport(1L);
    req.setRefundCustomRules("[{type:1,days:2,hours:16,minutes:30,amount:20,unit:1},{type:2,hours:12,minutes:0,amount:50,unit:1},{type:3,hours:11,minutes:0,amount:60,unit:1},{type:4,days:7,hours:23,minutes:59,amount:80,unit:1},{type:5,amount:10000,unit:2}]");
    req.setVisitorRequire(1L);
    req.setVisitorInfos("2,3,4");
    req.setVisitorLimitAble(1L);
    req.setVisitorLimitMode(1L);
    req.setVisitorLimitType(0L);
    req.setVisitorLimitNum(2L);
    req.setEnterType(1L);
    req.setEnterVoucherType(2L);
    req.setEnterVoucherValue("其他入园凭证类型");
    req.setTicketChangeAdderss("换票地址");
    req.setEnterAddress("景区入园地址");
    req.setFeeInclude("门票费用包含");
    req.setExtraDesc("补充说明");
    AlitripTicketRuleUploadResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alitrip_ticket_rule_upload_response>
        <result>
            <first_result>
                <id>1</id>
                <out_rule_id>1</out_rule_id>
                <name>大门票不可退规则</name>
                <ali_scenic_id>123</ali_scenic_id>
                <out_scenic_id>123</out_scenic_id>
            </first_result>
        </result>
    </alitrip_ticket_rule_upload_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.OUT_SYS_EXCEPTION 外部系统异常 先尝试重试解决,如果重试不成功请钉钉联系枕戈或毕役
    isp.SYS_EXCEPTION 系统异常,可能是超时 先尝试重试解决,如果重试不成功请钉钉联系枕戈或毕役
    isv.OUT_SYS_EXCEPTION::ADD_OR_UPDATE_TICKET_RULE_PARAM_EXCEPTION 新增或更新门票规则信息时,部分字段设置不符合规范 请根据错误提示修改相应字段
    isv.PARAM_EXCEPTION 参数异常,一般是字段长度过长 请根据提示进行修改
    isv.ADD_OR_UPDATE_TICKET_RULE_PARAM_EXCEPTION
    isv.
    isv.PARAM_EXCEPTION::ENTER_VOUCHER_VALUE_TOO_LONG

    API工具

    如何获得此API

    FAQ

    返回
    顶部