行程 API 交付
通过行程安排,您可以显示客户的预订信息,并帮助他们找到 booking-related 产品或服务,例如旅游或体验。您还可以利用这些数据分析预订趋势,并为您的利益相关者创建报告。
配送选项
您的行程数据 API 交付方式可以是推送式或拉取式。
Push 机制
推送服务旨在以 near-real 时间为准发送行程更新,重点关注 transaction-level 的核心细节。此选项允许您:
- 在您的网站或应用程序上显示客户的预订信息
- 向旅行者提供更多旅行相关的产品和服务供其购买。
推送事件将通过 Webhook 发送到您提供的 URL,格式为 HTTP POST消息。这些消息可能无序到达,因此请参考 creation_date和 update_date_time元素来确定顺序。
有关如何采用此交付选项的详细信息,请参阅API 设置。
Pull 机制
该拉取服务提供详细的行程数据,以支持:
- 数据分析
- 检索推送失败时间段的数据
- 服务台调查
此服务包含两个HTTP GET端点,允许您执行以下操作:
- 使用
creation_date_start、creation_date_end、update_date_time_start和update_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 表,获取嵌套项列表。 |
所有白标旅游平台字段的注释
* 日期字段采用协调世界时 (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 表,获取嵌套项列表。 |
所有 TAAP 字段的注释
* 日期字段采用协调世界时 (UTC)。
** 这代表个人身份信息(PII)数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
*** 这些字段的数据将在预订创建或更新后的第二天 UTC 时间下午 6:00 至晚上 8:00 之间提供。目前无法实现近乎实时地提供。
API 详情
我们根据贵公司使用行程 API 数据的方式,提供了 API 架构和配置的快照。您可以下载 OpenAPI 规范,并使用 API 测试软件来了解示例和模式定义与实际输出的比较情况。
白标旅游平台
我们的白标旅游平台合作伙伴可通过推送和拉取交付方式访问以下字段(包括任何嵌套对象):
TAAP
我们通过推送和拉取交付方式向 TAAP 合作伙伴提供的字段(包括任何嵌套对象)如下: