1 1. Product List
- 1.1 1) Purpose
- 1.2 2) Detail
2 2. API spec
- 2.1 1) Request
- 2.2 2) Query Parameter
- 2.3 3) Response
- 2.4 4) Response Example
- 2.5 5) Error Spec
3 3. Request Example
- 3.1 1) CURL

1. Product List

1) Purpose

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

2) Detail

Header에 입력한 정보와 일치하는 Channel이 판매 가능한 Product List를 보여줍니다.
유효한 API Key를 Request Header에 토큰으로 입력해야만 호출 가능합니다.
하나의 특정한 Product에 대한 상세 조회는 별도의 API에서 가능합니다. - 상품 - 투어상품 상세정보 조회

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}

2) Query Parameter

Name	Required	Type	Description

Name	Required	Type	Description
page	X	Integer	Page number(default : 1)
page_size	X	Integer	Size per page(default : 25)

3) Response

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

Name		Type	Description	Example

Name		Type	Description	Example
status_code		Integer	정상 처리 시 200	200 403
products		List[Object]	판매 가능한 상품 리스트
	product_code	String	상품 식별자 (UUID)
	category	String	상품 카테고리	“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

{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703e",
      "category": "Tour", 
      "product_listing_language": "Englisg",
      "tour_guide_certification": "Yes",
      "separate_driver_included": "No",
      "product_name": "New Bern City Tour"
      "departure_city": "United States - New Bern, NC", 
      "transportation": "On Foot", 
      "cancellation_type": "Anytime cancellation"
    }
  ]
}

5) Error Spec

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

3. Request Example

1) CURL

 curl --location --request GET 'https://test.ax-cloud.com/v1/channel/products/tour' \
--header 'Authorization: Token <access_key>' \
--data ''

AX Cloud Channel Document

상품 - 투어상품 조회

Analytics

1. Product List

1) Purpose

2) Detail

2. API spec

1) Request

2) Query Parameter

3) Response

4) Response Example

5) Error Spec

3. Request Example

1) CURL

Related content