用户工具

站点工具


3.1_实时航班搜索_国际机票_iticketshoppingv2_inside

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
3.1_实时航班搜索_国际机票_iticketshoppingv2_inside [2021/03/15 02:04]
doku
3.1_实时航班搜索_国际机票_iticketshoppingv2_inside [2025/03/18 07:56] (当前版本)
doku
行 1: 行 1:
-= 供应商代理接口说明 =+3.1实时航班搜索(ITicketShoppingV2)
  
-[toc]+==== 3.1.1请求参数 ====
  
-== 一、接口说明及约定  == 
  
-所有接口返回都会由 SearchResponse 或 GetResponse 装返回+^ 参数                                 ^ 类型      ^ 说明         ^ 必填  ^ 备注                          ^ 
 +| isDirection                        | String  | 飞行偏好       | Y   | 0=不限 \\ 1=直飞 \\ 2=中转        | 
 +| airline                            | String  | 航司         | N   | 可以传入多个,用逗号隔开                | 
 +| cabinType                          | String  | 舱位等级       | Y   | 0 经济舱 1 豪华经济舱 3 商务舱 4 头等舱   | 
 +| adultNumber                        | Int     | 成人数量       | Y                               | 
 +| childNumber                        | Int     | 儿童数量       | N                               | 
 +| infantNumber                       | Int     | 婴儿数量       | N                               | 
 +| odList                             | Array   | 航段信息集合     | Y                               | 
 +| <del>stopOverStyle</del>           | Int     | 经停城市机场信息   | N   | <color #ed1c24>已停用</color> 
 +| <color #ed1c24>includeNDC</color>  | String  | 是否含NDC信息  | N   | 20210813新增 如不指定则默认0,不包含  <color #ed1c24>自2024/07/03日起 此字段已不支持</color>    |
  
-=== 1. SearchResponse 列表类 === 
  
-1. 结构说明 +odList
-| 序号 | 字段名      | 类型   | 备注                             | +
-| ---- | ----------- | ------ | -------------------------------- | +
-| 1    | Code        | string | 成功返回"20000",错误提示"400"   | +
-| 2    | Description | string | 详情描述成功可空,错误得有提示 | +
-| 3    | ResultCount | int    | 结果总数                         | +
-| 4    | Models      | object | 包含的返回的类型的列表           |+
  
-2例 +^参数         ^说明         ^必填 ^备注^ 
-```json+|departureCode |出发城市编码 |Y | 
 +|destinationCode|到达城市编码 |Y | | 
 +|departureDate |出发日期 |Y |格式:yyyy-MM-dd | 
 + 
 + 
 + 
 +==== 3.1.2请求样例 ==== 
 + 
 + 
 +==== 单程 ==== 
 + 
 +<code>
 { {
-    "Code": "20000", +    "isDirection":"0", 
-    "Description": "", +    "airline":"", 
-    "ResultCount": 2+    "cabinType":"0"
-    "Models": [ +    "odList":[
-        { +
-            // Model 1 +
-        },+
         {         {
-            // Model 2+            "departureCode":"CAN", 
 +            "destinationCode":"SIN", 
 +            "departureDate":"2016-10-01"
         }         }
-    ]+    ]
 +    "adultNumber":1, 
 +    "childNumber":0, 
 +    "infantNumber":0
 } }
-``` 
  
-=== 2. GetResponse 实体类 ===+</code>
  
-1. 结构说明 +==== 往返 ====
-| 序号 | 字段名      | 类型   | 备注                             | +
-| ---- | ----------- | ------ | -------------------------------- | +
-| 1    | Code        | string | 成功回"20000",错误提示"400"   | +
-| 2    | Description | string | 详情描述:成功可空,错误得有提示 | +
-| 3    | Model       | object | 返回的类型                       |+
  
-2. 示例 +<code>
-```json+
 { {
-    "Code": "20000", +    "isDirection":"0", 
-    "Description": "", +    "airline":"", 
-    "Model": { +    "cabinType":"0", 
-        // Model +    "odList":
-    }+        { 
 +            "departureCode":"CAN", 
 +            "destinationCode":"SIN", 
 +            "departureDate":"2016-10-01" 
 +        }, 
 +        { 
 +            "departureCode":"SIN", 
 +            "destinationCode":"CAN", 
 +            "departureDate":"2016-11-01" 
 +        } 
 +    ], 
 +    "adultNumber":1, 
 +    "childNumber":0, 
 +    "infantNumber":0
 } }
-``` 
  
-== 二、接口列表 ==+</code>
  
-=== 1. SearchProductType 查询产品类型接口 ===+==== 多程 ====
  
