1 1. Product Detail
- 1.1 1) Purpose
- 1.2 2) Detail
2 2. API spec
- 2.1 1) Request
- 2.2 2) Path Parameter
- 2.3 3) Response
  - 2.3.1 (1) Required Traveler Information
  - 2.3.2 (2) Contents
  - 2.3.3 (3) Options
- 2.4 4) Response Example
- 2.5 5) Error Spec
3 3. Request Example
- 3.1 1) CURL

1. Product Detail

1) Purpose

Channel에서 판매 가능한 수준으로 Product Detail을 확인하기 위한 API입니다.

2) Detail

Product List API 상품 - 투어상품 조회 를 통해 확인한 Product 중 하나의 Product Code를 이용하여 Product Detail을 확인합니다.
Channel에 Product를 등록하기 위해 사용합니다.
유효한 API Key를 request Header에 토큰으로 입력해야만 호출 가능합니다.

2. API spec

1) Request

Endpoint	product environment: https://prod.ax-cloud.com/v1/channel/products/tour/{product_code} test environment: https://test.ax-cloud.com/v1/channel/products/tour/{product_code}
Method	GET
Description	특정 Product Detail을 조회합니다.
Content-Type	application/json
Headers > Authorization	Token {api_key}

2) Path Parameter

Name	Required	Type	Description	Example

Name	Required	Type	Description	Example
product_code	O	String	Product ID(UUID)	“c1f891f7-3f22-4b2c-a4a9-e7754c20be23“

3) Response

아래 항목 중 빈 값은 “Void“[String] 으로 표기됩니다.

Name	Type	Description	Example

Name	Type	Description	Example
status_code	Integer	정상 처리 시 200	200
required_traveler_information	Object	주문 발생 시 전달이 필요한 Traveler의 개인 정보	{“english_name”: true, “chinese_name”: false”}
contents	Object	Product의 내용	표 하단 설명 참고상품 - 투어상품 상세정보 조회 \| (2) Contents
options	List[Object]	Product의 판매 단위	표 하단 설명 참고상품 - 투어상품 상세정보 조회 \| (3) Options

(1) Required Traveler Information

Supplier는 Traveler의 정보가 필요합니다.
Product에는 필요한 Traveler 정보가 명시되어 있기 때문에, Channel에서 주문 발생 시 이 정보들을 전달해야 합니다.
Type은 Object로 전송 해야 합니다.
- 만약, required_traveler_information이 {“english_name”: true, “chinese_name”: false”}인 경우에는, Order 발생 시 Traveler의 english_name 정보를 함께 보내주어야 합니다. - 주문 - 투어상품 주문 생성(representative.additional Object)

Name	Type	Description	Example

