行程 API 交付
通过行程安排,您可以显示客户的预订信息,并帮助他们找到 booking-related 产品或服务,例如旅游或体验。您还可以利用这些数据分析预订趋势,并为您的利益相关者创建报告。
配送选项
您的行程数据 API 交付方式可以是推送式或拉取式。
Push 机制
推送服务会在行程更新发生时立即发送更新信息。核心预订字段在交易发生后几分钟内即可使用,辅助字段和增强字段将在 2-4 小时内使用。此选项允许您:
- 在您的网站或应用程序上显示客户的预订信息
- 向旅行者提供更多旅行相关的产品和服务供其购买。
推送事件将通过 Webhook 发送到您提供的 URL,格式为 HTTP POST消息。这些消息可能无序到达,因此请参考 creation_date和 update_date_time元素来确定顺序。
有关如何采用此交付选项的详细信息,请参阅API 设置。
使用推送事件
由于行程数据会在可用时立即交付,因此您可能会收到同一行程的多个事件——一个包含核心字段的初始事件,随后是随着辅助数据的丰富或行程的更新而发生的后续事件。有关哪些字段实时到达以及哪些字段将在 2-4 小时内到达的完整细分信息,请参阅可用字段。
应该:
- 预计每个行程包含多个事件:使用
itinerary_id关联事件,并始终以最新的update_date_time事件为准。 - 选择如何处理更新:当您收到现有行程的新事件时,您可以选择用最新数据覆盖之前的记录,或者追加每个事件以保留更改历史记录。
- 妥善处理缺失字段:辅助字段可能在早期事件中缺失;处理前请检查字段是否存在。
不:
- **假设第一个事件包含完整的有效载 荷:**辅助字段将在后续事件中出现。
- **将同一行程的多个事件视为错误:**这是预期行为
- **请将 real-time 的财务数值视为最终值:**它们可能会在 24 小时内进行调整。
Pull 机制
该拉取服务提供详细的行程数据,以支持:
- 数据分析
- 将预订记录与 Expedia Group 数据进行核对
- 检索推送失败的时间窗口的数据
- 服务台调查
与推送交付一样,行程数据也分为两个层级用于拉取交付:核心字段(itinerary_ID、status、gross_booking_value、checkin_date和checkout_date)可在预订或更新后几分钟内访问,辅助字段和增强字段将在 2-4 小时内跟进。有关字段的完整细分,请参阅可用字段。
此服务包含两个HTTP GET端点,允许您执行以下操作:
- 使用
creation_date_start、creation_date_end、update_date_time_start和update_date_time_end变量创建指定时间范围内创建或更新的行程列表。 - 按行程检索特定行程
itinerary_id
有关身份验证过程的详细信息,请参阅API 设置。
按时间窗口检索行程数据
要检索给定时间窗口的行程数据,请使用 GET /itineraries和 update_date_time_start作为查询窗口轮询 update_date_time_end端点。
推荐方法:
- 使用 update_date_time 字段作为查询窗口: 使用
update_date_time_start和update_date_time_end作为查询窗口检索在给定时间段内创建或更新的行程。单独使用creation_date将错过行程更新。 - 保留上次成功轮询时间戳: 将其用作下一个
update_date_time_start,逐步推进窗口。 - 去重: 在查询中使用
itinerary_id+update_date_time。随着辅助字段的丰富,同一行程可能会出现在多个投票窗口中。始终将最新记录视为权威记录。update_date_time
如果您的使用场景需要最完整、最及时的行程数据,建议采用推送式交付。
可用字段
下表列出了通过我们的 Push 和 Pull 交付方式提供的字段,包括所有嵌套对象。“可用性”列指示预订事件或更新后,每个字段通常何时可访问:
- 实时:预订或更新后几分钟内即可使用
- Near-real-time:预订或更新后 2-4 小时内可用
字段名称以名称开头,后跟英文句号(例如,<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 | Near-real-time |
package | 表明该行程是套餐的一部分还是单独预订的。用布尔值表示。 | false | Near-real-time |
payment_type | 付款时使用的付款方式。 | 可能的值: 信用卡 积分 分期付款 | 实时 |
point_of_sale_country_code | 客户进行预订的销售网站的国家/地区代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。 | GB | Near-real-time |
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 表,获取嵌套项列表。 |
所有白标旅游平台字段的注释
* 日期字段采用协调世界时 (UTC)。
** 这代表个人身份信息(PII)数据。请务必按照公司规定正确处理此事。仅在绝对必要时才包含。
旅行社联盟计划 (TAAP)
| 字段名称 | 定义 | 示例 | 房态 |
|---|---|---|---|
itinerary_id | 行程编号或销售网站订单参考编号。 | 72622069245694 | 实时 |
agency_reference_code | 旅行社在结账时提供的定制行程参考资料。 | 86549B_GB | 实时 |
status | 行程及其各项的状态。 | 可能的值: 已确认 已取消 | Near-real-time |
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 | Near-real-time |
point_of_sale_country_code | 客户预订所在国家/地区的代码。采用包含两个字母的 ISO 3166-1 alpha-2 格式。 | GB | Near-real-time |
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 表,获取嵌套项列表。 |
所有 TAAP 字段的注释
* 日期字段采用协调世界时 (UTC)。
** 这代表个人身份信息(PII)数据。请务必按照公司规定正确处理此事。仅在绝对必要时才包含。
API 详情
我们根据贵公司使用行程 API 数据的方式,提供了 API 架构和配置的快照。您可以下载 OpenAPI 规范,并使用 API 测试工具来了解示例和模 式定义与实际输出的比较情况。
白标旅行平台
我们的白标旅游平台合作伙伴可通过推送和拉取交付方式访问以下字段(包括任何嵌套对象):
T A A P
我们的 TAAP 合作伙伴可通过推送方式访问以下字段(包括任何嵌套对象):