기등록된 공지사항의 전시여부를 '전시종료' 상태로 변경할 때 사용합니다.
전시종료 처리 시, 해당 공지사항이 매핑된 상품에서 공지사항이 노출되지 않습니다.
요청
requestbody에 종료할 noticeId를 리스트로 보냅니다.
PUT v1/gift/notices/close
<요청 파라미터 설명>
타입
설명
Long
공지사항 ID 리...
더보기
판매자가 등록한 공지사항 전체를 조회할 수 있습니다.
등록한 판매자 공지사항 중, 전시여부 > 전시함, 전시대기 상태의 공지사항 목록만 조회할 수도 있습니다.
요청
GET v1/gift/notices/display-status
<요청 파라미터 설명>
필드명
타입
필수여부
설명
notClosed
Boolean
선택
전시여부가 '전시종료'...
더보기
파라미터를 입력하여 판매자 공지사항을 단건으로 조회할 수 있습니다.
상품 등록/수정 시, 매핑하고 싶은 특정 판매자 공지사항 ID를 확인할 수 있습니다.
요청
GET /v1/gift/notices?noticeId={noticeId}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
noticeId
Long
필수
조회할 noticeI...
더보기
판매자 상품의 새로운 공지사항을 등록하거나, 기존 공지사항을 수정할 때 사용합니다.
1. 판매자 공지사항 등록
요청
POST /v1/gift/notices
<요청 파라미터 설명>
필드명
타입
필수여부
설명
notice
NoticeView
필수
공지사항 정보
응답
<응답 바디>
필드명
타입
필수여부
설명
...
더보기
원산지 전체 목록을 조회합니다.원산지 level 정보는 0, 1, 2 까지이며 code 값으로 하위 관계가 표시됩니다.
요청
GET v1/gift/products/origin-areas
응답
전체 원산지 정보 목록를 반환합니다.
<응답 바디>
타입
필수여부
설명
Array<OriginArea>
필수
원산지 정보 목록
<...
더보기
해당 오픈 API 는 2023/8/8 부터 사용가능합니다.
판매상태별 상품정보를 조회할 때 사용합니다.
판매상태에 해당하는 상품목록을 조회할 수 있습니다.
요청
GET /v1/gift/products/sale-status/search?page={page}&size={size}&saleStatus={saleStatus}"
<요청 파라미터 설명>...
더보기
선물하기 상품 등록/수정 시 카테고리 속성정보가 광고심의서류 필수/선택 카테고리인 경우 광고심의서류 파일 업로드가 가능합니다.
선물하기 상품 등록 시 광고심의서류 필수 카테고리인 경우 해당 카테고리 등록가능한 광고심의서류 종류(건강기능식품, 의료기기, 기타)에 맞는 서류를 등록하지 않으면 상품을 등록할 수 없습니다.
상품의 서류 등록 시 카카오 서버...
더보기
광고심의서류 파일정보를 조회 할 때 사용합니다.
업로드 한 파일의 uuid 기준으로 조회 할 수 있습니다.
요청
POST /v1/gift/products/seller-files/search
<요청 파라미터 설명>
필드명
타입
필수여부
설명
uuids
string[]
필수
서류파일 uuid 배열
<요청 예시>
서류 ...
더보기
선물하기의 상품 등록이 가능한 최하위 카테고리 전체 목록을 조회합니다.
요청
상품 등록이 가능한 최하위(leaf) 카테고리 기준으로 조회합니다.
GET /v1/gift/products/categories
<요청 파라미터 설명>
필드명
타입
필수여부
설명
-
-
-
-
응답
요청이 성공하면, 응답 바디에 contents 하위에 카...
더보기
특정 카테고리 id(category_id)로 최하위(leaf) 카테고리를 조회합니다.category_id 파라미터가 없는 경우 조회가 되지 않습니다.조회시점에 존재하지 않거나 사용불가한 카테고리의 경우에는 category_not_found error 가 발생합니다.
요청
GET /v1/gift/products/categories/search?id=...
더보기
선물하기 카테고리 속성 정보 Excel file 다운로드
엑셀파일에서 카테고리 별 인증정보, 권한 필수여부, 부가정보, 광고심의서류 등록필수여부 확인이 가능합니다.
항목 설명
항목
설명
id
카테고리 ID
name
카테고리명
level
카테고리 level (1~4)
last_level
최종 카테고리인 경우 true
...
더보기
상품연동 시 브랜드 정보 전송을 위한 조회 api 입니다.브랜드명 혹은 브랜드 ID로 일치하는 브랜드가 있을 경우에만 조회 가능합니다.브랜드 검색 요청은 페이징을 지원하지 않습니다.
브랜드 단위로 계약한 판매자의 경우, 계약된 브랜드만 조회 결과에 노출됩니다.
요청
GET /v1/gift/brands/search?id={id}
GET /v1/gift/...
더보기
id , 검색어(query)로 모델을 조회 합니다.모델명에 특정 키워드가 포함되는 모델 정보를 조회할 수 있습니다.
참고사항기본조건인 모델명 일치 조건 modelNameMatch 가 true 인 경우 전체 모델명 일치하는 결과 있을 경우에만 성공으로 응답됩니다.modelNameMatch 가 false 인 경우 검색어 조회 결과 목록을 조회합니다. 하...
더보기
선물하기 상품 이미지 등록 시, 카카오 이미지 서버에 이미지 업로드 후 카카오에서 응답된 이미지 url을
입력하셔야 합니다. 상품에 필요한 이미지를 업로드 해주세요.
참고사항
1. imagetype : PRODUCT
상품 이미지(대표이미지, 추가이미지)는 TYPE: PRODUCT로 설정해 주세요. 대표이미지, 추가이미지 사이즈는 최소 550x550 ...
더보기
상품정보를 조회 할 때 사용합니다. 상품번호 또는 판매자 상품코드 기준으로 조회 할 수 있습니다.
요청
GET /v1/gift/products/search?id={id}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
sellerManagementCode
String
필수
판매자 상품코드
...
더보기
카테고리/모델명/브랜드검색/판매자주소록 조회, 이미지 업로드 API 등을 통해상품등록 API의 요청 데이터를 구성해야 합니다..
product option 파라미터에 들어가는 json object String 은 각 상품 옵션 유형별 샘플을 참고하세요.
요청
POST /v1/gift/products/register
<요청 파라미터 설명>
필...
더보기
선물하기 상품을 수정 할 수 있습니다.
상품 수정 요청시, 변경 대상이 아닌 항목까지 포함하여 모든 상품정보 항목을 입력해서 전달해야 합니다. 누락시 해당 상품정보에 이전에 입력된 값은 삭제되며, 필수 입력 항목인 경우에는 Validation 오류가 납니다.
상품 수정 API 사용 중에는 요청 데이터 타입 항목의 각 수정 시 주의사항 을 숙지하신 후 ...
더보기
상품 심사 요청을 취소 할 수 있습니다.상품 신규 등록 후 심사(승인)전에 상품정보를 수정하고자 할 경우에 사용 합니다.
참고사항
승인전 상품수정 프로세스최초 상품등록 후 상품번호는 생성되었지만, 승인완료 되지 않은 상품은 상품수정 API 호출 불가승인대기 상태에서는 상품수정이 불가하기때문에 ‘심사요청취소 API’ 호출해서 ‘신규상품 등록’ 상태로 ...
더보기
상품 심사 상태를 조회 할 수 있습니다.
# 선물하기는 상품 심사 승인 프로세스가 있기 때문에 상품 정보 변경 등의 프로세스 이전에 ‘승인여부’ 확인 및 ‘상태 조회’ 필수
# 승인 이후 상품 정보 수정 시 Patial API 활용 가능
# 상품 승인 상태 확인 이후 권장 프로세스
NEW_PRODUCT_REGISTERED : 신규상품 등...
더보기
상품 심사 승인 상태 변경이력을 조회 할수 있습니다.
# 최신 업데이트 상태부터 역순으로 전체 이력 응답
# 반려 상세 사유 확인 가능
요청
GET /v1/gift/products/approve/history?id={id}&page={page}&size={size}
<요청 파라미터 설명>
요청 필드
필드명
타입
필수여부
설명
id
...
더보기
상품 옵션을 조회 할 수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)옵션 조회 후 변경이 필요한 부분만 수정하여 보내주세요.
요청
GET /v1/gift/products/partial/option?id={id}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
응답
옵션 정...
더보기
특정 상품의 옵션 등록/수정 시에 사용합니다. (승인 완료 이후 상품만 Partial API 사용 가능)
옵션 등록/수정 시에는 본 상품이 이미 등록되어 있어야 하며, 본 상품을 찾을 수 없는 경우 에러가 발생됩니다.
옵션의 TYPE 필드는 필수 값이며, 옵션 없는 상품일 경우 “NONE” TYPE 으로 전송하시면 됩니다.옵션의 TYPE optionT...
더보기
상품 이미지를 조회 할 수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)이미지 조회 후 변경이 필요한 부분만 수정하여 보내주세요.
요청
GET /v1/gift/products/partial/image?id={id}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
응답
상품 ...
더보기
상품 이미지를 수정합니다. (승인 완료 이후 상품만 Partial API 사용 가능)
요청
PUT /v1/gift/products/partial/image/update
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
image
ProductImageView
필수
이미지
응답
수정이 실패한 경우...
더보기
상품 가격할인 정보를 조회 할수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)상품 가격할인 조회 후 변경이 필요한 부분만 수정하여 보내주세요.
요청
GET /v1/gift/products/partial/price?id={id}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
...
더보기
상품 가격/할인 정보를 수정 할 수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)
요청
PUT /v1/gift/products/partial/price/update
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
salePrice
BigDecimal
필수
판매 가격
disco...
더보기
상품 판매정보를 조회 할수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)
요청
GET /v1/gift/products/partial/sale?id={id}
<요청 파라미터 설명>
필드명
타입
필수여부
설명
id
Long
필수
상품 ID
응답
상품 판매정보를 조회합니다.
<응답 바디>
필드명
타입
설명...
더보기
상품 판매상태를 판매중 또는 판매중지 상태로 변경할 수 있습니다. (승인 완료 이후 상품만 Partial API 사용 가능)
주의사항
현재 상품의 상태가 판매대기 또는 판매중인 경우에만 판매중지 상태로 수정할 수 있습니다.판매중지 상태에서만 판매중 상태로 수정할 수 있습니다.
요청
PUT /v1/gift/products/partial/sale/up...
더보기