行程 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 表,获取嵌套项列表。 |
*日期字段采用协调世界时 (UTC) 格式。
**个人身份识别信息 (PII) 数据。请务必按照贵公司的指导原则正确处理此内容。请仅在绝对必要时包括此信息。
*** 这些字段的数据将在预订创建或更新的次日下午 6:00 至晚上 8:00 (UTC) 之间提供。目前无法实现近乎实时地提供。
交付方式
行程 API 以两种方式提供数据:Push 机制和 Pull 机制。
Push 机制
Push 服务旨在近乎实时地发送行程更新,重点关注核心行程详细信息。该服务面向以下用例:
- 支持合作伙伴在其网站或 App 上显示客户的预订信息
- 支持合作伙伴销售与预订相关的产品和服务
事件将通过 Webhook 以 HTTP POST 消息的格式发送到您提供的 URL。请记住,消息可能会无序送达。请参阅 creation_date
和 update_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 测试软件来了解示例和模式定义与实际输出的比较。