일정 API
실시간에 가까운 고객 예약 데이터에 액세스
일정 API를 통해 고객의 예약 정보를 표시하고 고객이 투어나 체험과 같은 예약 관련 상품이나 서비스를 찾도록 지원할 수 있습니다. 또한 이 API의 데이터를 사용하여 예약 동향을 분석하고 이해관계자를 위한 보고서를 생성할 수 있습니다.
사용 가능한 필드
아래 표에는 중첩된 개체를 포함하여 푸시 및 풀 제공 방식을 통해 사용 가능한 필드가 나열되어 있습니다.
필드 이름 | 정의 | 예 |
---|---|---|
itinerary_id | 일정 번호 또는 POS 주문 참조 번호입니다. | 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 | 고객이 예약을 한 POS의 국가 코드입니다. 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) 데이터입니다. 이 정보는 회사의 지침에 따라 올바르게 처리해야 합니다. 꼭 필요한 경우에만 포함해 주세요.
***이러한 필드의 데이터는 예약이 생성되거나 업데이트된 다음 날 18:00 ~ 20:00(UTC) 사이에 제공됩니다. 현재 실시간에 가까운 데이터는 제공되지 않습니다.
제공 방법
일정 API는 푸시 메커니즘과 풀 메커니즘의 두 가지 방식으로 데이터를 제공합니다.
푸시 메커니즘
푸시 서비스는 핵심 일정 세부 정보를 중심으로 일정 업데이트가 제공되는 대로 거의 실시간으로 전송하도록 설계되었습니다. 이 서비스는 다음과 같은 사용 사례를 대상으로 합니다.
- 파트너가 자체 웹사이트 또는 앱에 고객의 예약 정보를 표시할 수 있도록 지원
- 파트너가 예약 관련 상품 및 서비스를 홍보할 수 있도록 지원
이벤트는 HTTP POST 메시지 형식으로 웹훅을 통해 파트너가 제공한 URL에 전달됩니다. 메시지는 순서가 지정되지 않은 상태로 도착할 수 있다는 점에 유의해 주세요. 순서를 정하려면 creation_date
및 update_date_time
요소를 참조해 주세요.
인증 절차에 대한 자세한 내용은 시작하기를 참조해 주세요.
풀 메커니즘
풀 서비스는 상세한 일정 데이터를 제공하여 다음과 같은 사용 사례를 지원합니다.
- 데이터 분석 사용
- 푸시 전송이 실패한 기간에 대해 데이터 검색 사용
- 실시간 헬프 데스크 지원 사용
이 서비스는 두 개의 HTTP GET 엔드포인트로 구성되어 있는데, 하나는 지정된 시간대에 생성되거나 업데이트된 일정 목록을 제공하고, 다른 하나는 일정 ID로 해당 일정을 검색합니다. 쿼리 매개변수는 다음과 같습니다.
creation_date_start
creation_date_end
update_date_time_start
update_date_time_end
itinerary_id
인증 절차에 대한 자세한 내용은 시작하기를 참조해 주세요.
API 세부 정보
이 페이지에서 엔드포인트 정의를 살펴본 후 API 테스트 소프트웨어를 사용하여 예시 및 스키마 정의가 실제 출력과 어떤 차이가 있는지 확인해 보세요.