콜백
1. 주문/배송 상태 변경 콜백
카카오모빌리티가 파트너사로 보내는 콜백으로 주문과 배송 상태 변경 정보를 파트너사에 전달합니다. 콜백은 다음 정보를 포함합니다.
- 주문 아이디
- 주문 상태(Event)
이후 호스팅사가 카카오에 응답하는 🔗HTTP 상태 코드를 확인하여 주문 또는 배송 상태 변경을 마무리합니다. 콜백 URL은 🔗시작하기 전에 단계에서 설정한 호스트 URL를 사용합니다.
Request 호출 방식
| Method | URL |
|---|---|
PUT | {호스트 URL}/api/v1/callback/orders/{partnerOrderId}/{event} |
Path Parameter
| Name | Type | Description | Required |
|---|---|---|---|
partnerOrderId | String | 연동사 주문 아이디 | 필수 |
event | String | 주문 상태다음 중 하나:matched : 배송원 배정 완료canceled : 배송 취소pickupCompleted : 배송원 픽업 완료dropoffCompleted : 배송원 배송 완료completed : 배송 완료matchingFailed : 배송원 배정 실패aborted : 관리자 강제 종료rematching : 배송원 재배정 | 필수 |
Body
| Name | Type | Description | Required |
|---|---|---|---|
pickerId | String | 배송원 아이디경로 파라미터 event 값이 다음 중 하나일 때 전달됨matched : 배송원 배정 완료pickupCompleted : 배송원 픽업 완료completed : 배송 완료 | 선택 |
reason | String | 주문 취소 이유로 경로 파라미터 event가 canceled일 때 전달됨 | 선택 |
cancelBy | String | 주문 취소 이유로 경로 파라미터 event가 canceled일 때 전달됨다음 중 하나:admin : 관리자에 의한 주문 취소picker : 배송원에 의한 주문 취소user : 사용자에 의한 주문 취소 | 선택 |
cancelFee | Int | 취소 수수료로 경로 파라미터 event가 canceled일 때 전달됨: 배송원이 픽업 위치로 출발한 경우, 배송 요금의 15%: 배송원이 목적지로 배송 출발한 경우, 배송 요금의 100% | 선택 |
imageUrl | string | 사진 | 선택 |
encodedStepId | string | 스텝 아이디 | 선택 |
2. 스텝 상태 변경 콜백
주문 내 특정 스텝의 상태 변경을 파트너사로 전달합니다.
Request 호출 방식
| Method | URL |
|---|---|
PUT | /api/v1/callback/orders/{orderId}/steps/{stepId} |
Path Parameter
| Name | Type | Description | Required |
|---|---|---|---|
orderId | String | 주문 아이디 | 필수 |
stepId | String | 스텝 아이디 | 필수 |
Body
| Name | Type | Description | Required |
|---|---|---|---|
event | String | 스텝 상태다음 중 하나:pickupStarted : 픽업 출발pickupCompleted : 픽업 완료dropoffStarted : 배송 출발dropoffCompleted : 배송 완료 | 필수 |
statusUpdatedAt | DateTime | 스텝 상태 변경 시각 | 필수 |