Versions Compared

Key

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

...

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에서 해당 주문의 상태를 동기화하기 위해 두 개의 주문 상태를 각각 변경합니다.

...

Endpoint

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

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

  • 상태 변경 시 남길 주석

...

Code Block
curl -X 'PATCH' \
  'https://prod.ax-cloud.com/v1/channel/orders/tour/915c1218-f41c-492b-bb0b-96177ff4d2ee' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -H "Channel: Code code_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": "여행자의 개인 사정으로 인한 취소"
}'

...