行程 API

获取近乎实时的客户预订数据

借助我们的行程 API,您可以显示客户的预订信息,并帮助他们查找与预订相关的产品或服务,如游览或体验。您还可以使用此 API 中的数据来分析预订趋势,并为您的利益相关者创建报告。

可用字段

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

字段名称定义示例
itinerary_id行程编号或销售网站订单参考编号。72622069245694
status行程及其各项的状态。可能的值:
已预订
已取消
creation_date*最初进行预订的日期,以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-05
update_date_time*行程最新更新的日期和时间,以 ISO8601 日期格式 (YYYY-MM-dd"T"HH:mm:ss.SSSZ) 表示。2023-10-21T00:00:00.000-08:00
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

property_booking_items

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

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882912
status特定住宿元素的状态。可能的值:
已预订
已取消
checkin_date*相应住宿元素的入住日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-01
checkout_date*相应住宿元素的退房日期。以 ISO8601 日期格式 (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
room_name预订的客房的类型。带私人浴室的舒适双人房
adult_count相应预订中包含的成人人数。2
child_count相应预订中包含的儿童人数。0
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。true
property_confirmation_id***酒店或度假短租公司提供的确认 ID。1516171819
rate住宿预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

flight_booking_items

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

字段名称定义示例
booking_item_id作为行程一部分预订的特定元素的标识符。1400882911
status特定机票行程元素的状态。可能的值:
已预订
已取消
departure_date*相应的机票行程元素的开始日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-01
arrival_date*相应的机票行程元素的结束日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-02
airline.plating_carrier代表出票的航空公司的名称。加拿大航空
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*租车行程元素的开始日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-02
return_date*租车行程元素的结束日期。以 ISO8601 日期格式 (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***租车公司提供的确认 ID。ABC1234
expedia_collect布尔值,表示预订是否已在付款页面支付 (true) 还是必须直接向提供商支付 (false)。false
rate租车预订的价格和定价详情。请参见 rate 表,获取嵌套项列表。 

activity_booking_items

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

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

insurance_booking_items

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

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

价格和定价

这些字段列出了预订项目或整个行程的价格和定价详情。


价格

字段名称定义示例
rate_plan_name用于项目定价的房价计划的名称。仅适用于 property_booking_items。仅含客房
rate_plan_type预订时使用的价格的类型。仅适用于 property_booking_items。分销价
refundable相应的预订部分是否可以退款。true

定价

该字段包含用于描述预订的货币价值的嵌套值,按预订总价值和税费细分。这些字段进一步嵌套以实现灵活性。

字段名称以名称开头,后跟英文句号(例如,<variable>.<nested variable>),表示嵌套关系。该表中的所有字段都嵌套在 pricing 变量下。

字段名称定义示例
taxes_and_fees预订的税费的价值和币种。请参见下面的嵌套项。 
gross_booking_value包括税费在内的预订的货币价值。2523.00
taxes_and_fees.billable_currency预订的税费的货币价值,以付款时使用的货币表示。嵌套在 taxes_and_fees 变量下。请参见下面的嵌套项。 
gross_booking_value.billable_currency预订的货币价值,以付款时使用的货币表示。嵌套在 gross_booking_value 变量下。请参见下面的嵌套项。 
billable_currency.currency客户为预订付款时使用的货币。以 ISO 4217 格式表示。嵌套在 billable_currency 变量下。GBP
billable.currency.value预订的总价值。嵌套在 billable_currency 变量下。2520.80
billable_currency.currency客户支付税费时使用的货币。以 ISO 4217 格式表示。嵌套在 billable_currency 变量下。GBP
billable_currency.value客户支付的税费的金额(以记账货币表示)。嵌套在 billable_currency 变量下。491.10

优惠券

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

*日期字段采用协调世界时 (UTC) 格式。

**个人身份识别信息 (PII) 数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。

*** 这些字段的数据将在预订创建或更新的次日下午 6:00 至晚上 8:00 (UTC) 之间提供。目前无法实现近乎实时地提供。

交付方式

行程 API 以两种方式提供数据:Push 机制和 Pull 机制。

Push 机制

Push 服务旨在近乎实时地发送行程更新,重点关注核心行程详细信息。该服务面向以下用例:

  • 支持合作伙伴在其网站或 App 上显示客户的预订信息
  • 支持合作伙伴销售与预订相关的产品和服务

事件将通过 Webhook 以 HTTP POST 消息的格式发送到您提供的 URL。请记住,消息可能会无序送达。请参阅 creation_dateupdate_date_time 元素确定顺序。

有关身份验证流程的详细信息,请参阅入门指南

Pull 机制

Pull 服务提供详细的行程数据以支持用例,包括:

  • 支持数据分析
  • 支持对 Pull 交付方式失败的时间段进行数据检索
  • 提供实时服务台支持

该服务由两个 HTTP GET 端点组成:一个提供在指定时间范围内创建或更新的行程的列表,另一个根据 ID 检索特定的行程。查询参数为:

  • creation_date_start
  • creation_date_end
  • update_date_time_start
  • update_date_time_end
  • itinerary_id

有关身份验证流程的详细信息,请参阅入门指南

API 详情

查看此页面上的端点定义,然后使用 API 测试软件来了解示例和模式定义与实际输出的比较。




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