尚途商旅系统接口说明书

1、尚途商旅系统接口说明书1 说明接口的传入、传出参数均采用json的数据格式；除非特殊说明，所有请求均采用POST方式提交数据约定：以下内容所提到的“编号、ID”均指尚途商旅系统的编号、ID，“外部编号、外部ID”指的是接口对接方的系统编号、ID2 修改记录DateVersionDescriptionAuthor2015-02-251.0Json_wang3 目录1说明22修改记录33目录44产品接口说明64.1车次查询接口64.2车次详情接口65订购单接口说明75.1生成火车票订单接口75.2验证火车票是否可预订接口75.3订购单审批接口75.4通知出票接口85.5订单列表查询接口85.6订单

2、详情查询接口85.7订购单取消接口86退票单接口说明106.1申请单退票接口106.2退票单申请审批接口106.3退票单取消接口106.4通知退票接口116.5退票单列表查询接口116.6退票单详情查询接口117反调通知方法127.1订购单审批结果回调接口127.2订单处理结果通知接口127.3退票单审批结果回调137.4退票单处理结果通知接口138参数实体说明148.1公共请求实体148.2公共请求返回实体148.3车次列表请求实体148.4车次列表返回实体158.5席位实体158.6车次实体168.7车次详情请求实体168.8车次详情返回实体168.9创建火车票订单请求实体178.10创建

3、火车票订单返回实体188.11验证火车票是否可预订请求实体188.12验证火车票是否可预订返回实体188.13订单列表请求实体198.14订单列表返回实体198.15订单详情请求实体208.16订单详情返回实体208.17订单取消请求实体218.18订单取消返回实体218.19创建火车票旅客信息实体228.20火车票订购单详情旅客信息实体228.21火车票退票单详情旅客信息实体238.22火车票订购单和退票单列表旅客信息实体238.23火车票创建退票单旅客信息实体248.24联系人实体248.25成本中心信息实体248.26审批信息实体258.27通知出票请求实体258.28通知出票返回实体2

4、58.29创建退票单请求实体258.30创建退票单返回实体268.31退票单申请审批请求实体268.32退票单申请审批返回实体268.33退票单取消请求实体278.34退票单取消返回实体278.35通知退票请求实体278.36通知退票返回实体278.37退票单列表请求实体288.38退票单列表返回实体288.39退票单详情请求实体298.40退票单详情返回实体299附录319.1预订类型319.2旅客类型319.3证件类型319.4出票结果319.5退票结果319.6订单状态329.7退票单状态329.8是否有空调329.9退票原因324 产品接口说明4.1 车站查询接口4.1.1 说明查询国

5、内火车站信息。4.1.2 详情GetStationList参数类型说明传入参数(request)BaseRequest公共请求实体返回(response)GetStationListResponse返回请求结果4.2 车次查询接口4.2.1 说明查询车次列表信息接口 4.2.2 详情QueryTrains参数类型说明传入参数(request)QueryTrainsRequest火车车次列表请求实体返回(response)QueryTrainsResponse返回请求结果4.3 车次详情接口4.3.1 说明查询车次详情信息4.3.2 详情QueryTrainDetails参数类型说明传入参数(r

6、equest)QueryTrainDetailsRequest火车车次详情请求实体返回(response)QueryTrainDetailsResponse返回请求结果5 订购单接口说明5.1 生成火车票订单接口5.1.1 说明 创建一张火车票订单记录5.1.2 详情CreateTrainOrder参数类型说明传入参数(request)CreateTrainOrderRequest公共包头，订单信息返回(response)CreateTrainOrderResponse返回请求结果5.2 验证火车票是否可预订接口5.2.1 说明 用于生成订单后，验证推送尚途之前的车票是否可预订5.2.2 详情

7、CheckTrainIsBookable参数类型说明传入参数(request)CheckTrainIsBookableRequest验证火车票是否可预订请求实体返回(response)CheckTrainIsBookableResponse返回请求结果5.3 订购单审批接口5.3.1 说明5.3.2 详情SubmitTrainOrder 参数类型说明传入参数(request)ByOrderNoRequest订单审批请求实体返回(response)BaseResponse返回请求结果5.4 通知出票接口5.4.1 说明调用该接口，通知尚途该订单可以执行出票操作。5.4.2 详情AskForIss

