Versions Compared

Version Old Version 5 New Version 6
Changes made by

김상효Mike

송훈일Neil

Saved on

Key

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

...

2. API Spec

1) Request

Endpoint

구현 예정https://prod.ax-cloud.com/v1/channel/orders/tour/{order_code}

Method

GET

Description

주문 확정 요청정보 조회

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2)

...

  • 구현 예정

3) Response

  • 구현 예정

4) Error Spec

...

Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

data

List[Object]

주문의 상태 및 상태에 대한 주석

channel_order_code

string

채널에서의 주문 식별자

ax_order_code

string

AX의 주문 식별자

status

String

  • 주문 상태

  • 주문 상태는 다음과 같습니다.

    • {"1": "New"}, # 새 주문
      {"2": "Supplier pending"}, # Supplier 대기
      {"3": "Supplier confirm"}, # Supplier 확정
      {"4": "Supplier reject"}, # Supplier 거절
      {"5": "Traveler cancel"}, # 여행자 취소
      {"6": "Unavoidable cancel"} # 불가피한 취소

comment

String

주문 상태에 대한 주석

Expand
titleStatus Code : 200 정상 처리 시
Code Block
languagejson
{
  "status_code": 200,
  "data": [
    {
      "channel_order_code": "af01c7c4-1637-46fb-b289-a090a9be0397",
      "ax_order_code": "d96b2ed4-12c5-4fb5-ae94-4f39b11ee980",
      "status": 3,
      "comment": "Supplier 확정",
    }
  ]
}

3) Error Spec

Expand
titleStatus Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
Code Block
{'message': '이 작업을 수행할 권한(permission)이 없습니다.'}
Expand
titleStatus Code : 404 Cause: 유효하지 않은 order_code
Code Block
{'message': '찾을 수 없습니다.'}

3. Request Example

1) CURL

...

Code Block
curl -X 'GET' \
  'https://prod.ax-cloud.com/v1/channel/orders/ticket/d96b2ed4-12c5-4fb5-ae94-4f39b11ee980' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: qE3VQawgUcqbERA2G3LiGZQ1gPQuZZQLNmz9OmMxB7EuDCGMjjEgMQMsdVcGi7kw' \
  -H "Authorization: Token api_key_secret" \
  -H "Channel: Code code_secret"