주문 취소하기
진행 중인 주문을 취소합니다. 주문 아이디를 포함하여 취소 요청을 보내면 취소 성공 또는 실패 여부를 상태 코드로 받아볼 수 있습니다.
해당 API를 사용하려면 Vendor ID와 API 키값이 필요합니다.
발급 방법은 시작하기의 Vendor ID 및 API 키 발급받기를 참고하세요.
Request
요청 호출 방식과 각 요청 헤더에 포함될 내용에 안내합니다. 요청이 실패할 경우 🔗문제 해결하기에서 에러에 대한 상세 내용을 확인하세요.
호출 방식
| Method | URL |
|---|---|
PATCH | https://open-api-logistics.kakaomobility.com/goa-sandbox -service/api/v1/orders/{partnerOrderId}/cancel |
요청 헤더
| Parameter | Description |
|---|---|
| Authorization | 시작하기에서 생성한 Authorization 파라미터 값 |
| vendor | kakaoT 퀵∙도보 배송 API Sandbox에서 발급받은 Vendor 아이디 |
| Content-Type | application/json |
요청 코드 예제
curl -X 'PATCH' \
'https://open-api-logistics.kakaomobility.com/goa-sandbox-service/api/v1/orders/${partnerOrderId}/cancel'
-H 'accept: application/json' \
-H 'vendor: ${vendor_id}' \
-H 'Authorization: XXX' \
요청에 대한 파라미터는 다음과 같습니다.
| Name | Type | Description | Required |
|---|---|---|---|
partnerOrderId | String | 연동사 주문 아이디 | 필수 |
Response
응답 성공 시 요청에 대한 성공 여부를 HTTP 상태 코드로 전달합니다. 응답에 대한 HTTP 상태 코드를 확인하려면 HTTP 상태 코드를 참고하세요.