docs(gift): 선물 클라이언트 계약과 DDL을 갱신한다
This commit is contained in:
@@ -42,9 +42,9 @@ PRD에는 상세 API 계약, request/response 예시, 요구사항을 유지한
|
||||
| 사용자 | Method | URI | 역할 | Request | Response |
|
||||
|---|---:|---|---|---|---|
|
||||
| 관리자 | GET | `/api/v2/admin/gift-categories` | 선물 카테고리 목록을 조회한다. | 없음 | `AdminGiftCategoryResponse[]` |
|
||||
| 관리자 | POST | `/api/v2/admin/gift-categories` | 선물 카테고리를 등록한다. | body: `categoryCode`, `name`, `requiresDamageWaiver`, `isActive` | `categoryId`, `categoryCode`, `name`, `requiresDamageWaiver`, `isActive` |
|
||||
| 관리자 | PUT | `/api/v2/admin/gift-categories/{categoryId}` | 선물 카테고리를 수정한다. | path: `categoryId`, body: `categoryCode`, `name`, `requiresDamageWaiver`, `isActive` | `categoryId`, `categoryCode`, `name`, `requiresDamageWaiver`, `isActive` |
|
||||
| 관리자 | DELETE | `/api/v2/admin/gift-categories/{categoryId}` | 선물 카테고리를 비활성화한다. | path: `categoryId` | `categoryId`, `categoryCode`, `name`, `requiresDamageWaiver`, `isActive=false` |
|
||||
| 관리자 | POST | `/api/v2/admin/gift-categories` | 선물 카테고리를 등록한다. | body: `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive` | `categoryId`, `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive` |
|
||||
| 관리자 | PUT | `/api/v2/admin/gift-categories/{categoryId}` | 선물 카테고리를 수정한다. | path: `categoryId`, body: `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive` | `categoryId`, `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive` |
|
||||
| 관리자 | DELETE | `/api/v2/admin/gift-categories/{categoryId}` | 선물 카테고리를 비활성화한다. | path: `categoryId` | `categoryId`, `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive=false` |
|
||||
| 관리자 | GET | `/api/v2/admin/gift-size-prices` | 사이즈별 기본가와 판매가를 조회한다. | 없음 | `AdminGiftSizePriceResponse[]` |
|
||||
| 관리자 | PUT | `/api/v2/admin/gift-size-prices/{sizeCode}` | 사이즈별 기본가와 판매가를 수정한다. | path: `sizeCode`, body: `basePriceCan`, `salePriceCan`, `isActive` | `sizeCode`, `name`, `basePriceCan`, `salePriceCan`, `isActive` |
|
||||
| 관리자 | POST | `/api/v2/admin/gifts/{applicationNo}/arrive-mailbox` | 발송 확인 선물을 사서함 도착 처리한다. | path: `applicationNo` | `applicationNo`, `status`, `statusName`, `occurredAt` |
|
||||
@@ -54,13 +54,13 @@ PRD에는 상세 API 계약, request/response 예시, 요구사항을 유지한
|
||||
|
||||
관리자 응답 DTO 요약:
|
||||
|
||||
- `AdminGiftCategoryResponse`: `categoryId`, `categoryCode`, `name`, `requiresDamageWaiver`, `isActive`
|
||||
- `AdminGiftCategoryResponse`: `categoryId`, `classificationNumber`, `categoryCode`, `name`, `receiptCode`, `representativeItem`, `requiresDamageWaiver`, `isActive`
|
||||
- `AdminGiftSizePriceResponse`: `sizeCode`, `name`, `basePriceCan`, `salePriceCan`, `isActive`
|
||||
- `AdminGiftOperationStatusResponse`: `applicationNo`, `status`, `statusName`, `occurredAt`
|
||||
|
||||
## Kotlin DTO 형태
|
||||
|
||||
아래는 JSON으로 변환되기 직전의 API request/response `data class` 형태다. `companion object` 변환 함수는 클라이언트 입력/출력 형태와 직접 관련이 없어 생략했다.
|
||||
아래는 JSON으로 변환되기 직전의 API request/response `data class` 형태다. `companion object` 변환 함수는 클라이언트 입력/출력 형태와 직접 관련이 없어 생략했다. 응답 시각 필드는 UTC ISO 문자열이다. 예: `2026-09-30T12:00:00Z`.
|
||||
|
||||
### 사용자 Request DTO
|
||||
|
||||
@@ -122,6 +122,8 @@ data class GiftCategoryOptionResponse(
|
||||
val requiresDamageWaiver: Boolean
|
||||
)
|
||||
|
||||
// name은 사용자 폼 옵션에서만 "분류명/대표품목" 형태로 조합된다.
|
||||
|
||||
data class GiftListResponse(
|
||||
val totalCount: Long,
|
||||
val items: List<GiftListItemResponse>,
|
||||
@@ -138,7 +140,7 @@ data class GiftListItemResponse(
|
||||
val priceCan: Int,
|
||||
val categoryName: String,
|
||||
val sizeName: String,
|
||||
val createdAt: LocalDateTime?
|
||||
val createdAt: String?
|
||||
)
|
||||
|
||||
data class GiftDetailResponse(
|
||||
@@ -152,7 +154,7 @@ data class GiftDetailResponse(
|
||||
val mailbox: GiftMailboxResponse?,
|
||||
val trackingRequired: Boolean,
|
||||
val recipientAddressRequired: Boolean,
|
||||
val recipientAddressDeadlineAt: LocalDateTime?,
|
||||
val recipientAddressDeadlineAt: String?,
|
||||
val delivery: GiftDeliveryInfoResponse,
|
||||
val statusTimeline: List<GiftStatusTimelineResponse>
|
||||
)
|
||||
@@ -165,7 +167,7 @@ data class GiftDetailInfoResponse(
|
||||
val applicationNo: String?,
|
||||
val paidCan: Int?,
|
||||
val tracking: String?,
|
||||
val shippingRequestedAt: LocalDateTime?
|
||||
val shippingRequestedAt: String?
|
||||
)
|
||||
|
||||
data class GiftAddressResponse(
|
||||
@@ -181,15 +183,15 @@ data class GiftMailboxResponse(
|
||||
)
|
||||
|
||||
data class GiftDeliveryInfoResponse(
|
||||
val canceledAt: LocalDateTime?,
|
||||
val undeliverableAt: LocalDateTime?,
|
||||
val canceledAt: String?,
|
||||
val undeliverableAt: String?,
|
||||
val undeliverableReason: String?
|
||||
)
|
||||
|
||||
data class GiftStatusTimelineResponse(
|
||||
val status: String,
|
||||
val statusName: String,
|
||||
val occurredAt: LocalDateTime?
|
||||
val occurredAt: String?
|
||||
)
|
||||
|
||||
data class GiftApplicationResponse(
|
||||
@@ -197,7 +199,7 @@ data class GiftApplicationResponse(
|
||||
val status: String,
|
||||
val statusName: String,
|
||||
val priceCan: Int,
|
||||
val trackingDeadlineAt: LocalDateTime
|
||||
val trackingDeadlineAt: String
|
||||
)
|
||||
|
||||
data class GiftCancellationResponse(
|
||||
@@ -205,7 +207,7 @@ data class GiftCancellationResponse(
|
||||
val status: String,
|
||||
val statusName: String,
|
||||
val priceCan: Int,
|
||||
val canceledAt: LocalDateTime
|
||||
val canceledAt: String
|
||||
)
|
||||
|
||||
data class GiftTrackingRegistrationResponse(
|
||||
@@ -214,22 +216,22 @@ data class GiftTrackingRegistrationResponse(
|
||||
val statusName: String,
|
||||
val courierCompanyName: String,
|
||||
val trackingNumber: String,
|
||||
val trackingRegisteredAt: LocalDateTime,
|
||||
val recipientAddressDeadlineAt: LocalDateTime
|
||||
val trackingRegisteredAt: String,
|
||||
val recipientAddressDeadlineAt: String
|
||||
)
|
||||
|
||||
data class GiftRecipientAddressRegistrationResponse(
|
||||
val applicationNo: String,
|
||||
val status: String,
|
||||
val statusName: String,
|
||||
val recipientAddressRegisteredAt: LocalDateTime
|
||||
val recipientAddressRegisteredAt: String
|
||||
)
|
||||
|
||||
data class GiftDeliveryConfirmationResponse(
|
||||
val applicationNo: String,
|
||||
val status: String,
|
||||
val statusName: String,
|
||||
val deliveredAt: LocalDateTime
|
||||
val deliveredAt: String
|
||||
)
|
||||
|
||||
data class GiftReviewResponse(
|
||||
@@ -238,7 +240,7 @@ data class GiftReviewResponse(
|
||||
val rating: Int,
|
||||
val keywords: List<String>,
|
||||
val comment: String?,
|
||||
val createdAt: LocalDateTime?
|
||||
val createdAt: String?
|
||||
)
|
||||
```
|
||||
|
||||
@@ -246,8 +248,11 @@ data class GiftReviewResponse(
|
||||
|
||||
```kotlin
|
||||
data class AdminGiftCategoryRequest(
|
||||
val classificationNumber: String,
|
||||
val categoryCode: String,
|
||||
val name: String,
|
||||
val receiptCode: String,
|
||||
val representativeItem: String,
|
||||
val requiresDamageWaiver: Boolean,
|
||||
val isActive: Boolean
|
||||
)
|
||||
@@ -268,8 +273,11 @@ data class AdminGiftMarkUndeliverableRequest(
|
||||
```kotlin
|
||||
data class AdminGiftCategoryResponse(
|
||||
val categoryId: Long,
|
||||
val classificationNumber: String,
|
||||
val categoryCode: String,
|
||||
val name: String,
|
||||
val receiptCode: String,
|
||||
val representativeItem: String,
|
||||
val requiresDamageWaiver: Boolean,
|
||||
val isActive: Boolean
|
||||
)
|
||||
@@ -286,7 +294,7 @@ data class AdminGiftOperationStatusResponse(
|
||||
val applicationNo: String,
|
||||
val status: GiftStatus,
|
||||
val statusName: String,
|
||||
val occurredAt: LocalDateTime
|
||||
val occurredAt: String
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user