Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

1.

...

Updated List

1) Purpose

  • 채널에 최초 상품을 등록한 이후, 채널에서 등록한 상품들 중, Supplier에 의해 상품 정보에 변경이 발생한 상품의 간략한 정보를 확인할 수 있습니다.

2) Detail

  • 유효한 API Key를 request Header에 토큰으로 정해진 형식으로 입력해야만 호출 가능합니다.

  • 채널에 업로드할 투어의 데이터를 탐색할 수 있습니다변경이 발생한 상품의 상세 정보는 상품 - 투어상품 상세정보 조회 에서 확인하여 채널에 반영하도록 합니다.

  • 업데이트 이후 옵션 매핑에 변경이 있었다면, 상품 - 등록 투어상품 매핑 요청 에서 다시 옵션 정보를 매핑 하도록 합니다.

2. API

...

Spec

1) Request

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/products/tour/update

test environment: https://test.ax-cloud.com/v1/channel/products/tour/update

Method

GET

Description

상품 리스트 가져오기

업데이트된 상품정보 확인

Content-Type

application/json

Headers > Authorization

Token {api_key

}

Headers > Channel

Code {channel_code

}

2) Query Parameter

Name

Required

Type

Description

product_id

page

O

X

int

Product ID

3) Type Concepts

  • 이 문서에서 사용하는 Type을 정의합니다.

(1) Required Traveler Information

  • 여행자의 주문 발생시 아래 항목 중 True인 항목에 대해 동일한 이름의 {Key : Value} 형식으로 ticket.additional에 담아 전송해야 합니다.

  • Value는 일괄적으로 string으로 전달해주세요. 별도의 제한 양식은 없습니다.

...

Name

...

Type

...

Description

...

english_name

...

bool

...

  • 공급사가 필요한 정보중 여행자의 영어 이름

...

chinese_name

...

bool

...

  • 공급사가 필요한 정보중 여행자의 중국어 이름

...

nationality

...

bool

...

  • 공급사가 필요한 정보중 여행자의 국적

...

language

...

bool

...

  • 공급사가 필요한 정보중 여행자의 사용 언어

...

gender

...

bool

...

  • 공급사가 필요한 정보중 여행자의 성별

...

date_of_birth

...

bool

...

  • 공급사가 필요한 정보중 여행자의 생년월일

...

passport_id

...

bool

...

  • 공급사가 필요한 정보중 여행자의 여권 아이디

...

passport_expiry

...

bool

...

  • 공급사가 필요한 정보중 여행자의 여권 만료일

...

drivers_license_id

...

bool

...

  • 공급사가 필요한 정보중 여행자의 운전 면허 아이디

...

drivers_license_expiry

...

bool

...

  • 공급사가 필요한 정보중 여행자의 운전 면허 만료일

...

weights

...

bool

...

  • 공급사가 필요한 정보중 여행자의 체중

...

heights

...

bool

...

  • 여행자의 키

...

vegetarian

...

bool

...

  • 여행자가 채식주의자 인지 여부

...

sns_for_communication

...

bool

...

  • 여행자와 소통 가능한 SNS 종류

...

arrival_flight_detail_airline

...

bool

...

  • 여행자의 도착 항공사

...

arrival_flight_detail_flight_number

...

bool

...

  • 여행자의 도착 항공편명

...

arrival_flight_detail_arrival_date

...

bool

...

  • 여행자의 도착 날짜(도착 국가 기준)

...

arrival_flight_detail_arrival_time

...

bool

...

  • 여행자의 도착 시각(도착 국가 기준)

...

departure_flight_detail_airline_name

...

bool

...

  • 여행자의 출발 항공사

...

departure_flight_detail_flight_number

...

bool

...

  • 여행자의 출발 항공편명

...

departure_flight_detail_departure_date

...

bool

...

  • 여행자의 출발 날짜(출발 국가 기준)

...

departure_flight_detail_departure_time

...

bool

...

  • 여행자의 출발 날짜(출발 국가 기준)

...

pickup_hotel_details_pickup_hotel_name

