This is an auto-generated translation

行程 API 交付

通过行程安排,您可以显示客户的预订信息,并帮助他们找到 booking-related 产品或服务,例如旅游或体验。您还可以利用这些数据分析预订趋势,并为您的利益相关者创建报告。

配送选项

您的行程数据 API 交付方式可以是推送式或拉取式。

Push 机制

推送服务旨在以 near-real 时间为准发送行程更新,重点关注 transaction-level 的核心细节。此选项允许您:

  • 在您的网站或应用程序上显示客户的预订信息
  • 向旅行者提供更多旅行相关的产品和服务供其购买。

推送事件将通过 Webhook 发送到您提供的 URL,格式为 HTTP POST消息。这些消息可能无序到达,因此请参考 creation_dateupdate_date_time元素来确定顺序。

有关如何采用此交付选项的详细信息,请参阅API 设置

Pull 机制

该拉取服务提供详细的行程数据,以支持:

  • 数据分析
  • 检索推送失败时间段的数据
  • 服务台调查

此服务包含两个HTTP GET端点,允许您执行以下操作:

  • 使用 creation_date_startcreation_date_endupdate_date_time_startupdate_date_time_end变量创建指定时间范围内创建或更新的行程列表。
  • 按行程检索特定行程 itinerary_id

有关身份验证过程的详细信息,请参阅API 设置

可用字段

下表列出了通过我们的 Push 和 Pull 交付方式提供的字段,包括所有嵌套对象。

字段名称以名称开头,后跟英文句号(例如,<variable>.<nested variable>),表示嵌套关系。

白标旅游平台

