Versions Compared

Version Old Version 46 New Version Current
Changes made by

남기윤Joel (Unlicensed)

남기윤Joel (Unlicensed)

Saved on

Key

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

...

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] “Void“로 로 표기됩니다.

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

Choose from {
Yes,
No
}

String

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

  • “Yes”

  • “No”

separate_driver_included

Choose from {
Yes,
No
}

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",
      "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"
    }
  ]
}

...

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>' \
  --ddata '{
  "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"
    }
  ]
}''

...