Name	Type	Description	Example
english_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 영어 이름	true false
chinese_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 중국어 이름	true false
nationality	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 국적	true false
language	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 사용 언어	true false
gender	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 성별	true false
date_of_birth	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 생년월일	true false
passport_id	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 생년월일	true false
passport_expiry	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 여권 만기일	true false
drivers_license_id	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 운전 면허 번호	true false
drivers_license_expiry	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 운전 면허 만기일	true false
weights	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 체중	true false
heights	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 키	true false
vegetarian	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 채식 여부	true false
sns_for_communication	Boolean	Supplier가 투어 진행을 위해 여행자와 소통 가능한 Supplier 의 SNS	true false
arrival_flight_detail_airline	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 항공사	true false
arrival_flight_detail_flight_number	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 항공편명	true false
arrival_flight_detail_arrival_date	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착날짜(도착 국가 기준)	true false
arrival_flight_detail_arrival_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착시각(도착 국가 기준)	true false
departure_flight_detail_airline_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 항공사	true false
departure_flight_detail_flight_number	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 항공편명	true false
departure_flight_detail_departure_date	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 날짜(출발 국가 기준)	true false
departure_flight_detail_departure_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 시각(출발 국가 기준)	true false
pickup_hotel_details_pickup_hotel_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 픽업 호텔 이름	true false
pickup_hotel_details_pickup_hotel_address	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 픽업 호텔 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	true false
pickup_hotel_details_pickup_hotel_room_number	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 픽업 호텔 룸 넘버	true false
drop_off_hotel_details_drop_off_hotel_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 드랍오프 호텔 이름	true false
drop_off_hotel_details_drop_off_hotel_address	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 드랍오프 호텔 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	true false
drop_off_hotel_details_drop_off_hotel_room_number	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 드랍오프 호텔 룸 넘버	true false
arrival_ship_details_arrival_ship_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 선박 이름	true false
arrival_ship_details_arrival_ship_disembarkation_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 선박 하선 시각	true false
departure_ship_details_departure_ship_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 선박 이름	true false
departure_ship_details_departure_ship_boarding_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 선박 탑승 시각	true false
shore_excursion_details_shore_excursion_ship_name	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 해변 유람선 이름	true false
shore_excursion_details_arrival_ship_disembarkation_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 해변 유람선 도착선박 하선 시각	true false
shore_excursion_details_departure_ship_boarding_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 해변 유람선 출발선박 탑승 시각	true false
arrival_train_details_arrival_rail_line	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 기차 철도 이름	true false
arrival_train_details_arrival_rail_station	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 도착 기차역	true false
arrival_train_details_rail_arrival_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 기차 도착 시각	true false
departure_train_details_departure_rail_line	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 기차 철도 이름	true false
departure_train_details_departure_rail_station	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 기차역	true false
departure_train_details_rail_departure_time	Boolean	Supplier가 투어 진행을 위해 여행자에게 필요한 정보중 출발 도착 시각	true false

(2) Contents

아래 항목 중 빈 값은 [String] “Void“로 표기됩니다.

Key	Type	Description	Example

