콜백
주문/배송 상태 변경 콜백
카카오모빌리티가 파트너사로 보내는 콜백으로 주문과 배송 상태 변경 정보를 파트너사에 전달합니다. 콜백은 다음 정보를 포함합니다.
- 주문 아이디
- 주문 상태(Event)
이후 호스팅사가 카카오에 응답하는 🔗HTTP 상태 코드를 확인하여 주문 또는 배송 상태 변경을 마무리합니다. 콜백 URL은 🔗시작하기 전에단계에서 설정한 호스트 URL를 사용합니다.
Request
호출 방식
| Method | URL |
|---|---|
POST | {호스트 URL}/callbacks/orders/{partnerOrderId} |
Path Parameter
| Name | Type | Description | Required |
|---|---|---|---|
partnerOrderId | String | 연동사 주문 아이디 | 필수 |
Body
| Name | Type | Description | Required |
|---|---|---|---|
event | String | 주문 상태다음 중 하나:matched : 배송원 배정 완료canceled : 배송 취소pickup_completed : 배송원 픽업 완료completed : 배송 완료matching_failed : 배송원 배정 실패aborted : 관리자 강제 종료 | 필수 |
pickerId | String | 배송원 아이디event : 값이 다음 중 하나로 설정될 때 전달됨matched : 배송원 배정 완료pickup_completed : 배송원 픽업 완료completed : 배송 완료 | 선택 |
reason | String | 주문 취소 이유로 event 값이 canceled로 설정될 때 전달됨 | 선택 |
cancelBy | String | 주문 취소 이유로 event 값이 canceled로 설정될 때 전달됨다음 중 하나: admin : 관리자에 의한 주문 취소picker : 배송원에 의한 주문 취소user : 사용자에 의한 주문 취소 | 선택 |
cancelFee | Int | 취소 수수료로 event 값이 canceled로 설정될 때 전달됨 | 선택 |