Versions Compared

Version Old Version 40 New Version Current
Changes made by

김전도Flip (Unlicensed)

남기윤Joel (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

2. API spec

1) Request

Endpoint

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

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

Method

GET

Description

Product List 를 조회합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Query Parameter

Name

Required

Type

Description

page

X

Integer

Page number(default : 1)

page_size

X

Integer

Size per page(default : 25)

3) Response

Info

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

Name

Type

Description

Example

status_code

Integer

정상 처리 시 200

  • 200

  • 403

products

List[Object]

판매 가능한 상품 리스트

product_code

String

상품 식별자

title

String

상품 제목(UUID)

category

String

상품 카테고리

start_date_of_the_sale

Date

판매 기간 시작 날짜

end_date_of_the_sale

Date

판매 기간 종료 날짜

departure_city

String

출발 도시

transportation

String

탈 것

booking_available_start_date

String

예약 가능한 날짜

cancellation_type

String

주문 취소 타입

main_country_and_city

String

주 국가 및 도시

[국가-도시 데이터는 문의]

country_and_city_1

String

국가 및 도시1

country_and_city_2

String

국가 및 도시2

country_and_city_3

String

국가 및 도시3

country_and_city_4

String

국가 및 도시4

country_and_city_5

String

국가 및 도시5

country_and_city_6

String

국가 및 도시6

course_1_address

String

코스 1의 주소

course_2_address

String

코스 2의 주소

course_3_address

String

코스 3의 주소

course_4_address

String

코스 4의 주소

course_5_address

String

코스 5의 주소

course_6_address

String

코스 6의 주소

course_7_address

String

코스 7의 주소

course_8_address

String

코스 8의 주소

course_9_address

String

코스 9의 주소

course_10_address

String

코스 10의 주소

  • “Activity”

  • “Tour”

product_listing_language

String

상품 언어

  • “French”

  • “Korean”

tour_guide_certification

String

투어 가이드의 자격증 소지 여부

  • “Yes”

  • “No”

separate_driver_included

String

투어 가이드가 운전사 역할도 하는지 여부

  • “Yes”

  • “No”

product_name

String

상품 이름

  • "Paris City Tour"

departure_city

String

출발 도시 요청 - 표준 데이터

  • “France - Paris”

  • “South Korea - Seoul”

  • “United Kingdom - London”

transportation

String

도보/차량

  • “Walking“

  • “Vehicle“

cancellation_type

String

  • 주문 취소 타입

    • Anytime cancellation: 언제든지 취소 가능

    • Cancellation in according to rules: 서플라이어의 규칙에 따른다.

    • Non-refundable: 취소불가가

  • “Anytime cancellation”

  • “Cancellation in according to rules”

  • “Non-refundable”

4) Response Example

Expand
titleStatus Code : 200 정상 처리 시
Code Block
languagejson
{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703e",
  
   "title": "Louvre Highlight Tour",
      "category": "Tour", 
      "departureproduct_listing_citylanguage": "52-18Englisg",
       "starttour_date_of_the_saleguide_certification": "2023-03-01Yes",
      "endseparate_date_of_the_saledriver_included": "2024-03-31No",
      "transportation": "On Foot", 
      "booking_available_start_dateproduct_name": "BookingNew availableBern fromCity tomorrowTour",
       "cancellation_type": "Anytime cancellation", 
      "main_country_and"departure_city": "52-18",United 
      "country_and_city_1": "52-18",
      "country_and_city_2": "Void",
      "country_and_city_3": "VoidStates - New Bern, NC", 
     "country_and_city_4": "Void",
      "country_and_city_5 "transportation": "Void",
      "country_and_city_6": "Void"On Foot", 
     "course_1_address": "Rue de Rivoli, 75001 Paris, France",
      "course_2_address "cancellation_type": "Void",
      "course_3_address": "Void",
  Anytime cancellation"
   "course_4_address": "Void",
      "course_5_address": "Void",
      "course_6_address": "Void",
      "course_7_address": "Void",
      "course_8_address": "Void",
      "course_9_address": "Void",
      "course_10_address": "Void"
    }
  ]
}

5) Error Spec

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
 curl --location -X-request 'GET' \
  'https://prodtest.ax-cloud.com/v1/channel/products/tour' \
  -H 'accept: application/json' \
 
-H 'Content-Type: application/json' \
  -H '-header 'Authorization: Token api<access_key_secretkey>' \
  --Hdata 'Channel: Code code_secret'
  -d '{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703e",
      "title": "Louvre Highlight Tour",
      "category": "Tour", 
      "departure_city": "52-18", 
      "transportation": "On Foot", 
      "booking_available_start_date": "Booking available from tomorrow", 
      "cancellation_type": "Anytime cancellation", 
      "main_country_and_city": "52-18", 
      "country_and_city_1": "52-18",
      "country_and_city_2": "Void",
      "country_and_city_3": "Void",
      "country_and_city_4": "Void",
      "country_and_city_5": "Void",
      "country_and_city_6": "Void",
      "course_1_address": "Rue de Rivoli, 75001 Paris, France",
      "course_2_address": "Void",
      "course_3_address": "Void",
    
 "course_4_address": "Void",
      "course_5_address": "Void",
      "course_6_address": "Void",
      "course_7_address": "Void",
      "course_8_address": "Void",
      "course_9_address": "Void",
      "course_10_address": "Void"
    }
  ]
}'

...