콜백

1. 주문/배송 상태 변경 콜백

카카오모빌리티가 파트너사로 보내는 콜백으로 주문과 배송 상태 변경 정보를 파트너사에 전달합니다. 콜백은 다음 정보를 포함합니다.

  • 주문 아이디
  • 주문 상태(Event)

이후 호스팅사가 카카오에 응답하는 🔗HTTP 상태 코드를 확인하여 주문 또는 배송 상태 변경을 마무리합니다. 콜백 URL은 🔗시작하기 전에 단계에서 설정한 호스트 URL를 사용합니다.

Request 호출 방식

표 1 | 호출 방식
MethodURL
POST{호스트 URL}/callbacks/orders/{partnerOrderId}

Path Parameter

표 2 | PathParameter
NameTypeDescriptionRequired
partnerOrderIdString연동사 주문 아이디필수

Body

표 3 | Body
NameTypeDescriptionRequired
eventString주문 상태다음 중 하나:matched : 배송원 배정 완료canceled : 배송 취소pickup_started : 배송원 픽업지 이동 시작pickup_completed : 배송원 픽업 완료dropoff_started : 배송지 이동 시작dropoff_completed : 배송원 배송 완료completed : 배송 완료matching_failed : 배송원 배정 실패aborted : 관리자 강제 종료retry_matching : 배송원 재배정repaid : 재결제payment_canceled : 결제 취소claim_requested : 클레임 요청claim_canceled : 클레임 취소필수
statusUpdatedAtDateTime주문 상태 변경 시각필수
pickerIdString배송원 아이디event 값이 다음 중 하나일 때 전달됨matched : 배송원 배정 완료pickup_started : 배송원 픽업지 이동 시작pickup_completed : 배송원 픽업 완료dropoff_started : 배송지 이동 시작dropoff_completed : 배송원 배송 완료completed : 배송 완료선택
reasonString주문 취소 이유로 event가 canceled일 때 전달됨선택
cancelByString주문 취소 주체로 event가 canceled일 때 전달됨다음 중 하나:admin : 관리자에 의한 주문 취소picker : 배송원에 의한 주문 취소user : 사용자에 의한 주문 취소선택
cancelFeeInteger취소 수수료로 event가 canceled일 때 전달됨
: 배송원이 픽업 위치로 출발한 경우,
배송 요금의 15%: 배송원이 목적지로 배송 출발한 경우,
배송 요금의 100%		선택
repaidAmountInteger재결제 금액으로 event가 repaid일 때 전달됨선택
canceledAmountInteger결제 취소 금액으로 event가 payment_canceled일 때 전달됨선택
imageUrlString배송 완료 사진 또는 서명 이미지 URL로 event가 completed일 때 전달됨선택
encodedStepIdString스텝 아이디로 경유지가 포함된 주문에서만 전달됨선택

2. 스텝 상태 변경 콜백

주문 내 특정 스텝의 상태 변경을 파트너사로 전달합니다. 경유지가 포함된 주문에서만 발송됩니다.

Request 호출 방식

표 4 | 호출 방식
MethodURL
POST{호스트 URL}/callbacks/orders/{orderId}/steps/{stepId}

Path Parameter

표 5 | Path Parameter
NameTypeDescriptionRequired
orderIdString주문 아이디필수
stepIdString스텝 아이디필수

Body

표 6 | Body
NameTypeDescriptionRequired
eventString스텝 상태다음 중 하나:pickup_started : 픽업 출발pickup_completed : 픽업 완료dropoff_started : 배송 출발dropoff_completed : 배송 완료필수
statusUpdatedAtDateTime스텝 상태 변경 시각필수