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

<aside> 💡 * 해당 API는 샌드박스 환경에서만 사용할 수 있습니다.

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

</aside>

Request

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

호출 방식

표 1 | 호출 방식

요청 헤더

표 2 | 요청 헤더

요청 코드 예제

curl -X 'PATCH' \\
    '<https://open-order.sandbox.onkakao.net/goa-open-service/api/v1/developers/orders/b9f545df-1156-4ddb-a56a-81140a464dba/status>' \\
    -H 'accept: application/json' \\
    -H 'vendor: VZQZ2P' \\
    -H 'Content-Type: application/json' \\
    -d '{
      "orderStatus": "CANCEL",
      "cancelBy": "ADMIN"
    }'

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

표 3 | 요청 파라미터