쿠폰 삭제 API
비볼디 쿠폰 삭제 API는 생성된 쿠폰을 영구적으로 삭제하는 기능을 제공합니다.
삭제된 쿠폰은 즉시 무효 처리되어 이후 사용 시도가 모두 차단됩니다.
여러 쿠폰을 한 번에 삭제하려면 대시보드를 이용하세요.
이 API는 퍼스널 요금제 이상에서만 사용할 수 있습니다.
DELETE
/api/coupon/v1/delete?cpnNo={cpnNo}
DELETE /api/coupon/v1/delete
?cpnNo=ZJLF0399WQBEQZJM
Request Parameters
- cpnNo string required
- 쿠폰 번호.
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- message string
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- result null
언제 이 API를 사용하나요?
다음과 같은 상황에서 사용합니다.
- 잘못 발급된 쿠폰을 즉시 차단해야 할 때
- 이벤트 종료 후 쿠폰을 정리할 때
- 중복 또는 테스트 쿠폰을 제거할 때
- 악용 가능성이 있는 쿠폰을 비활성화할 때
운영 환경에서는 단순 삭제가 아니라 리스크 차단 목적으로 자주 사용됩니다.
삭제와 만료의 차이
쿠폰을 더 이상 사용하지 못하게 막는 방법은 두 가지입니다.
endYmd(쿠폰 만료일)를 과거 날짜로 수정하면 쿠폰이 만료 상태가 되지만 데이터는 유지되며 이후 유효기간을 다시 연장할 수 있습니다.
반면 삭제 API를 호출하면 쿠폰 데이터가 영구적으로 제거되며 복구할 수 없습니다.
일시적으로 비활성화할 목적이라면 삭제 대신 수정 API로 유효기간을 조정하는 것을 권장합니다.
활용 예시
- 이벤트 종료 후 일괄 정리: 이벤트가 완전히 종료되어 더 이상 필요 없는 쿠폰을 일괄 삭제해 관리 목록을 정리
- 잘못 생성된 쿠폰 제거: 쿠폰번호 오타 또는 테스트 목적으로 생성했거나 설정 오류로 발급된 쿠폰을 즉시 삭제
- 유출된 쿠폰 차단: 쿠폰 번호가 외부에 유출된 경우 삭제 API를 호출해 즉시 사용을 차단
쿠폰이 삭제되어도 동일한 쿠폰 번호로 다시 생성하여 복구할 수 있습니다.
사용 시 주의사항
삭제는 취소할 수 없으므로 호출 전에 아래 사항을 반드시 확인하세요.
- 해당 쿠폰이 현재 진행 중인 캠페인에 사용되고 있지 않은지 확인합니다.
- 이미 사용자에게 발급된 쿠폰을 삭제하면 사용자가 해당 쿠폰을 사용하려 할 때 오류가 반환됩니다.
- 삭제 후 통계 데이터도 함께 제거될 수 있으므로, 클릭·사용 이력이 필요한 경우 삭제 전에 별도로 기록해 두세요.