...

bool

...

  • 여행자의 픽업 호텔

...

pickup_hotel_details_pickup_hotel_address

...

bool

...

pickup_hotel_details_pickup_hotel_room_number

...

bool

...

drop_off_hotel_details_drop_off_hotel_name

...

bool

...

drop_off_hotel_details_drop_off_hotel_address

...

bool

...

drop_off_hotel_details_drop_off_hotel_number

...

bool

...

arrival_ship_details_arrival_ship_name

...

bool

...

arrival_ship_details_arrival_ship_disembarkation_time

...

bool

...

departure_ship_details_departure_ship_name

...

bool

...

departure_ship_details_departure_ship_boarding_time

...

bool

...

shore_excursion_deatails_shore_excursion_ship_name

...

bool

...

shore_excursion_deatails_arrival_ship_disembarkation_time

...

bool

...

shore_excursion_deatails_departure_ship_boarding_time

...

bool

...

arrival_train_details_arrival_rail_line

...

bool

...

arrival_train_details_arrival_rail_station

...

bool

...

arrival_train_details_rail_arrival_time

...

bool

...

departure_train_details_departure_rail_line

...

bool

...

departure_train_details_departure_rail_station

...

bool

...

departure_train_details_rail_departure_time

...

bool

(2) Contents

Key

product_listing_language

tour_guide_certification

seperate_driver_included

main_country_and_city

country_and_city_n_1

keyword_city

keyword_others_n_1

course_main_title

departure_city

transportation

day_n_1_course_n_2_title

day_n_1_course_n_2_description

day_n_1_course_n_2_address

day_n_1_course_n_2_country

day_n_1_course_n_2_city

day_n_1_course_n_2_post_code

day_n_1_course_n_2_photo_type_1

day_n_1_course_n_2_photo_type_2

day_n_1_course_n_2_schedule_n_3_title

day_n_1_course_n_2_schedule_n_3_time

poi_n_1

distance_between_poi_n_1_and_tour_course

unit_of_distance_for_poi_n_1

product_name

product_title_type_1

product_title_type_2

product_title_type_3

product_title_type_4

product_title_type_5

product_sub_title_n_1

event_special_giving_n_1

tour_guide_strength

product_differentiation_n_1

target_customer

thumbnail_n_1_type_1

thumbnail_n_1_type_2

thumbnail_n_1_type_3

thumbnail_n_1_type_4

thumbnail_n_1_type_5

thumbnail_n_1_type_6

thumbnail_n_1_type_7

sub_thumbnail_n_1_type_1

sub_thumbnail_n_1_type_2

sub_thumbnail_n_1_type_3

sub_thumbnail_n_1_type_4

sub_thumbnail_n_1_type_5

how_to_meet_travelers

meeting_point_n_1_address

meeting_point_n_1_country

meeting_point_n_1_city

meeting_point_n_1_post_code

meeting_point_n_1_description

how_to_find_the_meeting_point_n_1

pickup_support

pickup_location_type_hotel

pickup_location_type_airport

pickup_location_type_port

pickup_location_type_other

pickup_start_time_before_tour

additional_pickup_details

how_to_enter_hotel_information_for_pickup

central_location_address_for_the_general_area_of_hotel_pickup

radius_from_central_location_for_hotel_pickup

hotel_pickup_radius_unit

hotel_n_1_name_you_identified_for_pickup

hotel_n_1_address_you_idendtified_for_pickup

port_n_1_name_you_identified_for_pickup

port_n_1_address_you_identified_for_pickup

airport_n_1_name_you_identified_for_pickup

airport_n_1_address_you_identified_for_pickup

default_duration_hour

the_start_date_to_which_operation_time_n_1_applied

the_end_date_to_which_operation_time_n_1_applied

meeting_time_n_1

departure_time_n_1

finish_time_n_1

duration_time_n_1

inclusion_which_traveler_cannot_choose_n_1

exclusion_n_1

know_before_you_go_n_1

covid_19_safety_updates_n_1

additionally_safety_measures_for_covid

frequently_asked_questions_n_1_q