Key	Type	Description	Example
product_listing_language	String	상품을 작성하는 언어	“Void” “English” “Korean”
tour_guide_certification	String	투어 가이드의 자격증 소지 여부	“Yes” “No” “Void”
separate_driver_included	String	투어 가이드가 운전사 역할도 하는지 여부	“Yes” “No” “Void”
main_country_and_city	String	투어가 진행되는 대표 국가 및 도시 요청 - 표준 데이터	“France - Paris” “South Korea - Seoul” “United Kingdom - London”
country_and_city	String	투어 진행되는 모든 국가 및 도시 요청 - 표준 데이터	“France - Paris” “South Korea - Seoul” “United Kingdom - London”
keyword_city	String	투어 대표 도시 요청 - 표준 데이터	“France - Paris” “South Korea - Seoul” “United Kingdom - London”
keyword_others	List[String]	도시 및 POIs 외의 시즌 키워드, 시설 특징, 연관 키워드를 입력	[ "museum", "shopping" ]
course_main_title	String	코스를 대표하는 이름	"Paris City Tour"
departure_city	String	투어 출발 도시 요청 - 표준 데이터	“France - Paris” “South Korea - Seoul” “United Kingdom - London”
transportation	String	투어 교통 수단으로 도보, 차량 분류 된다.	“On Foot” “Vehicle”
poi	List[String]	Point of Interest 로 유명한 Point 지역을 의미 Course 를 의미하는 것이 아니라 채널에서 여행자가 검색할 유명한 지역 Course 자체가 POI 가 될수도 있으나 모든 Course 는 POI는 아님 단, 관련 있는 지역으로 선택	[ "The Louvre Museum", "Le Café Marly" ]
product_name	String	AX Cloud 에서 상품을 부르는 이름 채널과는 무관하다.	"Paris City Tour"
product_title_type_1	String	채널에 등록하기 위한 타입 1의 상품 타이틀 city-course name 의 형태로 한국어 25자 이내	"Paris the city of light"
product_title_type_2	String	채널에 등록하기 위한 타입 2 상품 타이틀 city-course name-tour type 의 형태로 한국어 40자 이내	"Paris Visit famous landmarks"
product_title_type_3	String	채널에 등록하기 위한 타입 3 상품 타이틀 city-course name-tour type-ndays 의 형태로 한국어 50자 이내	"Paris Visit famous landmarks"
product_title_type_4	String	채널에 등록하기 위한 타입 4 상품 타이틀 country-city-course name-tour type 의 형태로 한국어 50자 이내	"Paris Visit famous landmarks"
product_title_type_5	String	채널에 등록하기 위한 타입 5 상품 타이틀 course name-tour type-ndays 의 형태로 한국어 50자 이내	"Paris Visit famous landmarks"
product_sub_title	String	채널에 등록하기 위한 케치프레이즈	"Explore the best of Paris in one day"
event_special_giving	String	채널에 등록하기 위한 이벤트 혹은 특전 정보	"Gift bag included"
tour_guide_strength	String	투어 가이드 및 회사의 특장점 소개 회사 이름은 넣으면 안됨 블럭 처리 해야 함	"Local expert"
product_differentiation	String	상품에 대한 차별점으로 토픽 1개씩 만 명시	"Skip-the-line access to attractions"
target_customer	String	대상이 되는 고객에 대한 설명	“Solo travelers”
thumbnail_type_1	String	대표 이미지 타입 1 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_2	String	대표 이미지 타입 2 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_3	String	대표 이미지 타입 3 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_4	String	대표 이미지 타입 4 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_5	String	대표 이미지 타입 5 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_6	String	대표 이미지 타입 6 URL 채널에서 원하는 해상도가 다르다	“https://***”
thumbnail_type_7	String	대표 이미지 타입 7 URL 채널에서 원하는 해상도가 다르다	“https://***”
sub_thumbnail_type_1	String	서브 섬네일 타입 1 URL 채널에서 원하는 해상도가 다르다	“https://***”
sub_thumbnail_type_2	String	서브 섬네일 타입 2 URL 채널에서 원하는 해상도가 다르다	“https://***”
sub_thumbnail_type_3	String	서브 섬네일 타입 3 URL 채널에서 원하는 해상도가 다르다	“https://***”
sub_thumbnail_type_4	String	서브 섬네일 타입 4 URL 채널에서 원하는 해상도가 다르다	“https://***”
sub_thumbnail_type_5	String	서브 섬네일 타입 5 URL 채널에서 원하는 해상도가 다르다	“https://***”
how_to_meet_travelers	String	여행자를 만나는 방법	“Meet on location” “Pick-up only” “Meet on location or Pick-up”
meeting_point_address	String	여행자를 만나는 미팅 포인트 주소 다수의 포인트가 존재하고 여행자가 선택할 수 있다. 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	“Champ de Mars, 5 Avenue Anatole France“
meeting_point_country	String	여행자를 만나는 미팅 포인트 국가 다수의 포인트가 존재하고 여행자가 선택할 수 있다.	“France“
meeting_point_city	String	여행자를 만나는 미팅 포인트 도시 다수의 포인트가 존재하고 여행자가 선택할 수 있다.	“Paris“
meeting_point_post_code	String	여행자를 만나는 미팅 포인트의 우편번호 다수의 포인트가 존재하고 여행자가 선택할 수 있다.	“75007“
meeting_point_description	String	여행자를 만나는 미팅 포인트의 우편번호 다수의 포인트가 존재하고 여행자가 선택할 수 있다.	“75007”
how_to_find_the_meeting_point	String	미팅 포인트를 찾아오는 방법	“Look for the tour guide holding a sign“
pickup_support	Boolean	픽업 지원 여부	true false
pickup_location_type_hotel	Boolean	픽업 장소 유형이 호텔인지 여부	true false
pickup_location_type_airport	Boolean	픽업 장소 유형이 공항인지 여부	true false
pickup_location_type_port	Boolean	픽업 장소 유형이 항구인지 여부	true false
pickup_location_type_other	Boolean	픽업 장소 유형이 기타 인지	true false
pickup_start_time_before_tour	Integer	투어 시작 몇분 전에 도착해야 하는지	30
additional_pickup_details	String	추가 적인 픽업 정보	"Not applicable"
how_to_enter_hotel_information_for_pickup	String	픽업할 호텔의 정보 기입 방법	“I want to define a general area of hotels I pick up from” “I want enter locations one at a time(I will add hotels individually)” “Allow travelers to enter their own pickup location”
central_location_address_for_the_general_area_of_hotel_pickup	String	호텔 픽업 지역의 중심 위치 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	"Not applicable"
radius_from_central_location_for_hotel_pickup	Integer	호텔 픽업 지역의 중심으로부터 반경	1
hotel_pickup_radius_unit	String	호텔 픽업 지역의 중심으로부터 반경 측정 단위	“Km” “M”
hotel_name_you_identified_for_pickup	String	픽업을 위해 지명한 호텔 이름	“Not applicable“
hotel_address_you_identified_for_pickup	String	픽업을 위해 지명한 호텔 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	"Not applicable"
port_name_you_identified_for_pickup	String	픽업을 위해 지명한 항구 이름	"Port of Los Angeles”
port_address_you_identified_for_pickup	String	픽업을 위해 지명한 항구 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	"425 S Palos Verdes St, San Pedro, CA"
airport_name_you_identified_for_pickup	String	픽업을 위해 지명한 공항 이름	"Los Angeles International Airport"
airport_address_you_identified_for_pickup	String	픽업을 위해 지명한 공항 주소 구글 기반 주소 https://developers.google.com/maps/documentation/javascript/geocoding?hl=ko 구글 지오코딩을 통해 위도, 경도 및 상세한 지역 및 주소정보 추출 가능	"1 World Way, Los Angeles, CA"
default_duration_hour	Integer	기본 코스 소요 시간	4
inclusion_which_traveler_cannot_choose	String	여행자가 선택할 수 없는 포함 사항	"Transportation to and from dropoff locations"
exclusion	String	불포함 사항	"Meals and beverages, tips and gratuities"
know_before_you_go	String	주의 사항	"Wear comfortable clothes and shoes, bring sunscreen and water"
covid_19_safety_updates	String	코로나 안전 조치	"All participants must wear masks and maintain social distance"
additionally_safety_measures_for_covid	String	추가 안전 조치	"Hand sanitizers and masks will be provided"
frequently_asked_questions_q	List[String]	자주 묻는 질의응답의 질문	["What is the refund policy?", "Can I reschedule my booking?"]
frequently_asked_questions_a	List[String]	자주 묻는 질의응답의 답변	["Cancellations must be made at least 48 hours before the tour start time for a full refund.", "Yes, bookings can be rescheduled up to 24 hours before the tour start time."]
what_to_bring	String	준비물	"Comfortable clothes, sunscreen, water"
adult_min_age	Integer	성인 최소 연령	14
adult_max_age	Integer	성인 최대 연령	100
youth_min_age	Integer	청소년 최소 연령	12
youth_max_age	Integer	청소년 최대 연령	18
child_min_age	Integer	아동 최소 연령	4
child_max_age	Integer	아동 최대 연령	6
infant_min_age	Integer	유아 최소 연령	0
infant_max_age	Integer	유아 최대 연령	3
senior_min_age	Integer	노인 최소 연령	65
senior_max_age	Integer	노인 최대 연령	100
reorder_limit_per_person	Choose from {Limit, Unlimited}	1인당 재주문 제한	"Unlimited"
maximum_purchase_allowed_quantity	Integer	최대 구매 허용 수량	20
purchase_under_the_age_of_19	String	19세 미만 구매 가능 여부	“Yes” “No”
booking_cutoff_deadline_before_tour_start	Integer	투어 시작 전 예약 마감 시간 타임존은 supplier company 의 operating hours 를 따른다	48
booking_payment_confirmation_time	Integer	예약 결제 확인 시간(단위 분) 예약후 n 분 이내에 결제하지 않으면 취소됨	1200
cancellation_type	String	가능한 취소 종류	“Anytime” “cancellation” “Cancellation in according to rules” “Non-refundable”
cancel_confirmation_method	String	취소 확정 방법	“Automatic” “Manual”
weekend_cancellation_confirmed	String	주말 취소 확정 여부	“Available” “Not Available “
refund_confirmation_time	Choose from { 0, 8, 16, 24, 72 }	취소 확정까지 걸리는 시간	8
refund_policy_comments	String	원하는 취소 환불 정책으로 참고용으로만 받는다. 작성한 내용이 그대로 적용되지 않고 채널의 규칙으로 적용된다.	"Refunds issued within 7-10 business days"
automatic_order_approval	String	파트너가 주문을 자동 승인할지 여부	“Yes” “No”
how_to_check_traveler_on_site	String	고객 본인 확인 방법	"Verify name on reservation matches ID"
how_to_use_vouchers	String	바우처 사용 방법	"Present voucher at the start of the tour"
voucher_type	String	바우처의 형태	“Email“ “QR Code“ “Bar Code”
voucher_per_participant	String	바우처 생성하는 단위	“One per booking“ “One per traveler”
maximum_lead_time_for_sending_voucher	Integer	바우처 발송 최대 소요 시간	48
how_to_redemption	String	사용 완료 처리 방법	“Automatic “ “redeemed after date“ “Supplier handles redeem“

