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 ID를 이용하여 Product Detail을 확인합니다.
Channel에 Product를 등록하기 위해 사용합니다.
유효한 API Key를 request Header에 토큰으로 입력해야만 호출 가능합니다.

2. API spec

1) Request

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

2) Path Parameter

Name	Required	Type	Description	Example

Name	Required	Type	Description	Example
product_code	O	String	Product ID(UUID)	“2f7e12d9-0e7d-4e1b-ae45-dc786d714b7e” “ed626e53-9574-5c4f-af42-bd01ea7a18b9” “7c88ed31-fb75-4f8a-89eb-c5e1b6f5e6d8”

3) Response

Name	Type	Description	Example

Name	Type	Description	Example
status_code	Integer	정상 처리 시 200	200 404
contents	Object	Product의 내용
options	List[Object]	Product의 판매 단위

(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가 티켓을 위해 여행자에게 필요한 정보중 픽업 호텔 구글 기반 주소	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가 티켓을 위해 여행자에게 필요한 정보중 드랍오프 호텔 구글 기반 주소	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

Key	Type	Description	Example

Key	Type	Description	Example
product_listing_language	String	상품을 작성하는 언어	Korean English
main_country_and_city	String	티켓 사용 대표 국가 및 도시
keyword_city	String	티켓 대표 도시 [국가-도시 데이터는 문의]
keyword_others_n1	String	도시 및 POIs 외의 시즌 키워드, 시설 특징, 연관 키워드를 입력
ticket_category_code	String	AX 카테고리 코드 [티켓 카테고리 데이터는 문의]
poi_n1	String	Point of Interest 로 유명한 Point 지역을 의미 투어 위치를 의미하는 것이 아니라 채널에서 여행자가 검색할 유명한 식당, 명소등의 지역 단, 관련 있는 지역으로 선택
distance_between_poi_n1_and_tour_course	Integer	POI {N1} 과 Course 와의 거리
unit_of_distance_for_poi_n1	Unit of Distance	POI {N1} 과 Course 와의 거리 단위
product_name	String	AX Cloud 에서 상품을 부르는 이름 채널과는 무관하다.
product_title_type_1	String	채널에 등록하기 위한 타입 1의 상품 타이틀 city-main title 의 형태로 한국어 25자 이내
product_title_type_2	String	채널에 등록하기 위한 타입 2 상품 타이틀 city-main title 의 형태로 한국어 40자 이내
product_title_type_3	String	채널에 등록하기 위한 타입 3 상품 타이틀 city-main title 의 형태로 한국어 50자 이내
product_title_type_4	String	채널에 등록하기 위한 타입 4 상품 타이틀 city-main title 의 형태로 한국어 50자 이내
product_title_type_5	String	채널에 등록하기 위한 타입 5 상품 타이틀 city-main title 의 형태로 한국어 50자 이내
product_sub_title_n1	String	채널에 등록하기 위한 캐치프레이즈
event_special_giving_n1	String	채널에 등록하기 위한 이벤트 혹은 특정 정보
ticket_infra_strength	String	티켓 제공시설의 특장점 소개
ticket_common_differentiation_n1	String	상품에 대한 차별점으로 토픽 1개씩 만 명시
ticket_type_n1_differentiation_n2	String	동일 일자내 티켓 구분시 티켓별 차별점
target_customer	String	대상이 되는 고객에 대한 설명
thumbnail_n1_type_1	String	대표 이미지 타입 1 URL 타입별 다른 해상도
thumbnail_n1_type_2	String	대표 이미지 타입 2 URL 타입별 다른 해상도
thumbnail_n1_type_3	String	대표 이미지 타입 3 URL 타입별 다른 해상도
thumbnail_n1_type_4	String	대표 이미지 타입 4 URL 타입별 다른 해상도
thumbnail_n1_type_5	String	대표 이미지 타입 5 URL 타입별 다른 해상도
thumbnail_n1_type_6	String	대표 이미지 타입 6 URL 타입별 다른 해상도
thumbnail_n1_type_7	String	대표 이미지 타입 7 URL 타입별 다른 해상도
sub_thumbnail_n1_type_1	String	서브 섬네일 타입 1 URL 타입별 다른 해상도
sub_thumbnail_n1_type_2	String	서브 섬네일 타입 2 URL 타입별 다른 해상도
sub_thumbnail_n1_type_3	String	서브 섬네일 타입 3 URL 타입별 다른 해상도
sub_thumbnail_n1_type_4	String	서브 섬네일 타입 4 URL 타입별 다른 해상도
sub_thumbnail_n1_type_5	String	서브 섬네일 타입 5 URL 타입별 다른 해상도
how_to_use_ticket	String	티켓 사용위치 안내
how_to_find_the_entry_point	String	입장 위치를 찾아오는 방법
shuttle_vehicle_provide	String	셔틀 버스등 제공 여부
shuttle_vehicle	String	셔틀 버스등 제공시 종류	“Shuttle Bus” “Shuttle Car” “Shuttle Ship” “Shuttle Boat”
meal_and_drink_provide_in_ticket_price	String	식음료 등 제공시 티켓가격에 포함 여부	“Yes” “No”
meal_and_drink_shop_provide	String	식음료 별도판매 여부	“Yes” “No”
ticket_type_divide_in_day	String	동일 일자 내 티켓 구분 여부	“Yes” “No”
ticket_type_n1_start_time	Time {HH:MM}	티켓 타입별 시작시간
ticket_type_n1_end_time_time	Time {HH:MM}	티켓 타입별 종료시간
seat_designation	String	좌석 지정형 여부	“Yes” “No”
ticket_type_n1_seat_code_list	List[String]	티켓 타입 별 좌석번호 리스트
seat_area_designation	String	좌석 구역지정형 여부	“Yes” “No”
ticket_type_n1_seat_area_code_list	List[String]	티켓 타입 별 구역번호 리스트
inclusion_which_traveler_cannot_choose_n1	String	여행자가 선택할 수 없는 포함 사항
exclusion_n1	String	불포함 사항
know_before_you_go_n1	String	주의 사항
covid_19_safety_updates_n1	String	코로나 안전 조치
additionally_safety_measures_for_covid	String	추가 안전 조치
frequently_asked_questions_n1_q	String	자주 묻는 질의응답의 질문
frequently_asked_questions_n1_a	String	자주 묻는 질의응답의 답변
what_to_bring_n1	String	준비물
only_adult	String	성인이상 구매 가능 여부	“Yes” “No”
adult_min_age	Integer	성인 최소 연령
adult_max_age	Integer	성인 최대 연령
youth_min_age	Integer	청소년 최소 연령
youth_max_age	Integer	청소년 최대 연령
child_min_age	Integer	아동 최소 연령
child_max_age	Integer	아동 최대 연령
infant_min_age	Integer	유아 최소 연령
infant_max_age	Integer	유아 최대 연령
senior_min_age	Integer	노인 최소 연령
senior_max_age	Integer	노인 최대 연령
reorder_limit_per_person	Choose from {Limit, Unlimited}	1인당 재주문 제한
maximum_purchase_allowed_quantity	Integer	최대 구매 허용 수량
purchase_under_the_age_of_19	String	19세 미만 구매 가능 여부	“Yes” “No”
booking_cutoff_deadline_before_start	Integer	시작 전 예약 마감 시간 타임존은 supplier company 의 operating hours 를 따른다
booking_payment_confirmation_time	Integer	예약 결제 확인 시간(단위 분) 예약후 n 분 이내에 결제하지 않으면 취소됨
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	Integer	취소 확정까지 걸리는 시간	0 8 16 24 72
refund_policy_comments	String	원하는 취소 환불 정책으로 참고용으로만 받는다. 작성한 내용이 그대로 적용되지 않고 채널의 규칙으로 적용된다.
automatic_order_approval	String	파트너가 주문을 자동 승인할지 여부	“Yes” “No”
how_to_check_traveler_on_site	String	고객 본인 확인 방법
how_to_use_vouchers	String	바우처 사용 방법
maximum_lead_time_for_sending_ticket	Integer	바우처 발송 최대 소요 시간
how_to_redemption	String	사용 완료 처리 방법	“Automatic redeemed after date” “Supplier handles redeem”

(3) Options

Key	Type	Description	Example

Key	Type	Description	Example
option_code	String	옵션에 대한 식별자(UUID)	“7c88ed31-fb75-4f8a-89eb-c5e1b6f5e6d8"
sales_period_name	String	판매 기간 이름
start_date_of_the_sale	Date	판매 기간 시작 날짜
end_date_of_the_sale	Date	판매 기간 종료 날짜
start_of_use_date	Date	사용 시작 날짜
end_of_use_date	Date	사용 종료 날짜
meal_and_drinks	String	식사와 음료 제공 여부	“Included“ “Not Included”
another_activity_ticket	String	다른 액티비티 티켓 제공 여부	“Included“ “Not Included”
inventory_quantity	Integer	인벤토리 재고
seat_area	String	좌석 구역
age	String	구매 대상	“Child” “Adult”
departure_time	Time	출발 시간
operation_day	String	요일	“Monday” “Tuesday” “Wednesday” “Thursday” “Friday” “Saturday” “Sunday” “Weekday” “Weekend” “Every day”
unit_net_price_usd	Float	유닛 당 넷 가격 USD
net_price_per_person_usd	Float	인당 넷 가격 USD
unit_selling_price_usd	Float	유닛당 판매 가격 USD
selling_price_per_person_usd	Float	인당 판매 가격 USD
unit_net_price_krw	Float	유닛 당 넷 가격 KRW
net_price_per_person_krw	Float	인당 넷 가격 KRW
unit_selling_price_krw	Float	유닛당 판매 가격 KRW
selling_price_per_person_krw	Float	인당 판매 가격 KRW

4) Response Example

