실시간 정보 제공
특정 이벤트 발생시 고객사에서 인지 할 수 있도록 WebHook를 발송 합니다.
주의
웹훅은 실시간 데이터를 제공하지만, 통신 특성상 일부 휍훅이 누락될 가능성이 있습니다.
연계된 API와 함께 이용 하는 것을 추천 드립니다.
목차
1. WebHook 안내
웹훅은 HTTP Method POST방식으로 전송되며,
HTTP STATUS 2XX 수신을 받지 못한 경우 실패 처리되며 훅에 정상 코드 수신 시까지 설정된 재전송 주기, 재전송 최대 횟수만큼 반복 전송 처리 됩니다.
1.1. 설정
* 웹훅 등록 : 현재 WebHook 등록 기능을 제공하고 있지 않아 수신이 필요한 경우 WebHook 종류, 수신URL, 채널ID, 담당자 ID 를 전달해 주시면 등록 처리 가능합니다.
1.2. 종류
Code | Name | 재전송 최대 횟수 | 재전송 주기 |
IN_PRODUCTION | 주문처리중(제작중) | 5 | 10분 |
SHIPPED | 발송완료 | 5 | 10분 |
IN_DELIVERY | 배송중 | 5 | 10분 |
DELIVERY_COMPLETED | 배송완료 | 5 | 10분 |
2. WebHook 데이터 형식
2.1. 공통
Name | Type | |
hookId | Number | 훅번호 |
eventTime | DateTime | 이벤트 발생 시간
YYYY-MM-DD HH:MM:SS |
webHookType | Enum
(String) | Hook 종류
IN_PRODUCTION : 주문처리중(제작중)
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료
|
data | Object | 상세 데이터
|
{
"hookId":15,
"eventTime":"2024-03-14 16:10:48",
"webHookType":"IN_PRODUCTION",
"data":{
.
.
.
.
}
}
JSON
복사
2.2. 상세 데이터
2.2.1. 주문처리중(제작중) - IN_PRODUCTION
Name | Type | |
orderId | Number | 주문번호 |
orderCode | String | 주문번호(고객사 스토어) |
orderStatus | Enum
(String) | 주문상태
IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료
|
orderEntries | Array
(Object) | 주문 상품 상세 배열
* 주문 상품 상세 (entry) |
•
entry
Name | Type | |
orderEntryId | Number | 주문상세번호 |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
status | Enum
(String) | IN_PRODUCTION제작중
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
{
"hookId":15,
"eventTime":"2024-03-14 16:10:48",
"webHookType":"IN_PRODUCTION",
"data":{
"orderId":594,
"orderCode":"JbFGAceUdk",
"orderStatus":"IN_PRODUCTION",
"orderEntries":[
{
"orderEntryID":1487,
"projectId":7924,
"status":"IN_PRODUCTION"
},
{
"orderEntryID":1488,
"projectId":7925,
"status":"IN_PRODUCTION"
}
]
}
}
JSON
복사
2.2.2. 발송완료 - SHIPPED
Name | Type | |
orderId | Number | 주문번호 |
orderCode | String | 주문번호(고객사 스토어) |
orderStatus | Enum
(String) | 주문상태
IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료
|
orderEntries | Array
(Object) | 주문 상품 상세 배열
* 주문 상품 상세 (entry) |
•
entry
Name | Type | |
orderEntryId | Number | 주문상세번호 |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
status | Enum
(String) | IN_PRODUCTION제작중
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
consignmentList | Array
(Object) | 배송 정보 목록
* 배송정보(consignment) |
◦
consignment
Name | Type | |
shippingDate | DateTime | 발송일자 |
carrier | String | 배송사 |
shippingInvoice | String | 송장번호 |
trackingUrl | String | 배송추적 URL |
{
"hookId":17,
"eventTime":"2024-03-14 16:31:33",
"webHookType":"SHIPPED",
"data":{
"orderId":594,
"orderCode":"JbFGAceUdk",
"orderStatus":"SHIPPED",
"orderEntries":[
{
"orderEntryID":1488,
"projectId":7925,
"status":"SHIPPED",
"consignmentList":[
{
"carrier":"CJ",
"shippingInvoice":"123412341234",
"shippingDate":"2024-03-14 11:22:20",
"trackingUrl":"https://www.cjlogistics.com/ko/tool/parcel/newTracking?gnbInvcNo=123412341234"
},
{
"carrier":"CJ",
"shippingInvoice":"123412341234",
"shippingDate":"2024-03-14 11:22:20",
"trackingUrl":"https://www.cjlogistics.com/ko/tool/parcel/newTracking?gnbInvcNo=123412341234"
}
]
}
]
}
}
JSON
복사
2.2.3. 배송중 - IN_DELIVERY
Name | Type | |
orderId | Number | 주문번호 |
orderCode | String | 주문번호(고객사 스토어) |
orderStatus | Enum
(String) | 주문상태
IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료
|
orderEntries | Array
(Object) | 주문 상품 상세 배열
* 주문 상품 상세 (entry) |
•
entry
Name | Type | |
orderEntryId | Number | 주문상세번호 |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
status | Enum
(String) | IN_PRODUCTION제작중
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
{
"hookId":20,
"eventTime":"2024-03-14 16:36:34",
"webHookType":"IN_DELIVERY",
"data":{
"orderId":594,
"orderCode":"JbFGAceUdk",
"orderStatus":"IN_DELIVERY",
"orderEntries":[
{
"orderEntryID":1488,
"projectId":7925,
"status":"IN_DELIVERY"
}
]
}
}
JSON
복사
2.2.4. 배송완료 - DELIVERY_COMPLETED
Name | Type | |
orderId | Number | 주문번호 |
orderCode | String | 주문번호(고객사 스토어) |
orderStatus | Enum
(String) | 주문상태
IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료
|
orderEntries | Array
(Object) | 주문 상품 상세 배열
* 주문 상품 상세 (entry) |
•
entry
Name | Type | |
orderEntryId | Number | 주문상세번호 |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
status | Enum
(String) | IN_PRODUCTION제작중
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
{
"hookId":20,
"eventTime":"2024-03-14 16:36:34",
"webHookType":"DELIVERY_COMPLETED",
"data":{
"orderId":594,
"orderCode":"JbFGAceUdk",
"orderStatus":"DELIVERY_COMPLETED",
"orderEntries":[
{
"orderEntryID":1488,
"projectId":7925,
"status":"DELIVERY_COMPLETED"
}
]
}
}
JSON
복사