(3) Options

아래 항목에서 value가 비어있는 경우 “Void“[String] 로 표기됩니다.

Key	Type	Description	Example

Key	Type	Description	Example
option_code	String	옵션에 대한 식별자 (UUID)	“f984fd48-9edf-4310-bebc-67661861c2e7“
sales_period_name	String	판매 기간 이름	"Spring Sale"
start_date_of_the_sale	Date	판매 기간 시작 날짜	"2023-04-01"
end_date_of_the_sale	Date	판매 기간 종료 날짜	"2023-04-15"
start_of_use_date	Date	사용 시작 날짜	"2023-04-20"
end_of_use_date	Date	사용 종료 날짜	"2023-10-31"
transportation	String	이동 수단	“On Foot” “Vehicle Sedan“ “Vehicle Van“ “Vehicle Limousine” “Vehicle Bus “
tour_guide_type	String	투어 가이드 타입	“In Person“ “Audio“ “Written “
guide_language	String	가이드 언어	"French"
time_zone_utc	Timezone UTC	출발 시각 타임존	“UTC+9”
default_departure_time	Time	출발 시각	"9:00"
purchase_unit	String	구매 단위	“Join Tour” “Private Tour“
number_of_people_per_purchase_unit	Integer	판매 단위당 사람 수	4
meal_and_drinks	String	식사와 음료 제공 여부	“Included“ “Not Included“
another_activity_ticket	String	다른 액티비티 티켓 제공 여부	“Included“ “Not Included“
minimum_of_people_available_for_departure	Integer	최소 출발 인원	10
inventory_quantity	Integer	인벤토리 재고	100
unit_selling_price_usd	Float	유닛당 판매 가격 USD	80.0
selling_price_per_person_usd	Float	인당 판매 가격 USD	75.0
unit_selling_price_krw	Float	유닛당 판매 가격 KRW	88000.0
selling_price_per_person_krw	Float	인당 판매 가격 KRW	82500.0
age	String	구매 대상의 연령	“Child“ “Adult“
operation_day	String	투어 운영 요일	“Monday“ “Tuesday“ “Wednesday” “Thursday” “Friday” “Saturday” “Sunday” “Weekday” “Every day”

4) Response Example

{
  "status_code": 200,
  "required_traveler_information": {
    "english_name": false,
    "chinese_name": false,
    ...
  },
  "contents": {
    "product_listing_language": "Korean",
    "tour_guide_certification": "Yes",
    ...
  },
  "options": [
    {
      "option_code": "d327bbf7-2052-4ebb-893a-ee952b694029",
      "sales_period_name": "The first half",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      "transportation": "Vehicle",
      ...
    }
  ]
}

5) Error Spec

{'message': '찾을 수 없습니다.'}

{'detail': ErrorDetail(string='이 작업을 수행할 권한(permission)이 없습니다.', code='permission_denied')}

AX Cloud Channel Document

상품 - 투어상품 상세정보 조회

Analytics