8、ueTrainTicket参数类型说明传入参数(request) ByOrderNoRequest通知出票请求实体返回(response)BaseResponse返回请求结果5.5 订单列表查询接口5.5.1 说明5.5.2 详情QueryTrainOrderList参数类型说明传入参数(request)QueryTrainOrderListRequest公共包头，订单列表请求实体返回(response)QueryTrainOrderListResponse返回请求结果5.6 订单详情查询接口5.6.1 说明5.6.2 详情QueryTrainOrderInfo参数类型说明传入参数(reque

9、st)ByOrderNoRequest订单详情请求实体返回(response)QueryTrainOrderInfoResponse返回请求结果5.7 订购单取消接口5.7.1 说明5.7.2 详情TrainOrderCancel参数类型说明传入参数(request)CancelOrderRequest公共包头，订单取消请求实体返回(response)BaseResponse返回请求结果6 退票单接口说明6.1 申请单退票接口6.1.1 说明订购单的退票申请6.1.2 详情CreateTrainReturnOrder参数类型说明传入参数(request)CreateTrainReturnOrd

10、erRequest创建退票单请求实体返回(response)CreateTrainReturnOrderResponse返回请求结果6.2 退票单申请审批接口6.2.1 说明调用商旅网火车票退票单发送短信/邮件审批功能6.2.2 详情SubmitTrainReturnOrder参数类型说明传入参数(request)ByOrderNoRequest退票单申请审批请求实体返回(response)BaseResponse返回请求结果6.3 退票单取消接口6.3.1 说明退票单取消6.3.2 详情CancelTrainReturnOrder参数类型说明传入参数(request)CancelOrderR

11、equest退票单取消请求实体返回(response)BaseResponse返回请求结果6.4 通知退票接口6.4.1 说明通知尚途退票6.4.2 详情AskForProcessTrainReturnOrder参数类型说明传入参数(request)ByOrderNoRequest通知退票请求实体返回(response)BaseResponse返回请求结果6.5 退票单列表查询接口6.5.1 说明6.5.2 详情QueryTrainReturnOrderList参数类型说明传入参数(request)QueryTrainReturnOrderListRequest退票单列表查询请求实体返回(re

12、sponse)QueryTrainReturnOrderListResponse返回请求结果6.6 退票单详情查询接口6.6.1 说明6.6.2 详情QueryTrainReturnOrderInfo参数类型说明传入参数(request)ByOrderNoRequest退票单详情请求实体返回(response)QueryTrainReturnOrderResponse返回请求结果7 参数实体说明7.1 公共请求实体7.1.1 说明该实体为请求实体基类，由各请求实体继承7.1.2 详情BaseRequest字段名变量名类型说明可空公司IDcompanyIdstring登录前可以为空N用户IDus

13、erIdstring用户ID（登录前可以为空）N会话IDsessionIdstring用于身份验证（登录前可以为空）N7.2 公共请求返回实体7.2.1 说明该实体为返回实体基类，由各返回实体继承7.2.2 详情BaseResponse字段名变量名类型说明返回代码codestring10000=成功，其他为错误执行结果描述descriptionstring7.3 通用订单请求实体7.3.1 说明继承自BaseRequest7.3.2 详情ByOrderNoRequest字段名变量名类型说明可空尚途订购单号OrderNostringN7.4 车次列表请求实体7.4.1 说明继承自BaseRequ

14、est7.4.2 详情P QueryTrainsRequest字段名变量名类型说明可空出发站FromStationNamestring城市或车站名称，可从车站查询接口获取（GetStationList）N到达站ToStationNamestring参考 出发地 描述N出发日期DepartureDateDateTime日期，格式为yyyy-MM-dd，如2011-12-01N7.5 车次列表返回实体7.5.1 说明继承自BaseResponse7.5.2 详情QueryTrainsResponse字段名变量名类型说明可空车次信息TrainInfoListList<TrainInfo>

15、7.6 席位实体7.6.1 说明7.6.2 详情SeatInfo字段名变量名类型说明可空席位类别SeatNamestring如：硬座、软卧、无座N席位参考票价SeatPricedecimalN席位是否可预订IsBookableboolTrue 是,False 否N7.7 车次信息实体7.7.1 说明7.7.2 详情TrainInfo字段名变量名类型说明可空出发时间StartTimestringN到达时间EndTimestringN出发站FromStationNamestringN到达站ToStationNamestringN出发站所属类别(始发/经停)FromPassingTypestring

16、N到达站所属类别(经停/终点)ToPassingTypestringN席位信息SeatListList<SeatInfo>由多种座位类型、票价组成，如硬座 75，软卧 116N服务费ServicePricedecimalN7.8 创建火车票订单请求实体7.8.1 说明继承自BaseRequest7.8.2 详情CreateTrainOrderRequest字段名变量名类型说明可空外部订购单号OutSideOrderNostringN出差授权号OaSerialnumberstringN车次号TrainNumberstring如，G70N出发站FromStationNamestring

