Versions Compared

Version Old Version 3 New Version Current
Changes made by

김상효Mike

김상효Mike

Saved on

Key

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

...

1. Product List

1) Purpose

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

2) Detail

2. API spec

1) Request

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/products/tourday-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

page

X

Integer

Page number(default : 1)

page_size

X

Integer

Size per page(default : 25)

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

dataproducts

List[Object]

판매 가능한 상품 리스트

product_idcode

StringUUID

상품 아이디식별자

title

String

상품 제목

category

String

상품 카테고리

departuredetail_citycategory

String

출발 도시

transportation

String

탈 것

booking_available_start_date

String

예약 가능한 상품 세부 카테고리

start_date_of_the_sale

Date

판매 기간 시작 날짜

end_date_of_the_sale

Date

판매 기간 종료 날짜

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

채널 판매 통화[국가-도시 데이터는 문의]

4) Response Example

Expand
titleStatus Code : 200 정상 처리 시
Code Block
languagejson
{
  "status_code": 200,
  "dataproducts": [
    {
      "id": 1,
      "title": "Test",
      "category": "Test", 
      "departure_cityproduct_code": "Test1f373f00-ecb0-485a-beed-63529d61703f", 
      "transportationtitle": "Test",Louvre 
      "booking_available_start_date": "Test", Highlight Ticket",
      "cancellation_typecategory": "TestTicket-Day", 
      "main_country_and_citydetail_category": "TestMuseum", 
      "countrystart_anddate_city_1": "Test",
      "country_and_city_2of_the_sale": "Test2023-03-01",
      "countryend_anddate_city_3": "Test",
      "country_and_city_4of_the_sale": "Test2024-03-31",
      "country_and_city_5": "Test",
      "main_country_and_city_6": "Test",
      "course_1_address": "Test",
      "course_2_address": "Test",
      "course_3_address": "Test",
      "course_4_address": "Test",
      "course_5_address": "Test",
      "course_6_address": "Test",
      "course_7_address": "Test",
      "course_8_address": "Test",
      "course_9_address": "Test",
      "course_10_address": "Test"
    52-18"
    }
  ]
}

5) Error Spec

...

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

...

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 -X 'GET' \
  'https://prod.ax-cloud.com/v1/channel/products/tourday-ticket' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKENAuthorization: gVNVnmaKfzEovZJFYXnxVkZsluzfXFWJDDj9lyq1WuSHuKPpBdgv1bVTiAVrgNquToken api_key_secret' \
  -H 'AuthorizationChannel: TokenCode api_keycode_secret' \
  -Hd 'Channel: Code code_secret{
  "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"
    }
  ]
}'

...