이 섹션의 문서

더보기

판매자 공지사항 등록 및 수정

판매자 상품의 새로운 공지사항을 등록하거나, 기존 공지사항을 수정할 때 사용합니다.

 

1. 판매자 공지사항 등록

요청

POST /v1/gift/notices

<요청 파라미터 설명>

필드명 타입 필수여부 설명
notice NoticeView 필수 공지사항 정보

응답

<응답 바디>

필드명

타입

필수여부

설명
notice NoticeView 필수 공지사항 정보

 

2. 판매자 공지사항 수정

요청

PUT /v1/gift/notices

<요청 파라미터 설명>

필드명 타입 필수여부 설명
notice NoticeView 필수

공지사항 정보

* noticeId 필수 포함

응답

<응답 바디>

필드명 타입 필수여부 설명
notice NoticeView 필수 공지사항 정보

 

3. 판매자 공지사항 등록/수정 요청 시, 응답바디 샘플 

1) 정상 응답

∙ 판매자 공지사항 유형이 Text인 경우 
{
"noticeId": 39770,
"wholeNotice": false,
"useDisplayPeriod": false,
"title": "[OAPI]연동테스트",
"content": "테스트",
"contentType": "TEXT",
"lastModifiedAt": "20250107133142",
"lastModifiedBy": "오픈API/에비리얼테스트(143421)",
"createdAt": "20250107133142",
"createdBy": "오픈API/에비리얼테스트(143421)",
"displayStatus": "DISPLAYING"
}
∙ 판매자 공지사항 유형이 Image인 경우 
{
"noticeId": 39772,
"wholeNotice": false,
"useDisplayPeriod": false,
"title": "[OAPI]이미지연동테스트",
"imageUrl": "https://st.kakaocdn.net/product/gift/notice/20241226181853_f80f4775e5064aa1ab28eff87c6e308f.jpeg",
"contentType": "IMAGE",
"lastModifiedAt": "20250107133333",
"lastModifiedBy": "오픈API/에비리얼테스트(143421)",
"createdAt": "20250107133333",
"createdBy": "오픈API/에비리얼테스트(143421)",
"displayStatus": "DISPLAYING"
}
 
2) 응답 : 제약사항 위반 
∙ 공지사항 등록 시, 등록한 이미지가 카카오 이미지 서버에 업로드된 URL이 아닌 경우 
{
"error_message": "유효하지 않은 요청입니다.",
"error_code": -10001,
"validation": {
"imageUrl": [
"유효하지 않은 이미지 URL입니다. 카카오 이미지 서버에 등록된 이미지 URL로 등록해 주세요."
  ]
 }
}
∙ 이미지 업로드 type이 notice가 아닌 경우 
{
"error_message": "유효하지 않은 요청입니다.",
"error_code": -10001,
"validation": {
"imageUrl": [
"올바르지 않은 이미지 등록 타입입니다. 이미지 등록 타입이 notice 인지 확인해 주세요."
  ]
 }
}
∙ 판매자 공지사항 수정 시, 공지사항 ID를 잘못 입력한 경우 
{
"error_message": "등록된 공지사항이 없습니다. 공지사항 ID 확인 후, 다시 시도해 주세요.",
"error_code": -12005
}

관련 문서