-1. 定义 +<code> 
-查询产品类型,返回列表+
 +    "isDirection":"0", 
 +    "airline":"", 
 +    "cabinType":"0", 
 +    "odList":
 +        { 
 +            "departureCode":"CAN", 
 +            "destinationCode":"SIN", 
 +            "departureDate":"2016-10-01" 
 +        }, 
 +        { 
 +            "departureCode":"HKG", 
 +            "destinationCode":"BKK", 
 +            "departureDate":"2016-10-20" 
 +        }, 
 +        { 
 +            "departureCode":"BKK", 
 +            "destinationCode":"CAN", 
 +            "departureDate":"2016-11-01" 
 +        } 
 +    ], 
 +    "adultNumber":1, 
 +    "childNumber":1, 
 +    "infantNumber":
 +}
  
-2. 输入 +</code>
-+
  
-3. 输出 SearchResponse,Models 
-| 序号 | 字段名          | 类型   | 备注         | 
-| ---- | --------------- | ------ | ------------ | 
-| 1    | ProductTypeID   | int    | 产品类型 ID  | 
-| 2    | ProductTypeName | string | 产品类型名称 | 
  
-=== 2. SearchProductSubType 查询产品子类接口 
  
-1. 定义 +==== 3.1.3返回参数 ====
-根据输入参数,查询产品子类型,返回列表+
  
-2. 输入 +^参数 ^类型 ^说明 ^备注^ 
-序号 字段名        | 类型 | 是否必填 备注              +|code |String |是否调用接口成功 |20000表示成功,非20000表异常 
----- ------------- ---- -------- | ----------------- +|detail |Object |结果集   
-1    ProductTypeID int  否       | 产品类型 ID,必填 |+|description |String |描述 |当异常时记录异常信息 |
  
-3. 输出 SearchResponse,Models +detail:
-| 序号 | 字段名             | 类型   | 备注         | +
-| ---- | ------------------ | ------ | ------------ | +
-| 1    | ProductSubTypeID   | int    | 产品子类 ID  | +
-| 2    | ProductSubTypeName | string | 产品子类名称 | +
-| 3    | ProductTypeID      | int    | 产品类型 ID  |+
  
-=== 3. SearchProductDetailType 查询产品细类接口 ===+^参数 ^型 ^说明 ^备注^ 
 +|serialNumber |String |缓存key |下单时回传给接口 
 +|flightDetailList |Array |行程组 | | 
 +|payCurrency |String  |付款币种  | 客人支付订单时的币种 <color #ed1c24>20250318 新增</color>  |
  
-1. 定义 +flightDetailList:
-根据输入参数,查询产品细类,返回列表+
  
-2. 输入 +^ 参数             ^ 类型      ^ 说明                            ^ 备注  ^ 
-序号 字段名    类型 是否必填 | 备注              +flightID       String  行程ID 唯一标示,下单时将选择的航班信息ID回传给接口      
----- --------- ---- -------- | ----------------- +airline        String  航司                            <color #ed1c24>NDC产品计价时必须使用此字段作为计价接口的airline入参</color> 
-1    SubTypeID int  否       | 产品子类 ID,必填 |+airline_cn     String  | 航司中文名                             | 
 +financeDetail  Object  | 价格详情                          |     | 
 +| tripList       | Array   | 行程信息集合                        |     |
  
-3. 输出 SearchResponse,Models +financeDetail:
-| 序号 | 字段名                | 类型   | 备注         | +
-| ---- | --------------------- | ------ | ------------ | +
-| 1    | ProductDetailTypeID   | int    | 产品细类 ID  | +
-| 2    | ProductDetailTypeName | string | 产品细类名称 | +
-| 3    | SubTypeID             | int    | 产品子类型ID |+
  
-=== 4. SearchSupplierType 查询供应商类型接口 ===+^参数             ^类型     ^说明 ^备注^ 
 +|officeNumber     |String     |出票OFFICE      | | 
 +|airline     |String     |出票航司        | | 
 +|agencyPolicyRemark |String         |代理费政策限制  | | 
 +|rewardPolicyRemark |String     |奖励政策限制    |  
 +|financeList     |Array     |价格组      |每种乘客类型一条数据 | 
 +|refs             |Array     |扩展信息        | | 
 +| <color #ed1c24>RCVServiceFee</color>| Object| 退改废服务费   <color #ed1c24>20241017新增</color>                      | 
 +financeList:
  
