상품 - 등록 날짜지정형 입장권 매핑 요청
- 김상효Mike (Unlicensed)
- 송훈일Neil
- 오숙영Jenny Oh
- 1 1. Product Registration
- 1.1 1) Purpose
- 1.2 2) Detail
- 2 2. API spec
- 2.1 1) Request
- 2.2 2) Path Parameter
- 2.3 3) Request Body
- 2.3.1 (1) Mapping Data
- 2.4 4) Response
- 2.5 5) Error Spec
- 3 3. Request Example
- 3.1 1) CURL
1. Product Registration
1) Purpose
상품 최초 등록과 등록 이후 발생한 상품 업데이트를 채널에 적용합니다.
주문 처리를 위해 채널의 상품 데이터와 매핑하는 용도입니다.
2) Detail
유효한 API Key를 Request Header에 토큰으로 입력해야만 호출 가능합니다.
상품 - 날짜지정형 입장권 상세정보 조회 을 통해 가져온 Product Data를 채널에 업로드 한 이후, AX에 업로드 완료된 정보를 전송합니다.
상품 업데이트 이후, 이 API를 통해 옵션 매핑데이터를 다시 전달해주셔야 합니다.
2. API spec
1) Request
Endpoint | product environment: https://prod.ax-cloud.com/v1/channel/products/day-ticket/registration/{product_code} |
|---|---|
Method | POST |
Description | 상품 등록 및 옵션 매핑 |
Content-Type | application/json |
Headers > Authorization | Token {api_key} |
Headers > Channel | Code {channel_code} |
2) Path Parameter
Name | Required | Type | Description | Example |
|---|---|---|---|---|
product_code | O | String | Product ID(UUID) |
|
3) Request Body
Name | Required | Type | Description | Example |
|---|---|---|---|---|
mapping_data | O | Object |
|
|
channel_product_name | O | String |
|
|
channel_product_link | O | String |
|
|
channel_product_id | O | String |
|
|
(1) Mapping Data
AX의 옵션 데이터를 이용해 채널의 옵션과 매핑합니다.
옵션 이름은 여행자에게 노출되는 이름입니다.
한 상품에서 같은 옵션명을 사용해서는 안됩니다.
AX의 모든 옵션 데이터를 매핑해야 합니다.
{
<option_code>: <채널에서 설정한 옵션 이름(여행자에게 노출되는 이름)>,
<option_code>: <채널에서 설정한 옵션 이름(여행자에게 노출되는 이름)>,
<option_code>: <채널에서 설정한 옵션 이름(여행자에게 노출되는 이름)>,
<option_code>: <채널에서 설정한 옵션 이름(여행자에게 노출되는 이름)>,
...
}