주문상태 변경 웹훅(콜백)
개요
웹훅 수신을 위한 준비
HTTP POST
HTTP POST 메소드와 Content-Type: application/json 을 수신, 처리할 수 있는 웹서버가 필요합니다.방화벽, WAF 설정 점검
3.35.115.107/32 주소에서 발송됩니다. 고객사 방화벽 보안정책을 통과할 수 있는지 사전에 점검해 주세요.도메인과 연결된 HTTPS 수신서버 권장
웹훅 공통
{
"orderId": 1312241,
"eventName": "additionalPrice",
"resource": {
"_id": "6459a246622344d31f84fdd8",
"customerOrderId": "0123-4567-8901",
"reason": "delay",
"amount": 3300,
"adminComment": "미배차할증"
}
}웹훅 공통
orderId, eventName, resource 필드로 구성되어 있으며 resource필드는 eventName에 따라 변동됩니다. eventName별 상세 resource 필드를 확인하려면 아래 resource schema를 참고해주세요.eventName
지원되는 웹훅 발송 이벤트
| eventName | 이벤트명(국문) |
|---|---|
| additionalPrice | 후청구금액 발생 |
| orderDispatched | 배차 완료 |
| orderReDispatched | 재배차 완료 |
| orderOngoing | 픽업완료 |
| orderOneCompleted | 주문 경유지 완료 |
| orderAllCompleted | 주문 전체 완료 |
| orderCanceled | 주문 취소 |
resource 상세
additionalPrice
예시
{
"_id": "67b6dc246a9117f665455f47",
"customerOrderId": "",
"reason": "delay",
"amount": 3300,
"adminComment": ""
}Schema
additionalPrice resource
orderDispatched
예시
{
"customerOrderId": "",
"matchedAt": "2025-01-03T00:00:00.000Z",
"riderName": "김디버",
"riderPhoneNumber": "01012345678"
}Schema
orderDispatched resource
orderReDispatched
예시
{
"customerOrderId": "",
"matchedAt": "2025-01-03T00:00:00.000Z",
"riderName": "김디버",
"riderPhoneNumber": "01012345678"
}Schema
orderReDispatched resource
orderOngoing
예시
{
"customerOrderId":"",
"pinCustomerManagedCode": "",
"imageUrl" : "https://cloudfront.net/2025/01/jajbbywlkz81ochj.png",
"pinCompletedAt" : "2025-01-11T04:37:12.595Z"
}Schema
orderOngoing resource
orderOneCompleted
예시
{
"customerOrderId": "",
"pinCustomerManagedCode": "",
"pinNum": 1,
"imageUrl": "https://cloudfront.net/2025/01/jajbbywlkz81ochj.png",
"pinCompletedAt": "2025-01-08T08:29:09.545Z"
}Schema
orderOneCompleted resource
orderAllCompleted
예시
{
"customerOrderId": "",
"completedAt": "2025-01-02T00:00:00.000Z"
}Schema
orderAllCompleted
orderCanceled
예시
{
"customerOrderId": "",
"cancellationFee": 0,
"canceledAt": "2025-01-03T00:00:00.000Z"
}Schema
orderCanceled