-1. 定义 +^ 参数                 ^ 类型      ^ 说明       ^ 备注           ^ 
-根据输入参,查询供应商类型,返回列表+| passengerType      | String  | 乘客类型     | 0成人 1儿童 2婴儿  | 
 +| salePrice          | String  | 票面价      |              | 
 +| tax                | String  | 税金                    | 
 +| beforeReturn       | String  | 代理费点数                 | 
 +|                    |                  |              | 
 +| beforeReturnPrice  | String  | 代理费金额    |              | 
 +| afterReturnPrice   | String  | 奖励金额                  | 
 +| serviceFee         | String  | 服务费      |              | 
 +| saleTotal          | String  | 结算价      |              | 
 +| travelItinerary    | String  | 是否有行程单   | 0:无 1:有      | 
 +| beforeReturnMoney  | String  | 代理费直减金额  |              | 
 +| afterReturMoney    | String  | 奖励直减金额                | 
 +| <color #ed1c24>productType</color>    | String  | 产品类型 |   20210813新增 产品类型:BSP、NDC、合作商  |
  
-2. 输入 +tripList 
- +^参数 ^类型 ^说明 ^备注^ 
-3. 输出 SearchResponse,Models+|departureCode |String |发地 | 
 +|destinationCode |String |目的地 | 
 +|flightList |Array |航班信息集合 |
  
-| 序号 | 字段名         | 类型   | 备注     | +flightList:
-| ---- | -------------- | ------ | -------- | +
-| 1    | SupplierTypeID | int    | ID       | +
-| 2    | TypeName       | string | 类型名称 |+
  
-=== 5. SearchContractType 查询合同类接口+^ 参数                      ^ 类型      ^ 说明       ^ 备注                      ^ 
 +| airline                 | String  | 航司编码                             | 
 +| airlineName             | String  | 航司名      |                         | 
 +| flightNo                | String  | 航班号      |                         | 
 +| classNo                 | String  | 舱位                               | 
 +| departureCityName       | String  | 出发城市                             | 
 +| destinationCityName     | String  | 到达城市                             | 
 +| departureCityCode       | String  | 出发城市编码                           | 
 +| destinationCityCode     | String  | 到达城市编码                           | 
 +| departureAirportCode    | String  | 出发机场编码                           | 
 +| destinationAirportCode  | String  | 到达机场编码                           | 
 +| departureAirportName    | String  | 出发机场名    |                         | 
 +| destinationAirportName  | String  | 到达机场名    |                         | 
 +| departureDateTime       | String  | 出发日期时间                           | 
 +| arrivalDateTime         | String  | 到达日期时间                           | 
 +| seatNumber              | String  | 剩余座位数    | A:> 9:>=9 1-8:对应具体数量 
 +| equipment               | String  | 机型       |                         | 
 +| departureTerm           | String  | 出发机场航站楼  |                         | 
 +| destinationTerm         | String  | 到达机场航站楼  |                         | 
 +| duration                | String  | 飞行时长     | HH:mm                   | 
 +| codeShare               | String  | 共享航班                             | 
 +| stopOver                | Array   | 经停机场码    | |
  
-1. 定义 
  
-根据输入参数,查询供应商合同类型,返回列表+refs  
 +^参数 ^类型 ^说明 ^备注^ 
 +|fare_basis_code |String |运价基础 | |  
 +|free_baggage_allowance |String |行李信息 | |  
 +|origin |String |出发机场 | | 
 +|destination |String |到达机场 | |
  
-2. 输入 +RCVServiceFee 
-+^参数 ^类型 ^说明 ^备注^ 
 +|ChangeFeeCNY|Float|改签加收服务费 |无数据则以退票时为准 |  
 +|RefundFeeCNY|Float|退票加收服务费 | 无数据则以退票时为准|  
 +|VoidFeeCNY|Float|废票加收服务费 |数据则以退票时为准 | 
  
-3. 输出 SearchResponse,Models +==== 3.1.4返回样例 ====
-| 序号 | 字段名       | 类型   | 备注                 | +
-| ---- | ------------ | ------ | -------------------- | +
-   | ContTypeCode | string | 合同类型编码         | +
-| 2    | ContTypeName | string | 合同类型名称         |+
  
