Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 39 Current »

1. Cancel Ticket

1) Purpose

  • 티켓은 주문의 일부분 입니다. 티켓의 취소는 주문의 부분 취소를 의미 합니다.

  • 티켓을 취소하면 주문의 부분 취소를 할 수 있습니다.

  • 채널에서 구매자가 주문의 부분 취소를 했고, 이를 Channel에서 확정했으며, AX와 동기화 요청을 위해 사용합니다.

2) Detail

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

  • 티켓 별로 여행자의 사정에 의해 주문 전체적이 아닌, 주문 부분적으로 취소가 있을 수 있습니다.

2. API Spec

1) Request

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/orders/tour/{ax_order_code}/tickets/{ticket_code}

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

Method

PATCH

Description

주문 부분 취소(티켓 취소)

Content-Type

application/json

Headers > Authorization

Token {api_key}

2) Body Parameter

Name

Required

Type

Description

status

O

String

  • AX 측 티켓의 상태를 동기화 하고자 하는 상태('Traveler canceled')로 전달

  • 티켓의 상태는 다음과 같습니다.

    • "New" : 새 티켓
      "Traveler canceled" : 여행자 취소

comment

X

String

  • 취소 시 남길 주석

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

data

Object

-

channel_order_code

String

취소된 티켓이 종속된 채널의 주문 식별자

ax_order_code

String

취소된 티켓이 종속된 AX의 주문 식별자

ax_order_status

String

취소된 티켓이 종속된 AX의 주문의 상태

ax_ticket_code

String

취소된 티켓의 식별자

ax_ticket_status

String

취소된 티켓의 상태

 Status Code : 200 Response: 취소 완료된 값
{
  "channel_order_code": "d96b3ed4-12c5-4fb5-ae22-4f39b11ee980",
  "ax_order_status": "New",
  "ax_order_code": "b9872ed4-12c5-4fb5-ae18-4f39b11ee912",
  "ax_ticket_code": "827c0381-f41c-492b-bb0b-88229ff4d2ee",
  "ax_ticket_status": "Traveler canceled",
}

4) Error Spec

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

3. Request Example

1) CURL

curl -X 'PATCH' \
  'https://test.ax-cloud.com/v1/channel/orders/tour/b9872ed4-12c5-4fb5-ae18-4f39b11ee912/tickets/915c1218-f41c-492b-bb0b-96177ff4d2ee' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -d '{ \
  "status": "Traveler canceled"
}'

  • No labels