17、如，广州南N出发时间StartDatedatetime格式1999-01-01 12:00N到达站ToStationNamestringN到达时间EndDatedatetime格式1999-01-01 12:00N席位信息SeatInfoSeatInfo由多个座位类型、票价组成，如硬座 75，软卧 116 详见N旅客信息PassengerListList<PassengerInfo>Y联系人信息ContactListContactInfoY发票信息InvoiceInfoInvoiceInfoY预订类型BookTypestring详见 附录 9.1Y7.9 创建火车票订单返回实体7.

18、9.1 说明继承自BaseResponse7.9.2 详情CreateTrainOrderResponse字段名变量名类型说明尚途订购单号OrderNostring7.10 验证火车票是否可预订请求实体7.10.1 说明继承自BaseRequest7.10.2 详情CheckTrainIsBookableRequest字段名变量名类型说明可空车次号TrainNumberstringN出发站FromStationstringN到达站ToStationstringN出发时间StartTimedatetime格式为yyyy-MM-dd HH:mmN席位类别SeatIDint例如：201 表示硬座N乘

19、客数量PassengerNumsintN7.11 验证火车票是否可预订返回实体7.11.1 说明继承自BaseResponse7.11.2 详情CheckTrainIsBookableResponse字段名变量名类型说明可空余票信息RemainderTicketsList<RemainderTicketInfo>是否可预订IsBookboolTrue 是，False 否7.12 余票信息实体7.12.1 说明7.12.2 详情RemainderTicketInfo字段名变量名类型说明可空坐席类别SeatNamestring如，硬座，无座等剩余票数TicketNumstring值为“

20、有”表示余票充足，值为“数字”表示剩余的余票的具体数量7.13 订单列表请求实体7.13.1 说明继承自BaseRequest7.13.2 详情QueryTrainOrderListRequest字段名变量名类型说明可空尚途订购单号OrderNostringY客户订单号OutsideOrderNostringY电子票号ElectronicNumberstringY订单状态OrderStatusint详见 附录 9.6Y旅客姓名PassengerNamestring车次TrainNumberstring出发日期开始FromStartTimestring格式yyyy-MM-dd出发日期结束From

21、EndTimestring格式yyyy-MM-dd到达日期开始ToStartTimestring格式yyyy-MM-dd到达日期结束ToEndTimestring格式yyyy-MM-dd客户制单人SubmitNamestring制单时间开始OperateStartTimestring格式yyyy-MM-dd制单时间结束OperateEndTimestring格式yyyy-MM-dd出票结果IssueStatusstring如：出票成功、出票失败、供应商取消页码PageIndexint为空默认为1页数PageSizeint为空默认返回50条，传入的最大值不能超过507.14 订单列表返回实体7.

22、14.1 说明继承自BaseResponse7.14.2 详情QueryTrainOrderListResponse字段名变量名类型说明可空订单信息OrderInfoListList<RBOrderInfo>N总数TotalCountint用于分页，默认为0N7.15 订单实体7.15.1 说明 7.15.2 详情RBOrderInfo字段名变量名类型说明可空订单基本信息BaseInfoOrderBaseInfo车次信息TicketTrainTicketTrain旅客信息PassengerListList<TrainPassenger>联系人信息ContactInfoC

23、ontactInfo成本中心信息CostListList<CostInfo>发票信息InvoiceInfoInvoiceInfo订单审批信息ApproveInfoApproveInfoData7.16 订单基本信息实体7.16.1 说明7.16.2 详情OrderBaseInfo字段名变量名类型说明外部订单编号outsideOrderNostring尚途订单编号orderNostring原订单编号originalOrderNostring退票单的原单编号，订购单时为空制单时间opDatestring客户制单人opNamestring订单状态statusTextstring如：待提交

24、订单类型orderTypeint产品类型productTypeint1：机票，5：酒店出票时间issueDatestring出差授权号oaSerialnumberstring7.17 发票信息实体7.17.1 说明7.17.2 详情InvoiceInfo字段名变量名类型说明发票邮寄地址InvoiceAddressstring发票收件人InvoiceRecipientsstring发票邮编InvoicePostCodestring7.18 订单详情返回实体7.18.1 说明继承自BaseResponse7.18.2 详情QueryTrainOrderInfoResponse字段名变量名类型说明可

25、空订购单信息OrderInfoRBOrderInfo7.19 订单取消请求实体7.19.1 说明继承自BaseRequest7.19.2 详情CancelOrderRequest字段名变量名类型说明可空尚途订购单号OrderNostringN取消原因CancelReasonStringY7.20 旅客信息实体7.20.1 说明7.20.2 详情PassengerInfo字段名变量名类型说明可空旅客姓名PassengerNamestringN旅客部门DepartmentIDstringN旅客性别SexstringN旅客国籍NationalitystringN证件类型CertificateType

