Versions Compared

Version Old Version 21 New Version 22
Changes made by

송훈일Neil

송훈일Neil

Saved on

Key

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

...

Name

Required

Type

Description

ax_status

O

String

  • AX 내부 주문 상태

  • 취소하고자 하는 주문 상태를 입력

  • 주문의 상태는 아래와 같습니다.

    • "New" : 새 주문
      "Traveler cancel" : 여행자 취소
      "Unavoidable cancel" : 불가피한 취소

channel_status

O

String

  • 채널 내부 주문 상태

  • 취소하고자 하는 주문 상태를 입력

  • 주문의 상태는 아래와 같습니다.

    • "New" : 새 주문
      "Traveler cancel" : 여행자 취소
      "Unavoidable cancel" : 불가피한 취소

comment

X

String

  • 상태 변경 시 남길 주석

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

data

Object

-

channel_order_code

String

채널의 취소된 주문의 식별자

channel_order_status

String

취소된 Channel의 주문 상태

ax

List[Object]

-

ax_order_code

String

AX의 취소된 주문의 식별자

ax_order_status

String

취소된 AX의 주문 상태comment

String

취소시 남긴 주석

Expand
titleStatus Code : 200 Response: 취소 완료된 값
Code Block
{
  "channel_order_code": "915c1218-f41c-492b-bb0b-96177ff4d2ee",
  "channel_order_status": "Traveler cancel",
  "ax_order_code": "b9872ed4-12c5-4fb5-ae18-4f39b11ee912",
  "ax_order_status": "Traveler cancel",
  "comment": "여행자의 개인 사정으로 인한 취소"
}

4) Error Spec

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

3. Request Example

...

Code Block
curl -X 'PATCH' \
  'https://test.ax-cloud.com/v1/channel/orders/day-ticket/915c1218-f41c-492b-bb0b-96177ff4d2ee' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -d '{
  "channel_order_code": "915c1218-f41c-492b-bb0b-96177ff4d2ee",
  "channel_order_status": "Traveler cancel",
  "ax_order_code": "b9872ed4-12c5-4fb5-ae18-4f39b11ee912",
  "ax_order_status": "Traveler cancel",
  "comment": "여행자의 개인 사정으로 인한 취소"
}'

...