Vendor API 3.0 - 예약 조회 응답 필드 확대 및 예약 전송 문서 오류 정정
기존에는 예약 전송(POST /bookings)으로 보낸 값 중 일부를 예약 조회로 다시 확인할 수 없었습니다. 이번 변경으로 전송 페이로드의 모든 항목이 조회 응답에도 나옵니다. 더불어 예약 전송 문서에 잘못 적혀 있던 필드 타입 3건을 실제 기준으로 정정했습니다.
주요 변경사항
1. 예약 조회 응답에 필드 12개 추가
GET /gds/vendor/booking/{vendor_booking_number}
| 필드 | 타입 | 필수/선택 | 설명 |
|---|---|---|---|
channel_id | number | 필수 | 판매 채널 ID (예: 132) |
channel_name | string | 필수 | 판매 채널명 |
channel_booking_number | string | 선택 | 판매 채널 예약 번호 |
gds_booking_number | string | 필수 | ONDA Hub 예약 번호 |
gds_sub_booking_number | string | 필수 | ONDA Hub 서브 예약 번호 (예약 내 객실 단위) |
rateplan_id | string | 선택 | 공급사 요금제 ID. 매핑이 없는 예약은 생략 |
total_amount | number | 필수 | 채널 축 판매가. payment_type이 postpayment면 현장 수납할 금액 |
net_price | number | 필수 | 입금 금액 (정산 예정액) |
payment_type | prepayment | postpayment | 필수 | 결제 방식 (선결제 / 후결제) |
special_comment | string | 선택 | 고객 요청 사항 |
visit_type | walk | car | 선택 | 방문수단. 채널이 값을 준 예약에만 실림 |
secondary_channel | string | 선택 | 2차 판매 채널. 채널이 값을 준 예약에만 실림 |
선택 필드는 값이 없으면 null이 아니라 키 자체가 빠집니다. 응답 파싱 시 키 존재 여부로 판단해 주세요.
금액 필드가 세 개로 늘어난 만큼 기준도 함께 정리했습니다.
| 필드 | 기준 |
|---|---|
amount | 공급사 축 금액 — 숙박일별 금액에 추가금을 더해 합산한 값 |
total_amount | 채널 축 판매가 |
net_price | 입금 금액 (정산 예정액) |
2. 예약 조회 응답의 type 필드 표현 변경
| 값이 없을 때 | |
|---|---|
| 기존 | "type": null |
| 변경 | 키 자체를 생략 |
예약 전송 페이로드와 동일한 방식으로 통일한 것입니다. 실제로 값이 없는 예약은 운영 데이터에 없어 응답이 바뀌지는 않지만, 파싱 로직이 null 비교를 한다면 확인이 필요합니다.
3. 예약 전송 문서 오류 정정
전송하는 값은 바뀌지 않았습니다. 문서가 실제와 달랐던 것을 실제 기준으로 고쳤습니다. 문서를 보고 구현했다면 확인이 필요합니다.
| 필드 | 문서(이전) | 실제 = 문서(현재) |
|---|---|---|
channel_id | string, 예시 'NAVER' | number, 예시 132 |
total_amount | string, 예시 '100000' | number, 예시 100000 |
channel_booking_number | 필수 | 선택 |
channel_id,total_amount는 처음부터 숫자로 전송해 왔습니다. 문서 예시만 잘못 적혀 있었습니다.channel_booking_number는 판매 채널이 자기 예약 번호를 주지 않는 경우 키가 빠질 수 있어 선택으로 바꿨습니다.
PUT /bookings/{vendor_booking_number}/modify의 total_amount도 같은 문서 오류라 함께 number로 정정했습니다.
관련 문서
문의
API 연동에 대해 궁금하신 사항이 있으시면 언제든지 문의해 주세요:
- 기술 문의: techsupport@onda.me