쿠폰

1. 선착순 쿠폰 생성 API

엔드포인트

• POST /api/admin/coupon

설명

• 관리자가 새로운 선착순 쿠폰을 생성합니다.

• 발급 한도와 다운로드 시작 시간 필수.

필드 설명

키	타입	설명
couponName	String	쿠폰 이름.
couponType	String	쿠폰 유형: FirstCome (선착순 쿠폰).
discountPrice	Long	할인 금액(정액 할인).
discountType	String	할인 유형: FIXED(정액), PERCENT(정률).
minOrderPrice	Long	최소 주문 금액 조건.
maximumDiscount	Long	최대 할인 금액 (정률 할인인 경우만 사용).
maxIssuance	Long	발급 한도(선착순에서 필수).
expiredDate	String	쿠폰 만료 기한(ISO-8601 형식).
downloadStartDate	String	다운로드 시작 시간(ISO-8601 형식).
couponDescription	String	쿠폰 설명.

요청 바디

{ 
  "couponName": "Black Friday Discount", //쿠폰명
  "couponType": "FirstCome", //쿠폰타입(선착순)
  "discountPrice": 5000, //할인금액
  "discountType": "FIXED", //할인타입(정액)
  "minOrderPrice": 20000, //최소 주문금액
  "maxIssuance": 100, //발급한도
  "expiredDate": "2024-12-31T23:59:59", //만료기한
  "downloadStartDate": "2024-11-30T00:00:00", //쿠폰 다운로드 시작일
  "couponDescription": "선착순 100명 대상 특별 할인" //쿠폰 설명
}

응답 바디

• 응답 코드: 201 Created

{
  "couponId": 1, //생성된 쿠폰의 고유 ID.
  "couponName": "Black Friday Discount",
  "couponType": "FirstCome",
  "discountPrice": 5000,
  "discountType": "FIXED",
  "minOrderPrice": 20000,
  "maximumDiscount": null,
  "maxIssuance": 100,
  "expiredDate": "2024-12-31T23:59:59",
  "downloadStartDate": "2024-11-30T00:00:00",
  "couponStatus": "PENDING",
  "couponDescription": "선착순 100명 대상 특별 할인"
}

---

2. 일반 쿠폰 생성 API

엔드포인트

• POST /api/admin/coupon

설명

• 관리자가 새로운 일반 쿠폰을 생성합니다.

• 발급 한도와 다운로드 시작 시간 없음.

요청 바디

{
  "couponName": "Welcome Discount",
  "couponType": "Regula",
  "discountPrice": 10000,
  "discountType": "FIXED",
  "minOrderPrice": 50000,
  "expiredDate": "2025-01-01T23:59:59",
  "couponDescription": "새로운 고객을 위한 특별 할인"
}

필드 설명

키	타입	설명
couponName	String	쿠폰 이름.
couponType	String	쿠폰 유형: Regula (일반 쿠폰).
discountPrice	Long	할인 금액(정액 할인).
discountType	String	할인 유형: FIXED(정액), PERCENT(정률).
minOrderPrice	Long	최소 주문 금액 조건.
maximumDiscount	Long	최대 할인 금액 (정률 할인인 경우만 사용).
expiredDate	String	쿠폰 만료 기한(ISO-8601 형식).
couponDescription	String	쿠폰 설명.

응답 바디

• 응답 코드: 201 Created

{
  "couponId": 2,
  "couponName": "Welcome Discount",
  "couponType": "Regula",
  "discountPrice": 10000,
  "discountType": "FIXED", //할인 타입
  "minOrderPrice": 50000,
  "maximumDiscount": null, //최대 할인 금액
  "maxIssuance": null, //발급한도
  "expiredDate": "2025-01-01T23:59:59",
  "downloadStartDate": null, //다운로드 시작일
  "couponStatus": "PENDING", 
  "couponDescription": "새로운 고객을 위한 특별 할인"
}

---

요약

