Table of Contents

1. Product List

1) Purpose

Channel에서 판매 가능한 Product List를 확인하기 위한 API입니다.

2) Detail

Header에 입력한 정보와 일치하는 Channel이 판매 가능한 Product List를 보여줍니다.
유효한 API Key를 Request Header에 토큰으로 입력해야만 호출 가능합니다.
하나의 특정한 Product에 대한 상세 조회는 별도의 API에서 가능합니다. - https://axchange.atlassian.net/wiki/spaces/ACCD/pages/edit-v2/398327880

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
dataproducts		List[Object]	판매 가능한 상품 리스트
	product_idcode	String	상품 아이디	title	String	상품 제목	식별자 (UUID)
	category	String	상품 카테고리departure_city	“Activity”	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의 주소	selling_price	String	채널 판매 가격	selling_price_currency	String	채널 판매 통화	“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

title	Status Code : 200 정상 처리 시

Code Block

language	json

{
  "status_code": 200,
  "dataproducts": [
    {
      "idproduct_code": 1,
      "title": "Test""1f373f00-ecb0-485a-beed-63529d61703e",
      "category": "TestTour", 
      "departure_city": "Test", 
      "transportation": "Test", 
      "booking_available_start_dateproduct_listing_language": "TestEnglisg",
       "cancellation_type": "Test", 
      "main_country_and_citytour_guide_certification": "TestYes",
       "countryseparate_anddriver_city_1included": "TestNo",
      "country_and_city_2product_name": "Test",New Bern      "country_and_city_3": "Test",City Tour"
       "country_anddeparture_city_4": "Test",United States -     "country_and_city_5": "Test",
      "country_and_city_6": "Test"New Bern, NC", 
     "course_1_address": "Test",
      "course_2_address "transportation": "Test",
      "course_3_address": "Test"On Foot", 
     "course_4_address": "Test",
      "course_5_address "cancellation_type": "Test",
      "course_6_address": "Test",
      "course_7_address": "Test",
      "course_8_address": "Test",
      "course_9_address": "Test",
      "course_10_address": "Test"
    Anytime cancellation"
    }
  ]
}

5) Error Spec

...

title	Status Code : 400 Cause: 유효하지 않은 요청 값

...

Expand

title	Status 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''

...

Version	Old Version 31	New Version Current
Changes made by	송훈일Neil	남기윤Joel
Saved on	Mar 23, 2023	Apr 06, 2023

Content Comparison

Versions Compared

Key

1. Product List

1) Purpose

2) Detail

2. API spec

1) Request

2) Query Parameter

3) Response

4) Response Example

5) Error Spec

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

3. Request Example

1) CURL

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