frequently_asked_questions_n_1_a

what_to_bring_n_1

adult_min_age

adult_max_age

youth_min_age

youth_max_age

child_min_age

child_max_age

infant_min_age

infant_max_age

senior_min_age

senior_max_age

traveler_required_information_non_basic_additional_information

traveler_required_information_english_name

traveler_required_information_chinese_name

traveler_required_information_nationality

traveler_required_information_language

traveler_required_information_gender

traveler_required_information_date_of_birth

traveler_required_information_passport_id

traveler_required_information_passport_expiry

traveler_required_information_drivers_license_id

traveler_required_information_drivers_license_expiry

traveler_required_information_weights

traveler_required_information_heights

traveler_required_information_vegetarian

traveler_required_information_sns_for_communication

traveler_required_information_arrival_flight_detail_airline_name

traveler_required_information_arrival_flight_detail_flight_number

traveler_required_information_arrival_flight_detail_arrival_date

traveler_required_information_arrival_flight_detail_arrival_time

traveler_required_information_departure_flight_detail_airline_name

traveler_required_information_departure_flight_detail_flight_number

traveler_required_information_departure_flight_detail_departure_date

traveler_required_information_departure_flight_detail_departure_time

traveler_required_information_pickup_hotel_details_pickup_hotel_name

traveler_required_information_pickup_hotel_details_pickup_hotel_address

traveler_required_information_pickup_hotel_details_pickup_hotel_room_number

traveler_required_information_drop_off_hotel_details_drop_off_hotel_name

traveler_required_information_drop_off_hotel_details_drop_off_hotel_address

traveler_required_information_drop_off_hotel_details_drop_off_hotel_room_number

traveler_required_information_arrival_ship_details_arrival_ship_name

traveler_required_information_arrival_ship_details_arrival_ship_disembarkation_time

traveler_required_information_departure_ship_details_departure_ship_name

traveler_required_information_departure_ship_details_departure_ship_boarding_time

traveler_required_information_shore_excursion_deatails_shore_excursion_ship_name

traveler_required_information_shore_excursion_deatails_arrival_ship_disembarkation_time

traveler_required_information_shore_excursion_deatails_departure_ship_boarding_time

traveler_required_information_arrival_train_details_arrival_rail_line

traveler_required_information_arrival_train_details_arrival_rail_station

traveler_required_information_arrival_train_details_rail_arrival_time

traveler_required_information_departure_train_details_departure_rail_line

traveler_required_information_departure_train_details_departure_rail_station

traveler_required_information_departure_train_details_rail_departure_time

reorder_limit_per_person

maximum_purchase_allowed_quantity

purchase_under_the_age_of_19

booking_cutoff_deadline_before_tour_start

booking_payment_confirmation_time

cancellation_type

cancel_confimation_method

weekend_cancellation_confirmed

refund_confirmation_time

refund_policy_comments

automatic_order_approval

how_to_check_traveler_on_site

how_to_use_vouchers

voucher_type

voucher_per_participant

maximum_lead_time_for_sending_voucher

how_to_redemption

Integer

default : 1

page_size

X

Integer

default : 25

3) Response

Expand
titleStatus Code : 201 Response: 업데이트된 정보가 있는 product info
Code Block
{
  "data": [
    {
      "product_code" : <string>,
      "title": <string>,
      "version": <int>
    },
    {
      "product_code" : <string>,
      "title": <string>,
      "version": <int>
    },
    ...
  ]
}

4) Error Spec

Expand
titleStatus Code : 400 Cause: 유효하지 않은 요청 값
Code Block
{'detail': "유효하지 않은 query입니다.")]}
Expand
titleStatus Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
Code Block
{'detail': ErrorDetail(string='이 작업을 수행할 권한(permission)이 없습니다.', code='permission_denied')}

3. Request Example

1) CURL

Code Block
languagebash
curl --location --request GET\
 'https://prod.ax-cloud.com/v1/channel/products/tour/update' \
--header 'Authorization: Token <access_key>' \
--header 'Content-Type: application/json'