{
  "status_code": 200,
  "required_traveler_information": {
    "english_name": false,
    "chinese_name": false,
    ...
  },
  "contents": {
    "product_listing_language": "Korean",
    ...
  },
  "options": [
    {
      "option_code": "d327bbf7-2052-4ebb-893a-ee952b694029",
      "sales_period_name": "상반기",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      ...
    }
  ]
}

5) Error Spec

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

3. Request Example

1) CURL

curl -X 'POST' \
  'https://prod.ax-cloud.com/v1/channel/products/day-ticket/3f33cdfe-8023-4fac-b81d-df9fee6bdedd' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'
  -d '{
  "status_code": 200,
  "required_traveler_information": {
    "english_name": false,
    "chinese_name": false,
    ...
  },
  "contents": {
    "product_listing_language": "Korean",
    ...
  },
  "options": [
    {
      "option_code": "d327bbf7-2052-4ebb-893a-ee952b694029",
      "sales_period_name": "상반기",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      ...
    }
  ]
}'

AX Cloud Channel Document

상품 - 날짜지정형 입장권 상세정보 조회

Analytics

1. Product Detail

1) Purpose

2) Detail

2. API spec

1) Request

2) Path Parameter

3) Response

(1) Required Traveler Information

(2) Contents

(3) Options

4) Response Example

5) Error Spec

3. Request Example

1) CURL

Related content