26、int详见 附录 9.3N证件号码CertificateCodestringN出生日期BirthDatestring格式：2015-01-01Y旅客类型PassengerTypeint详见 附录 9.2N旅客手机号码MobilestringY成本中心CostListList<CostInfo>Y7.21 订单旅客信息实体7.21.1 说明7.21.2 详情TrainPassenger字段名变量名类型说明可空序号PassengerNoint旅客序号N旅客姓名PassengerNamestringN旅客所属部门IDDepartmentIDstringN旅客所属部门名称Departmen

27、tNamestring旅客性别Sexstring 如，男，女等N旅客国籍Nationalitystring如，中国N证件类型CertificateTypeint详见 附录 9.3N旅客手机号码MobilestringN席位SeatNumstringY实际票价TicketPricedecimalY旅客类型PassengerTypestring详见 附录 9.2N代购服务费ServicePricedecimalY电子订单号ElectronicOrderNostring在12306订购成功的单号Y出票/退票状态IssueStatusstring详见 附录 9.4Y出票/退票失败原因Reasonstr

28、ingY7.22 联系人实体7.22.1 说明7.22.2 详情ContactInfo字段名变量名类型说明订单编号orderNostring联系人名称contactNamestring手机号码mobilestring联系电话phonestring电子邮件emailstring7.23 成本中心信息实体7.23.1 说明7.23.2 详情CostInfo字段名变量名类型说明订单编号orderNostring成本中心名称costCenterNamestring成本中心idcostIdint成本金额amountdecimal备注remarkstring7.24 审批信息实体7.24.1 说明7.24

29、.2 详情ApproveInfoData字段名变量名类型说明可空流程FlowNamestring如，审批流程N节点IDActIdint如，1N操作人Operatorstring如，张三Y处理结果Resultstring如，通过Y操作时间OperateTimedatetime如，2015-03-02 11:36 Y备注RemarkstringY7.25 创建退票单请求实体7.25.1 说明继承自BaseRequest7.25.2 详情CreateTrainReturnOrderRequest字段名变量名类型说明可空尚途订购单号OrderNostringN外部退票单号OutsideReturnOr

30、derNostringN旅客信息PassengerListList<string>要退票的旅客集合（对接方的旅客编号）N退票原因Reasonint详见附录 9.7N退票其他原因OrtherReasonstringY退票单联系人信息ContactInfoContactInfoN7.26 创建退票单返回实体7.26.1 说明继承自BaseResponse7.26.2 详情CreateTrainReturnOrderResponse字段名变量名类型说明可空尚途退票单号ReturnOrderNostringN7.27 退票单列表请求实体7.27.1 说明继承自BaseRequest7.27

31、.2 详情QueryTrainReturnOrderListRequest字段名变量名类型说明可空尚途退票单号ReturnOrderNostringY尚途订购单号OrderNostringY外部退票单号OutsideReturnOrderNostringY电子票号ElectronicNumberstring12306订单号Y旅客姓名PassengerNamestringY车次号TrainNumberstring如，G70Y订单状态OrderStatusint详见附录 9.6Y出发日期开始FromStartDatestring格式：yyyy-MM-ddY出发日期结束FromEndDatestri

32、ng格式：yyyy-MM-ddY到达日期开始ToStartDatestring格式：yyyy-MM-ddY到达日期结束ToEndDatestring格式：yyyy-MM-ddY客户制单人SubmitNamestringY制单日期开始OperateStartDatestring格式：yyyy-MM-ddY制单时间结束OperateEndDatestring格式：yyyy-MM-ddY退票结果ReturnStatusint详见 附录 9.5Y页码PageIndexint分页索引Y页数PageSizeint每页条数，默认返回最大值50，Y7.28 退票单列表返回实体7.28.1 说明继承自BaseR

33、esponse7.28.2 详情QueryTrainReturnOrderListResponse字段名变量名类型说明可空退票单信息ReturnOrderInfoListList<RROrderInfo>Y总数TotalCountint用于分页，默认为0N7.29 退票单实体7.29.1 说明 7.29.2 详情RROrderInfo字段名变量名类型说明可空退票单基本信息BaseInfoOrderBaseInfoN车次信息TicketTrainTicketTrain12306订票单号N旅客信息PassengerListList<TrainPassenger>(旅客姓名、是否退票失败)N联系人信息ContactInfoContactInfoY审批信息ApproveInfoApproveInfoDataY合计TotalDecimal退票单未处理前，合计为空，已处理后，合计为退票成功旅客的实际退回+服务费的合计Y7.30 退票单详情返回实体7.30.1 说明继承自BaseResponse7.30.2 详情QueryTrainReturnOrderResponse字段名变量名类型说明可空退票单信息ReturnOrderInfoRROrderInfo7.31 车站查询返回实体7.31.1 说明继承自BaseResponse7.31.2 详情G