-=== 6. SearchSupplier 查询供应商接口 === +<code> 
- +{ 
-1定义 +    "code":"20000", 
- +    "detail":
-根据输入参数,查询供应商,返回列表+        "serialNumber":"c36d6c9f1e054618a61edba5510e52d5", 
 +        "flightDetailList":
 +            { 
 +                "flightID":"b8ac217c60398342", 
 +                "airline":"CZ", 
 +                "airline_cn":"南方航空", 
 +                "financeDetail":
 +                    "officeNumber":"SIA227", 
 +                    "airline":"CZ", 
 +                    "agencyPolicyRemark":"", 
 +                    "rewardPolicyRemark":",", 
 +                    "financeList":
 +                        { 
 +                            "passengerType":"0", 
 +                            "salePrice":"2990", 
 +                            "tax":"683", 
 +                            "beforeReturn":"0", 
 +                            "afterReturn":"0.5", 
 +                            "beforeReturnPrice":"0", 
 +                            "afterReturnPrice":"15", 
 +                            "serviceFee":"0", 
 +                            "saleTotal":"3658", 
 +                            "fare_type":"Published", 
 +                            "refs" :  
 +                            [ 
 +                                { 
 +                                    "fare_basis_code" : "MOWCN", 
 +                                    "free_baggage_allowance" : "30K", 
 +                                    "origin":"WUH", 
 +                                    "destination":"KHH", 
 + }, 
 +
 +                                    "fare_basis_code" : "OOWPROMO", 
 +                                    "free_baggage_allowance" : "30K", 
 +                                    "origin":"TPE", 
 +                                    "destination":"CAN" 
 + } 
 + ]
  
-2. 输入 +                        } 
-| 序号 | 字段名                 | 类型       | 是否必填 | 备注                                                         | +                    ] 
-| ---- | ---------------------- | ---------- | -------- | ------------------------------------------------------------ | +                }, 
-| 1    | IsPaging               | bool       | 否       | 是否分页                                                     | +                "tripList":[ 
-| 2    | PageIndex              | int        | 否       | 当前页码                                                     | +                    { 
-| 3    | PageSize               | int        | 否       | 每页数据行数                                                 | +                        "departureCode":"WUH", 
-| 4    | ProductTypeID          | list<int\> | 否       | 产品类型 ID,0 个或多个,如:5678 ]                  | +                        "destinationCode":"KHH", 
-| 5    | ProductSubTypeID       | list<int\> | 否       | 产品子类型 ID,0 个或多个,如:[ 5678 ]                | +                        "flightList":[ 
-| 6    | ProductDetailTypeID    | list<int\> | 否       | 产品细类型 ID,0 个或多个,如:[ 5678 ]                | +                            { 
-| 7    | SupplierName           | string     | 否       | 供应商名字,模糊查询<br />(同时模糊查询 【供应商全称】、【供应商简称】、【供应商编号】 ) | +                                "airline":"CZ", 
-| 8    | SupplierCode           | string     | 否       | 供应商编号,精确查询                                         | +                                "airlineName":"南方航空", 
-| 9    | AscriptionContractCode | string     | 否       | 签约主体编码,精确查询                                       | +                                "flightNo":"3093"
-| 10   | IsVerify               | bool       | 否       | 是否已通过审核(默认为合作中),当值为 true 时查询合作中,<br />为 false 时查出全部 |+                                "classNo":"K", 
 +                                "departureCityName":"武汉", 
 +                                "destinationCityName":"高雄"
 +                                "departureCityCode":"WUH", 
 +                                "destinationCityCode":"KHH", 
 +                                "departureAirportCode":"WUH"
 +                                "destinationAirportCode":"KHH", 
 +                                "departureAirportName":"武汉天河国际机场", 
 +                                "destinationAirportName":"高雄国际机场", 
 +                                "departureDateTime":"2019-01-31 14:30", 
 +                                "arrivalDateTime":"2019-01-31 17:15", 
 +                                "seatNumber":"A", 
 +                                "duration":"02:45", 
 +                                "equipment":"737", 
 +                                "departureTerm":"T3", 
 +                                "destinationTerm":"", 
 +                                "codeShare":"", 
 +                                "stopOver":[
  
-3. 输出 SearchResponse,Models+                                ] 
 +                            } 
 +                        ] 
 +                    }, 
 +                    { 
 +                        "departureCode":"TPE", 
 +                        "destinationCode":"WUH", 
 +                        "flightList":
 +                            { 
 +                                "airline":"CZ", 
 +                                "airlineName":"南方航空", 
 +                                "flightNo":"3098", 
 +                                "classNo":"Q", 
 +                                "departureCityName":"台北", 
 +                                "destinationCityName":"广州", 
 +                                "departureCityCode":"TPE", 
 +                                "destinationCityCode":"CAN", 
 +                                "departureAirportCode":"TPE", 
 +                                "destinationAirportCode":"CAN", 
 +                                "departureAirportName":"台湾桃园国际机场", 
 +                                "destinationAirportName":"广州白云国际机场", 
 +                                "departureDateTime":"2019-02-07 14:35", 
 +                                "arrivalDateTime":"2019-02-07 17:00", 
 +                                "seatNumber":"4", 
 +                                "duration":"02:25", 
 +                                "equipment":"330", 
 +                                "departureTerm":"2", 
 +                                "destinationTerm":"T2", 
 +                                "codeShare":"", 
 +                                "stopOver":[
  
-| 序号 | 字段名                 | 类型   | 备注                                                         | +                                ] 
-| ---- | ---------------------- | ------ | ------------------------------------------------------------ | +                            }, 
-| 1    | SupplierCode           | string | 供应商代码                                                   | +                            { 
-| 2    | SupplierName           | string | 供应商名称                                                   | +                                "airline":"CZ", 
-| 3    | SupplierShortName      | string | 供应商简称                                                   | +                                "airlineName":"南方航空", 
-| 4    | AscriptionContractCode | string | 签约主体编码                                                 | +                                "flightNo":"6589", 
-| 5    | AscriptionContract     | string | 签约主体全称                                                 | +                                "classNo":"Q", 
-| 6    | SubAscriptionContract  | string | 签约主体简称                                                 | +                                "departureCityName":"广州", 
-| 7    | SupplierTypeID         | int    | 供应商类型                                                   | +                                "destinationCityName":"武汉", 
-| 8    | SupplierTypeName       | string | 供应商类型名                                                 | +                                "departureCityCode":"CAN", 
-| 9    | VerifyStatus           | int    | 供应商状态,1-待生效,2-合作中,<br />3-暂停合作,4-新建,5-待审批,6-审批不通过,<br />7-待清查,8-终止合作,9-关闭 | +                                "destinationCityCode":"WUH", 
-| 10   | contractType           | int    | 合同类型ID                                                   | +                                "departureAirportCode":"CAN", 
-| 11   | contractTypeName       | string | 合同类型ID                                                   |+                                "destinationAirportCode":"WUH", 
 +                                "departureAirportName":"广州白云国际机场", 
 +                                "destinationAirportName":"武汉天河国际机场", 
 +                                "departureDateTime":"2019-02-07 19:25", 
 +                                "arrivalDateTime":"2019-02-07 21:25", 
 +                                "seatNumber":"A", 
 +                                "duration":"02:00", 
 +                                "equipment":"737", 
 +                                "departureTerm":"T2", 
 +                                "destinationTerm":"T3", 
 +                                "codeShare":"", 
 +                                "stopOver":[
  
-=== 7. GetSupplierDetail 取供应商详情接口 === +                                ] 
- +                            } 
-1. 定义 +                        ] 
- +                    } 
-根据输入参数,供应商(不限状态),返回供应商实体 +                ] 
- +            } 
-2. 输入 +        ] 
-| 序号 | 字段名                 | 类型   | 是否必填 | 备注                   | +    } 
-| ---- | ---------------------- | ------ | -------- | ---------------------- | +}
-| 1    | SupplierCode           | string | 是       | 供应商代码             | +
- +
-3. 输出 GetResponse,Model +
-| 序号 | 字段名                 | 类型           | 备注                                                         | +
-| ---- | ---------------------- | -------------- | ------------------------------------------------------------ | +
-| 1    | SupplierCode           | string         | 供应商代码                                                   | +
-| 2    | SupplierName           | string         | 供应商名称                                                   | +
-| 3    | SupplierShortName      | string         | 供应商简称                                                   | +
-| 4    | AscriptionContractCode | string         | 签约主体编码                                                 | +
-| 5    | AscriptionContract     | string         | 签约主体全称                                                 | +
-| 6    | SubAscriptionContract  | string         | 签约主体简称                                                 | +
-| 7    | SupplierTypeID         | int            | 供应商类型                                                   | +
-| 8    | SupplierTypeName       | string         | 供应商类型名                                                 | +
-| 9    | VerifyStatus           | int            | 供应商状态,1-待生效,2-合作中,<br />3-暂停合作,4-新建,5-待审批,6-审批不通过,<br />7-待清查,8-终止合作,9-关闭 | +
-| 10   | AccountList            | list<Account\> | 账号列表 (只返回有效账号)                                    | +
- +
-4. 子模型 Account,Model +
-| 序号 | 字段名                 | 类型   | 备注           | +
-| ---- | ---------------------- | ------ | -------------- | +
-| 1    | Account                | string | 账号        | +
-| 2    | AccountName            | string | 账号名称     | +
-| 3   | CurrCode               | string | 币种        | +
-| 4   | OpenBankName           | string | 开户行名称   |+
  
 +</code>
3.1_实时航班搜索_国际机票_iticketshoppingv2_inside.1615773849.txt.gz · 最后更改: 2021/03/15 02:04 由 doku