字段名称定义示例
itinerary_id行程编号或销售网站订单参考编号。72622069245694
status行程及其各项的状态。可能的值:
已确认
已取消
creation_date*最初预订的日期,以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
update_date_time*行程的最后更新日期和时间,以 ISO 8601 日期格式表示(YYYY-MM-dd'T"HH:mm:ss.SSSZ)。2023-10-21T00:00:00.000Z
online指示行程是通过在线预订(是)还是通过代理商预订(否)。用布尔值表示。true
package表明该行程是套餐的一部分还是单独预订的。用布尔值表示。false
payment_type付款时使用的付款方式。可能的值:
信用卡
积分
分期付款
point_of_sale_country_code客户进行预订的销售网站的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。GB
purchaser预订人的身份证明。请参见 purchaser 表,获取嵌套项列表。 
property_booking_items作为行程的一部分预订的住宿组成部分。请参见 property_booking_items 表,获取嵌套项列表。 
flight_booking_items作为行程的一部分预订的机票组成部分。请参见 flight_booking_items 表,获取嵌套项列表。 
car_booking_items作为行程的一部分预订的租车组成部分。请参见 car_booking_items 表,获取嵌套项列表。 
activity_booking_items作为行程的一部分预订的活动组成部分。请参见 activity_booking_items 表,获取嵌套项列表。 
insurance_booking_items作为行程的一部分预订的保险组成部分。请参见 insurance_booking_items 表,获取嵌套项列表。 
rate预订项目或整个行程的价格和定价详情。请参见 rate 表,获取嵌套项列表。 
coupon适用于行程的优惠券(如适用)。请参见 coupon 表,获取嵌套项列表。 
|

预订人

以下字段可识别预订人。

字段名称定义示例
purchaser.email**预订人的邮箱地址。smith@example.com
purchaser.loyalty_id**会员计划会员身份标识符。12345678
purchaser.first_name**预订人的名字。
purchaser.last_name**预订人的姓氏。史密斯

property_booking_items

这些字段列出了作为行程的一部分预订的住宿组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882912
status特定住宿元素的状态。可能的值:
已确认
已取消
checkin_date*相应住宿元素的入住日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-01
checkout_date*相应住宿元素的退房日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
property.idExpedia Group 是酒店或度假租赁物业的唯一标识符。1400882912
property.chain_name住宿所属连锁酒店的名称(如适用)。独立
property.brand_name住宿所属品牌的名称(如适用)。一个连锁酒店可能有多个品牌。萨沃伊特色酒店
property.name酒店或度假短租屋的名称。酒店 1
property.city住宿所在城市的名称。多伦多
property.state_province_name住宿所在州或省的名称。安大略
property.country_code住宿所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
property.star_rating住宿的星级。3.0
room_name酒店或度假租赁公司定义的预订房间类型。Comfort 双人房带独立浴室
adult_count相应预订中包含的成人人数。2
child_count相应预订中包含的儿童人数。0
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
property_confirmation_id***酒店或度假租赁公司提供的确认号码。1516171819
rate住宿预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

flight_booking_items

这些字段列出了作为行程的一部分预订的机票组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882911
status特定机票行程元素的状态。可能的值:
已确认
已取消
departure_date*相应的机票行程元素的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-01
arrival_date*相应的机票行程元素的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-02
airline.plating_carrier_name出票航空公司的名称。加拿大航空
airline.plating_carrier_code国际航空运输协会 (IATA) 代码,即出票航空公司的代码。AC
carrier_pnr航空公司出票处记录的乘客姓名。SMITH
trip_type预订的行程的类型。可能的值:
单程
往返
多个目的地
fare_class机票的票价等级。经济型
airport_origin_code始发机场的 IATA 代码。LHR
airport_origin_location始发机场的位置。英国伦敦(LHR - 希思罗机场)
airport_destination_code到达机场的代码。以 IATA 格式表示。YYZ
airport_destination_location到达机场的位置。安大略省多伦多(YYZ - 莱斯特-皮尔逊国际机场)
ticket_number航班机票号码。123456789
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
segment_count航班机票的航段数。1
rate航班预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

car_booking_items

这些字段列出了作为行程的一部分预订的租车组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882910
status特定租车行程元素的状态。可能的值:
已确认
已取消
pickup_date*租车行程元素的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-02
return_date*租车行程元素的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
rental_company.name***租车公司的名称。Hertz
car_type***租车的类型。2/4 门紧凑型
pickup_location取车地点。荷兰鹿湖(YDF - 鹿湖地区机场)
pickup_country_code***取车地点的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
return_location还车地点。荷兰鹿湖(YDF - 鹿湖地区机场)
return_country_code***还车地点的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
trip_type预订的行程的类型。可能的值:
单程
往返
多个目的地
rental_company_confirmation_id***租车公司提供的确认号码。ABC1234
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。false
rate租车预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

activity_booking_items

这些字段列出了作为行程的一部分预订的活动组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882910
status特定活动的状态。可能的值:
已确认
已取消
activity_start_date*活动的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-03
activity_end_date*活动的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-03
vendor.name***提供活动的供应商的名称。奥利维亚旅游
vendor.city***活动供应商所在的城市。荷兰鹿湖(YDF - 鹿湖地区机场)
vendor.country_code***活动供应商所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
offering_name***活动的名称乘坐激情天堂号游览大堡礁
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
rate活动预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

insurance_booking_items

这些字段列出了作为行程的一部分预订的保险组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882610
status所选特定保险的状态。可能的值:
已确认
已取消
rate所选保险的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

价格

这些字段列出了预订项目或整个行程的价格和定价详情。其中包括描述预订货币价值的嵌套值,按预订总额和税费细分。

字段名称定义示例
rate_plan_name用于项目定价的房价计划的名称。仅适用于房产预订项目。仅含客房
rate_plan_type预订时使用的价格的类型。仅适用于房产预订项目。分销价
refundable相应的预订组件是否可退款(是)或不可退款(否)。true
pricing该对象记录了预订的货币价值,并按预订总额、税费等进行细分。 
pricing.gross_booking_value记录预订金额的对象。 
pricing.gross_booking_value.billable_currency表示预订金额(以支付所用货币为单位)的对象。 
pricing.gross_booking_value.billable_currency.currency客户为预订付款时使用的货币。以 ISO 4217 格式表示。GBP
pricing.gross_booking_value.billable_currency.value总预订价值。2520.80
pricing.taxes_and_fees预订的税费的价值和币种。 
pricing.taxes_and_fees.billable_currency预订的税费的货币价值,以付款时使用的货币表示。 
pricing.taxes_and_fees.billable_currency.currency客户为预订付款时使用的货币。以 ISO 4217 格式表示。GBP
pricing.taxes_and_fees.billable.currency.value预订的总价值。491.10

优惠券

字段名称定义示例
code***预订时使用的优惠码。ABCD
name***优惠券名称。PRIME
description***优惠券说明。BoGo 5%
currency***应用优惠券价值的货币。以 ISO 4217 格式表示。GBP
value***优惠券的货币价值。126.04

所有白标旅游平台字段的注释

* 日期字段采用协调世界时 (UTC)。
** 这代表个人身份信息(PII)数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
*** 这些字段的数据将在预订创建或更新后的第二天 UTC 时间下午 6:00 至晚上 8:00 之间提供。目前无法实现近乎实时地提供。

旅行社联盟计划 (TAAP)

字段名称定义示例
itinerary_id行程编号或销售网站订单参考编号。72622069245694
status行程及其各项的状态。可能的值:
已确认
已取消
creation_date*最初预订的日期,以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
update_date_time*行程的最后更新日期和时间,以 ISO 8601 日期格式表示(YYYY-MM-dd'T"HH:mm:ss.SSSZ)。2023-10-21T00:00:00.000Z
online指示行程是通过在线预订(是)还是通过代理商预订(否)。用布尔值表示。true
point_of_sale_country_code客户预订所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。GB
purchaser预订人的身份证明。请参见 purchaser 表,获取嵌套项列表。 
agency确认预订方为 TAAP 代理机构和代理人。请参见 agency 表,获取嵌套项列表。 
payment行程付款信息。请参见 payment 表,获取嵌套项列表。 
property_booking_items作为行程的一部分预订的住宿组成部分。请参见 property_booking_items 表,获取嵌套项列表。 
flight_booking_items作为行程的一部分预订的机票组成部分。请参见 flight_booking_items 表,获取嵌套项列表。 
car_booking_items作为行程的一部分预订的租车组成部分。请参见 car_booking_items 表,获取嵌套项列表。 
activity_booking_items作为行程的一部分预订的活动组成部分。请参见 activity_booking_items 表,获取嵌套项列表。 
rate预订项目或整个行程的价格和定价详情。请参见 rate 表,获取嵌套项列表。 
earnings预订项目或整个行程的佣金详情。请参见 earnings 表,获取嵌套项列表。 
|

预订人

这些字段用于识别出行人员。

字段名称定义示例
purchaser.email**旅行者的电子邮件地址。smith@example.com
purchaser.first_name**旅行者的名字。
purchaser.last_name**旅行者的姓氏。史密斯

旅行社

这些字段用于标识进行预订的 TAAP 代理机构和代理人。

字段名称定义示例
agency.name进行预订的 TAAP 代理机构的名称。世界旅行
agency.id预订方 TAAP 代理机构的追踪代码。WS02555
agency.agent.first_name**预订的 TAAP 代理商的名字。Bob
agency.agent.last_name**预订时使用的 TAAP 代理商的姓氏。Jones
agency.agent.email**预订时使用的 TAAP 代理的电子邮件地址。bjones@worldtravel.com

付款

这些字段包含行程的付款详情。

字段名称定义示例
payment_type付款时使用的付款方式。可能的值:
信用卡
个点
分期付款
status表示行程是否已付款。可能的值:
有薪酬的
未付
deferred行程费用是延期支付(是)还是已支付(否)。用布尔值表示。true
payment_due_date付款到期日 ISO 8601 日期格式 (YYYY-MM-DD)。仅适用于延期付款。2023-02-05
payee指明谁负责支付行程费用。可能的值:
旅行社
顾客

property_booking_items

这些字段列出了作为行程的一部分预订的住宿组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882912
status特定住宿元素的状态。可能的值:
已确认
取消
checkin_date*相应住宿元素的入住日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-01
checkout_date*相应住宿元素的退房日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
property.idExpedia Group 为酒店或度假短租住宿提供的唯一标识符1400882912
property.chain_name住宿所属连锁酒店的名称(如适用)。独立
property.brand_name住宿所属品牌的名称(如适用)。一个连锁酒店可能有多个品牌。萨沃伊特色酒店
property.name酒店或度假短租屋的名称。酒店 1
property.city住宿所在城市的名称。多伦多
property.state_province_name住宿所在州或省的名称。安大略
property.country_code住宿所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
property.star_rating住宿的星级。3.0
room_name酒店或度假租赁公司定义的预订房间类型。Comfort 双人房带独立浴室
adult_count预订中包含的成人人数。2
child_count预订中包含的儿童人数。0
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
property_confirmation_id***酒店或度假租赁公司提供的确认号码。1516171819
rate住宿预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

flight_booking_items

这些字段列出了作为行程的一部分预订的机票组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882911
status特定机票行程元素的状态。可能的值:
已确认
已取消
departure_date*相应的机票行程元素的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-01
arrival_date*相应的机票行程元素的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-02
airline.plating_carrier_name出票航空公司的名称。加拿大航空
airline.plating_carrier_codeIATA 是出票航空公司的代码。AC
carrier_pnr航空公司出票处记录的乘客姓名。SMITH
trip_type预订的行程的类型。可能的值:
单程
往返
多个目的地
fare_class机票的票价等级。经济型
airport_origin_code始发机场的 IATA 代码。LHR
airport_origin_location始发机场的位置。英国伦敦(LHR - 希思罗机场)
airport_destination_code到达机场的代码。以 IATA 格式表示。YYZ
airport_destination_location到达机场的位置。安大略省多伦多(YYZ - 莱斯特-皮尔逊国际机场)
ticket_number航班机票号码。123456789101
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
segment_count机票包含的航班航段数。1
rate航班预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

car_booking_items

这些字段列出了作为行程的一部分预订的租车组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882910
status特定租车行程元素的状态。可能的值:
已确认
已取消
pickup_date*租车行程元素的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-02
return_date*租车行程元素的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-05
rental_company.name***租车公司的名称。Hertz
car_type***租车的类型。2/4 门紧凑型
pickup_location取车地点。荷兰鹿湖(YDF - 鹿湖地区机场)
pickup_country_code***取车地点的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
return_location还车地点。荷兰鹿湖(YDF - 鹿湖地区机场)
return_country_code***还车地点的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
trip_type预订的行程的类型。可能的值:
单程
往返
多个目的地
rental_company_confirmation_id***租车公司提供的确认号码。ABC1234
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。false
rate租车预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

activity_booking_items

这些字段列出了作为行程的一部分预订的活动组成部分。

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882910
status特定活动的状态。可能的值:
已确认
已取消
activity_start_date*活动的开始日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-03
activity_end_date*活动的结束日期。以 ISO 8601 日期格式表示(YYYY-MM-DD)。2023-02-03
vendor.name***提供活动的供应商的名称。奥利维亚旅游
vendor.city***活动供应商所在的城市。荷兰鹿湖(YDF - 鹿湖地区机场)
vendor.country_code***活动供应商所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。CA
offering_name***活动的名称亨伯河步道徒步
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
rate活动预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 
earnings活动预订项目的佣金详情。请参见 earnings 表,获取嵌套项列表。 

价格

这些字段列出了预订项目或整个行程的价格和定价详情。其中包括描述预订货币价值的嵌套值,按预订总额和税费细分。

字段名称定义示例
refundable相应的预订组件是否可退款(是)或不可退款(否)。true
pricing该对象记录了预订的货币价值,并按预订总额、税费等进行细分。 
pricing.gross_booking_value包括税费在内的预订的货币价值。 
pricing.gross_booking_value.billable_currency预订的货币价值,以付款时使用的货币表示。 
pricing.gross_booking_value.billable_currency.currency客户为预订付款时使用的货币。以 ISO 4217 格式表示。GBP
pricing.gross_booking_value.billable_currency.value总预订价值。2520.80
pricing.taxes_and_fees预订的税费的价值和币种。 
pricing.taxes_and_fees.billable_currency预订的税费的货币价值,以付款时使用的货币表示。 
pricing.taxes_and_fees.billable_currency.currency客户为预订付款时使用的货币。以 ISO 4217 格式表示。GBP
pricing.taxes_and_fees.billable.currency.value预订的总价值。491.10

收益

字段名称定义示例
commission表示预订或商品佣金金额的对象,包含在预订总价值中。 
commission.billable_currency以支付货币表示佣金金额的对象。 
commission.billable_currency.currency佣金金额的货币,以 ISO 4217 格式表示USD
commission.billable_currency.value佣金的货币价值。100.25
service_charge表示由 TAAP 代理机构对行程收取的服务费的对象。 
service_charge.amount表示 TAAP 代理机构对行程收取的服务费的货币价值的对象。 
service_charge.amount.billable_currency表示以支付货币表示的服务费金额的对象。 
service_charge.amount.billable_currency.currency服务费金额的货币单位,以 ISO 4217 格式表示。USD
service_charge.amount.billable_currency.valueTAAP 代理机构对行程收取的服务费的货币价值。50.50
service_charge.taxes_and_fees表示服务费中税费的价值和货币的对象。 
service_charge.taxes_and_fees.billable_currency以支付货币表示服务费税费的货币价值的对象。 
service_charge.taxes_and_fees.billable_currency.currency支付货币,以 ISO 4217 格式表示。USD
service_charge.taxes_and_fees.billable_currency.value客户支付的税费的金额(以记账货币表示)。5.25

所有 TAAP 字段的注释

* 日期字段采用协调世界时 (UTC)。
** 这代表个人身份信息(PII)数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
*** 这些字段的数据将在预订创建或更新后的第二天 UTC 时间下午 6:00 至晚上 8:00 之间提供。目前无法实现近乎实时地提供。

API 详情

我们根据贵公司使用行程 API 数据的方式,提供了 API 架构和配置的快照。您可以下载 OpenAPI 规范,并使用 API 测试软件来了解示例和模式定义与实际输出的比较情况。

白标旅游平台

我们的白标旅游平台合作伙伴可通过推送和拉取交付方式访问以下字段(包括任何嵌套对象):




TAAP

我们通过推送和拉取交付方式向 TAAP 合作伙伴提供的字段(包括任何嵌套对象)如下:




您觉得这个页面有用吗?
我们该如何改进这些内容?
感谢您帮助我们改进!