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/day-ticket
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

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

3) Response

Name		Type	Description

Name		Type	Description
status_code		Integer	정상 처리 시 200
products		List[Object]	판매 가능한 상품 리스트
	product_code	UUID	상품 식별자
	title	String	상품 제목
	category	String	상품 카테고리
	detail_category	String	상품 세부 카테고리
	start_date_of_the_sale	Date	판매 기간 시작 날짜
	end_date_of_the_sale	Date	판매 기간 종료 날짜
	cancellation_type	String	주문 취소 타입
	main_country_and_city	String	주 국가 및 도시 [국가-도시 데이터는 문의]

4) Response Example

{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703f",
      "title": "Louvre Highlight Ticket",
      "category": "Ticket-Day",
      "detail_category": "Museum",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      "main_country_and_city": "52-18"
    }
  ]
}

5) Error Spec

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

3. Request Example

1) CURL

curl -X 'GET' \
  'https://prod.ax-cloud.com/v1/channel/products/day-ticket' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'
  -d '{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703f",
      "title": "Louvre Highlight Ticket",
      "category": "Ticket-Day",
      "detail_category": "Museum",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      "main_country_and_city": "52-18"
    }
  ]
}'

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