주문/배송 상태 변경하기

샌드박스 환경에서 주문과 배송 상태를 변경해 볼 수 있는 API입니다. 이 API를 활용하여 주문을 취소하거나 강제로 종료하는 등의 상태 변경을 테스트할 수 있습니다. 다양한 시나리오에 맞게 주문 상태를 변경해보면서 원하는 동작을 확인해보세요.

해당 API는 샌드박스 환경에서만 사용할 수 있습니다.
발급 방법은 시작하기의 Vendor ID 및 API 키 발급받기를 참고하세요.

Request

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

호출 방식

표 1 | 호출 방식
MethodURL
PATCHhttps://open-api-logistics.kakaomobility.com/goa-sandbox
-service/api/v1/developers/orders/{partnerOrderId}/status

요청 헤더

표 2 | 요청 헤더
ParameterDescription
Authorization시작하기에서 생성한 Authorization 파라미터 값
vendorkakaoT 퀵∙도보 배송 API Sandbox에서 발급받은 Vendor 아이디
Content-Typeapplication/json

요청 코드 예제

curl -X 'PATCH' \
  'https://open-api-logistics.kakaomobility.com/goa-sandbox-service/api/v1/developers/orders/${partnerOrderId}/status' \
  -H 'accept: application/json' \
  -H 'vendor: ${vendor_id}' \
  -H 'Authorization: XXX' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderStatus": "CANCEL",
    "cancelBy": "ADMIN"
  }'

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

표 3 | Path Parameter
NameTypeDescriptionRequired
partnerOrderIdString연동사 주문 아이디필수
표 4 | Body
NameTypeDescriptionRequired
orderStatusEnum
(String)		변경하려는 주문의 상태

다음 중 하나:
ABORT: 배송 강제 종료
MATCH_PICKER
: 배송원 배정 완료
CANCEL: 배송 취소
PICKUP_COMPLETED
: 배송원 픽업 완료
DROPOFF_COMPLETED
: 배송 완료		필수
cancelByEnum
(String)		주문 취소 주체

다음 중 하나:
PICKER
: 배송원에 의한 주문 취소
ADMIN
: 관리자에 의한 주문 취소		선택

Response

응답 성공 시 요청에 대한 성공 여부를 HTTP 상태 코드로 전달합니다. 응답에 대한 HTTP 상태 코드를 확인하려면 HTTP 상태 코드를 참고하세요.