行程安排的 API 交付
通过行程,您可以显示客户的预订信息并帮助他们找到 booking-related 产品或服务,例如旅游或体验。您还可以使用数据来分析预订趋势并为利益相关者创建报告。
送货选项
您的行程数据 API 传送可以使用推送或拉取机制。
Push 机制
推送服务旨在在 near-real 时间内发送行程更新,重点关注核心 transaction-level 细节。此选项允许您:
- 在您的网站或应用程序上显示客户的预订信息
- 为您的客户提供旅行所需的额外产品和服务
推送事件将通过 Webhook 以 HTTP POST消息的格式传送到您提供的 URL。这些消息可能无序到达,因此请参考 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)还是通过代理预订(false)。用布尔值表示。 | 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) 数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
 *** 这些字段的数据将在预订创建或更新后的第二天下午 6:00 至晚上 8:00 (UTC) 之间提供。目前无法实现近乎实时地提供。
旅行社联盟计划 (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)还是通过代理预订(false)。用布尔值表示。 | 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) 数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
 *** 这些字段的数据将在预订创建或更新后的第二天下午 6:00 至晚上 8:00 (UTC) 之间提供。目前无法实现近乎实时地提供。
API 详情
根据您的业务使用行程 API 数据的方式,我们提供了 API 模式和配置的快照。您可以下载 OpenAPI 规范并使用 API 测试软件来了解示例和模式定义与实际输出的比较情况。
白标模板
通过我们的推拉式交付方法,我们的白标模板合作伙伴可以使用的字段(包括任何嵌套对象)包括:
TAAP
我们的 TAAP 合作伙伴可以通过推拉式交付方法使用的字段(包括任何嵌套对象)如下: