1 1. Cancel Order
- 1.1 1) Purpose
- 1.2 2) Detail
2 2. API Spec
- 2.1 1) Request
- 2.2 2) Body Parameter
- 2.3 3) Response
- 2.4 4) Error Spec
3 3. Request Example
- 3.1 1) CURL

1. Cancel Order

1) Purpose

채널에서 발생한 여행자 취소에 대해 AX Cloud 에 요청 합니다.
해당 요청으로 채널에서 발생한 취소를 처리할 수 있습니다.
주문 전체 취소가 아니라 부분 취소를 원하면 티켓 단위로 취소할 수 있습니다. 주문 - 날짜지정형 입장권 주문 부분 취소 요청
채널에서 구매자의 주문 취소를 확정 후 AX Cloud와 동기화하기 위해 사용합니다.

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}

2) Body Parameter

Name	Required	Type	Description

Name	Required	Type	Description
channel_status	O	String	채널 내부 주문 상태 취소하고자 하는 주문 상태를 입력 주문의 상태는 아래와 같습니다. "New" : 새 주문 "Traveler cancel" : 여행자 취소 "Unavoidable cancel" : 불가피한 취소
comment	X	String	상태 변경 시 남길 주석

3) Response

Name		Type	Description

Name		Type	Description
status_code		Integer	정상 처리 시 200
data		Object	-
	channel_order_code	String	채널의 취소된 주문의 식별자
	channel_order_status	String	취소된 Channel의 주문 상태
	ax_order_code	String	AX의 취소된 주문의 식별자
	ax_order_status	String	취소된 AX의 주문 상태

{
  "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"
}

4) Error Spec

{'detail': '이 작업을 수행할 권한(permission)이 없습니다.'}

{'detail': '찾을 수 없습니다.'}

AX Cloud Channel Document

주문 - 날짜지정형 입장권 주문 전체 취소 요청

Analytics

1. Cancel Order

1) Purpose

2) Detail

2. API Spec

1) Request

2) Body Parameter

3) Response

4) Error Spec

3. Request Example

1) CURL