퀵 배송, 도보 배송 등 배송 요청 시 출발지와 도착지의 상세 정보를 제공합니다. 주문 유형을 선택하고 배송 메시지를 전달할 수 있으며 선택한 서비스에 따라 세부 응답을 받아볼 수 있습니다.

<aside> 💡 퀵/도보배송 API를 사용하려면 Vendor ID와 API 키를 발급받아야 합니다. 발급에 관한 상세 정보는 [email protected]으로 문의해 주세요.

</aside>


Request

요청 호출 방식과 각 요청 헤더에 포함될 내용을 안내합니다. 요청이 실패할 경우 문제 해결하기에서 에러에 대한 상세 내용을 확인하세요.

호출 방식

표 1 | 호출 방식

Method URL
POST https://open-order.sandbox.onkakao.net/goa-open-service/api/v1/orders

요청 헤더

표 2 | 요청 헤더

Parameter Description
Authorization 시작하기에서 생성한 Authorization 파라미터값
vendor 발급받은 API 키
Content-Type application/json

요청 코드 예제

curl -X 'POST' \\
  '<https://open-order.sandbox.onkakao.net/goa-open-service/api/v1/orders>' \\
  -H 'accept: application/json' \\
  -H 'vendor: VZQZ2P' \\
  -H 'Content-Type: application/json' \\
  -d '{
  "orderType": "QUICK",
  "note": "",
  "productSize": "XS",
  "productDetail": "",
  "pickup": {
    "location": {
      "basicAddress": "서울특별시 강남구 역삼동 754",
      "detailAddress": "1층",
      "latitude": 37.498551,
      "longitude": 127.0464387
    },
    "contact": {
      "name": "전달하는 사람 이름",
      "phone": "010-1000-0001"
    }
  },
  "dropoff": {
    "location": {
      "basicAddress": "서울특별시 강남구 일원동 741",
      "detailAddress": "2층",
      "latitude": 37.490694420048,
      "longitude": 127.079607
    },
    "contact": {
      "name": "받는 사람 이름",
      "phone": "010-1000-0002"
    }
  }
}'

요청에 대한 파라미터는 다음과 같습니다.

표 3 | 요청 파라미터

Name Type Description Required
orderType String 주문 유형 필수
note String 배송원에게 전달할 메시지 선택
productSize String 배송 상품 크기 필수
productDetail String 배송 상품 상세 정보 선택
pickup Object 출발지 정보 필수
location Object 출발지 위치 정보 필수
basicAddress String 출발지 기본 주소 필수
detailAddress String 출발지 상세 주소 선택
latitude Double 출발지 위도 정보 필수
longitude Double 출발지 경도 정보 필수
contact Object 출발지 연락처 정보 필수
name String 출발지 이름 필수
phone String 출발지 전화번호 필수
dropoff Object 목적지 정보 필수
location Object 목적지 위치 정보 필수
basicAddress String 목적지 기본 주소 필수
detailAddress String 목적지 상세 주소 선택
latitude Double 목적지 위도 정보 필수
longitude Double 목적지 경도 정보 필수
contact Object 목적지 연락처 정보 필수
name String 목적지 이름 필수
phone String 목적지 전화번호 필수

Response