취소 처리

PATCH https://api.imweb.me/v2/shop/orders/{주문번호}/cancel/{상태}

처리가능 상태 설명

주문관리 v2는 취소 승인만 지원합니다.

항목	설명
reject	취소거절 취소요청건을 거절하고 발송처리 합니다.
accept	취소승인 취소요청건에 대해 환불처리를 진행합니다. 주의: 자동환불이 불가능한 주문건은 '자동환불불가' 오류가 발생합니다.
retry	자동환불 재시도 자동환불 가능(카드결제 전체취소) 취소승인을 하였으나 PG사 장애 등의 이유로 취소처리중이 되었을 때 자동 환불을 다시 시도하는 기능입니다.
force_cancel	강제 취소(환불)완료 처리 강제 취소(환불)완료 처리시 PG사를 거치지 않고 취소완료 상태로 변경되므로 실제 고객에겐 자동으로 환불되지 않습니다. 무통장입금, 가상계좌 등 자동환불이 지원되지 않는 결제수단에만 사용을 권장하며, 신용카드 주문 등에 이 작업 수행시 PG사 상점관리자나 별도 환불수단으로 고객에게 환불해 주셔야 합니다.

요청 데이터

항목	타입	설명
prod_order_no	String	개별/부분 처리 시 사용(선택)
etc	Array	상태별 필수 데이터 reject: OrderCancelRejectData accept: OrderCancelAcceptData 처리 상태에 맞는 추가 데이터를 전달해주세요.
prod_order_no_list	Array	변경할 품목주문번호 리스트 (주문관리 v2전용, 취소 승인만 사용 가능)
order_version	String	조회할 주문 버전 (취소 승인만 사용 가능) v1 (기존 주문) v2 (신규 주문 시스템)

응답 데이터

항목	타입	설명
success	Array	처리 성공한 주문서 번호
failed	Array	처리 실패한 주문서 목록 OrderActionFailedList

OrderCancelReject Data

항목	타입	설명
parcel_code	String	택배사 코드 사용가능한 택배사 목록 보기
invoice_no	String	운송장번호

OrderCancelAccept Data

항목	타입	설명
etc_price	Array	기타 청구비용 목록 주의: 미입력 시 기타 비용 처리가 이루어지지 않습니다. EtcPriceData
refund_point	Array	환불 적립금 전체 취소인 경우 사용한 적립금 전액이 자동 반영됩니다. 부분취소는 환불하실 포인트를 직접 입력하실 수 있습니다. 예: 3000 포인트를 환불하고 싶을 때 -> 3000 입력 (단, 해당 주문의 잔여 적립금보다 초과하여 입력 불가) 주의: 미입력 시 적립금 환불 처리가 이루어지지 않습니다. RefundPointData
claim_memo	String	구매자에게 전하실 말씀

EtcPrice Data

항목	타입	설명
prod_order_no	String	품목주문번호
price	Float	기타 청구 비용

RefundPoint Data

항목	타입	설명
prod_order_no	String	품목주문번호
price	Float	환불 적립금

OrderActionFailedList Data

항목	타입	설명
order_no	String	주문번호
prod_order_list	Array	처리 실패한 품목 주문서 목록 OrderActionFailedProdOrderList Data

OrderActionFailedProdOrderList Data

항목	타입	설명
prod_order_no	String	품목주문번호
msg	String	실패 메세지
detail_msg	String	실패 상세메세지