Versions Compared

Version Old Version 6 New Version Current
Changes made by

김상효Mike (Unlicensed)

송훈일Neil

Saved on

Key

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

...

1. Cancel Order

1) Purpose

  • 채널에서 발생한 여행자 취소에 대해 AX Cloud 에 요청 합니다.

  • 해당 요청으로 채널에서 발생한 취소를 처리할 수 있습니다.

  • 주문 전체 취소가 아니라 부분 취소를 원하면 티켓 단위로 취소할 수 있습니다. 주문 - 티켓 날짜지정형 입장권 주문 부분 취소 요청

  • 채널에서 구매자의 주문 취소를 확정 후 AX Cloud와 동기화하기 위해 사용합니다.

Drawio
mVer2
zoom1
simple0
inComment0
pageId399441934
custContentId400556600
lbox1
diagramDisplayName제목 없는 다이어그램-1679529724776.drawio
contentVer1
revision2
baseUrlhttps://axchange.atlassian.net/wiki
diagramName제목 없는 다이어그램-1679529724776.drawio
pCenter0
width627
links
tbstyle
height311

2) Detail

  • 고유한 채널 코드와 유효한 API Key 를 Request Header에 정해진 형식으로 입력해야만 호출 가능합니다.

  • AX에서 해당 주문의 상태와 Channel에서 해당 주문의 상태를 동기화하기 위해 두 개의 주문 상태를 각각 변경합니다.

2. API Spec

1) Request

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/orders/day-ticket/{ax_order_code}

test environment: https://test.ax-cloud.com/v1/channel/orders/tour/{ax_order_code}

Method

PATCH

Description

주문 상태 변경취소

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Body Parameter

String

Name

Required

Type

Description

ax_status

O

  • AX 내부 주문 상태

  • 변경하고자 하는 주문 상태를 입력

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

    • {"1": "New"}, # 새 주문
      {"5": "Traveler cancel"}, # 여행자 취소
      {"6": "Unavoidable cancel"} # 불가피한 취소

channel_status

O

String

  • 채널 내부 주문 상태

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

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

    • {"1New" : "New"}, # 새 주문
      {"5": "Traveler cancel" }, # : 여행자 취소
      {"6": "Unavoidable cancel" } # : 불가피한 취소

comment

X

String

  • 상태 변경 시 남길 주석

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

data

Object

-

channel_order_code

IntegerString

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

axchannel_order_status

String

갱신된 AX의 취소된 Channel의 주문 상태

channelax_order_statuscode

String

갱신된 Channel의 주문 상태

commentAX의 취소된 주문의 식별자

ax_order_status

String갱신시 남긴 주석

취소된 AX의 주문 상태

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

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

1) CURL

Code Block
curl -X 'PATCH' \
  'https://prodtest.ax-cloud.com/v1/channel/orders/day-ticket/915c1218-f41c-492b-bb0b-96177ff4d2ee' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: qE3VQawgUcqbERA2G3LiGZQ1gPQuZZQLNmz9OmMxB7EuDCGMjjEgMQMsdVcGi7kw' \   -H "Authorization: Token api_key_secret" \
  -H "Channel: Code code_secret" \
  -d '{
  "axchannel_order_status": "5",
  "channel_status": "5Traveler cancel",
  "comment": "여행자의 개인 사정으로 인한 취소"
}'

...