배송원 정보 조회하기
배송 중인 배송원의 위치와 연락처 정보를 제공합니다.
해당 API를 사용하려면 Vendor ID와 API 키값이 필요합니다.
발급 방법은 시작하기의 Vendor ID 및 API 키 발급받기를 참고하세요.
Request
요청 호출 방식과 각 요청 헤더에 포함될 내용에 안내합니다. 요청이 실패할 경우 🔗문제 해결하기에서 에러에 대한 상세 내용을 확인하세요.
호출 방식
| GET | URL |
|---|---|
GET | https://open-api-logistics.kakaomobility.com/ goa-sandbox-service/api/v2/orders/{partnerOrderId}/picker |
요청 헤더
| Parameter | Description |
|---|---|
| Authorization | 시작하기에서 생성한Authorization 파라미터 값 |
| vendor | kakaoT 퀵∙도보 배송 API Sandbox에서 발급받은 Vendor 아이디 |
| Content-Type | application/json |
요청 코드 예제
curl -X 'GET' \
'https://open-api-logistics.kakaomobility.com/goa-sandbox-service/api/v2/orders/${partnerOrderId}/picker'
-H 'accept: application/json' \
-H 'vendor: ${vendor_id}' \
-H 'Authorization: XXX' \
요청에 대한 파라미터는 다음과 같습니다.
| Name | Type | Description | Required |
|---|---|---|---|
partnerOrderId | String | 연동사 주문 아이디 | 필수 |
Response
응답 성공 시 요청에 대한 성공 여부를 HTTP 상태 코드로, 요청 본문은 JSON 포맷으로 전달합니다.
응답 코드 예제
{
"latitude": 37.4354059,
"longitude": 126.74551,
"name": "홍*동",
"phone": "010-1000-0001"
"plateNumber": "123가 4568"
"fleet": "DAMAS"
}요청 응답에 대한 객체 정보는 다음과 같습니다.
| Name | Type | Description | Required |
|---|---|---|---|
latitude | Double | 배송원 위치 위도 정보 | 선택 |
longitude | Double | 배송원 위치 경도 정보 | 선택 |
name | String | 배송원 이름 | 필수 |
phone | String | 배송원 전화번호 | 필수 |
plateNumber | String | 배송원 차량 번호 | 선택 |
fleet | String | 배송원 차량 정보 (배송 진행중 상태에서만 조회 가능) 다음 중 하나: MOTORCYCLE: 오토바이JIMBAJI_MOTORCYCLE: 짐받이 오토바이 PASSENGER_CAR: 승용차DAMAS: 다마스LABO: 라보TON: 1톤 | 선택 |