판매자 사은품 행사를 등록하거나, 기존 사은품 행사를 수정할 때 사용합니다.
1. 판매자 사은품 단건 조회
요청
POST /v1/gift/special-gifts?id={id}
<요청 파라미터 설명>
| 필드명 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| id | Long | 필수 | 사은품 행사 아이디 |
응답
<응답 바디>
| 필드명 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| specialGiftResponse | SpecialGiftResponse | 필수 | 사은품 행사 정보 |
2. 판매자 사은품 다건 조회
요청
GET /v1/gift/special-gifts/list
<요청 파라미터 설명>
| 필드명 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| displayStatus | SpecialGiftDisplayStatus | X | 전시 상태 필터 (WAIT/OPEN/CLOSED) |
| cursor | Long | X |
커서 값 (다음 페이지 조회 기준)
|
| size | Intger | X | 조회 개수 (default: 10) |
응답
<응답 바디>
| 필드명 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| contents | List<SpecialGiftResponse > | 필수 | 조회 결과 목록 |
| nextCursor | Long | 필수 | 다음 조회를 위한 커서 값 * 다음 페이지 조회 시, 본 값(nextCursor)을 요청 파라미터 cursor에 전달하여 호출해주세요. |
| hasNext | boolean | 필수 | 다음 페이지 존재 여부 |
3. 판매자 사은품 행사 조회 요청 시, 응답 바디 샘플
<응답 바디 샘플>
{
"contents": [
{
"specialGiftId": 1234,
"title": "OAPI 이미지 테스트",
"timePeriod": {
"from": "20251230180001"
},
"displayStatus": "OPEN",
"lastModifiedAt": "2025-12-30T16:11:28",
"lastModifiedBy": "오픈API/테스트셀러(143421)",
"createdAt": "2025-12-30T16:11:28",
"createdBy": "오픈API/테스트셀러(143421)"
},
{
"specialGiftId": 1235
"title": "OAPI 테스트 등록",
"timePeriod": {
"from": "20251229140000",
"to": "20251229230000"
},
"condition": "선착순 제공입니다.",
"displayStatus": "CLOSED",
"lastModifiedAt": "2025-12-29T10:02:58",
"lastModifiedBy": "오픈API/테스트셀러(143421)",
"createdAt": "2025-12-29T10:02:58",
"createdBy": "오픈API/테스트셀러(143421)"
}
],
"nextCursor": 1235,
"hasNext": true
}