• 엔드포인트:

  • POST /api/admin/coupon

• 차이점:

  • 선착순 쿠폰은 maxIssuance와 downloadStartDate 필수.

  • 일반 쿠폰은 maxIssuance와 downloadStartDate가 없음.

  • discountType(힐인타입)을 PERCENT(정률)만 maximumDiscount(최대할인 금액)입력 가능

• 공통 필드:

  • couponName, couponType, discountPrice, discountType, minOrderPrice, expiredDate, couponDescription.

  ENUM값	유형
  couponType
  (쿠폰 유형)	Regula (일반 쿠폰)/ FirstCome (선착순 쿠폰)
  couponStatus
  (쿠폰 상태)	PENDING(대기- 관리자 목록에서만 보이고 사용자는 안보임)/ ACTIVE(활성화- 관리자목록에서 볼 수 있고 사용자 화면에 보임/ EARLY_TERMINATED(조기종료- 관리자 목록에서 볼 수 있고 사용자 화면에 안보임)/
  discountType
  (할인타입)	FIXED(정액)/ PERCENT(정률).

---

3. 활성 쿠폰 목록 조회 API

엔드포인트:

• GET /api/admin/coupon

• 설명: 만료되지 않은 활성 쿠폰 목록을 반환합니다.

  • CouponStatus가 EXPIRED가 아닌 쿠폰만 포함됩니다.

  • 정렬: 기본적으로 만료 기한(expiredDate) 오름차순.

요청

• 요청 파라미터: 없음

응답 바디 예시

[
  {
    "couponId": 1,
    "couponName": "Black Friday Discount",
    "couponType": "FirstCome",
    "discountPrice": 5000,
    "discountType": "FIXED",
    "minOrderPrice": 20000,
    "maximumDiscount": 10000,
    "maxIssuance": 100,
    "expiredDate": "2024-12-31T23:59:59",
    "downloadStartDate": "2024-11-30T00:00:00",
    "couponStatus": "ACTIVE",
    "couponDescription": "선착순 100명 대상 특별 할인"
  },
  {
    "couponId": 2,
    "couponName": "Welcome Discount",
    "couponType": "Regula",
    "discountPrice": 10000,
    "discountType": "FIXED",
    "minOrderPrice": 50000,
    "maximumDiscount": null,
    "maxIssuance": null,
    "expiredDate": "2025-01-01T23:59:59",
    "downloadStartDate": null,
    "couponStatus": "PENDING",
    "couponDescription": "새로운 고객을 위한 특별 할인"
  }
]

---

4. 관리자 쿠폰 상태 변경 API

엔드포인트

• PUT /api/admin/coupon/{couponId}

2. 설명

• 기능: 특정 관리자가 생성한 쿠폰의 상태를 변경합니다.

• 주요 사용 시나리오:

  • 쿠폰을 활성화(ACTIVE)하거나 조기 종료(EARLY_TERMINATED) 또는 만료(EXPIRED) 상태로 변경.

3. 요청

요청 Path Parameter

파라미터	타입	필수 여부	설명
couponId	Long	필수	상태를 변경할 쿠폰의 고유 ID.

요청 Body

{
  "couponStatus": "ACTIVE"
}

요청 Body 필드 설명

필드명	타입	필수 여부	설명
couponStatus	String	필수	변경할 쿠폰 상태: PENDING, ACTIVE, EARLY_TERMINATED,

---

4. 응답

응답 Body

{
  "couponId": 1,
  "couponName": "Black Friday Discount",
  "couponType": "FirstCome",
  "discountPrice": 5000,
  "discountType": "FIXED",
  "minOrderPrice": 20000,
  "maximumDiscount": 10000,
  "maxIssuance": 100,
  "expiredDate": "2024-12-31T23:59:59",
  "downloadStartDate": "2024-11-30T00:00:00",
  "couponStatus": "ACTIVE",
  "couponDescription": "선착순 100명 대상 특별 할인"
}