> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/goods-bo-api/undefined-6.md).

# 사은품 등록

## 사은품 등록

> \## 기능설명\
> \* 사은품 정보를 등록합니다.\
> \---\
> \## 상세설명\
> \* 사은품 정보를 등록합니다.\
> \* 필수값을 모두 입력하지 않은 경우 오류 메시지를 보냅니다.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GiftGoodsCUDRequest":{"type":"object","description":"사은품 등록/수정 Request","properties":{"prGoodsBase":{"$ref":"#/components/schemas/PrGoodsBase","description":"사은품 기본 정보"},"prItmBase":{"$ref":"#/components/schemas/PrItmBase","description":"사은품 단품 정보"},"giftImageInfo":{"$ref":"#/components/schemas/PrGoodsContInfo","description":"사은품 이미지 정보"}}},"PrGoodsBase":{"type":"object","description":"상품기본","properties":{"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"modlNm":{"type":"string","description":"모델명"},"homeNm":{"type":"string","description":"원산지명"},"mfcoNm":{"type":"string","description":"제조사명"},"incomNm":{"type":"string","description":"수입자명"},"salemnNm":{"type":"string","description":"판매자명"},"manufYm":{"type":"string","description":"제조년월"},"schKwdNm":{"type":"string","description":"검색키워드명"},"seoTitleNm":{"type":"string","description":"SEO 타이틀명"},"seoDesc":{"type":"string","description":"SEO 설명"},"seoKwdNm":{"type":"string","description":"SEO 키워드명"},"lgcGoodsNo":{"type":"string","description":"자체상품번호"},"entrNo":{"type":"string","description":"협력사번호"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"goodsCompCd":{"type":"string","description":"상품구성코드(PR001)"},"goodsTypCd":{"type":"string","description":"상품유형코드(PR002)"},"saleMethCd":{"type":"string","description":"판매방식코드(PR003)"},"brandNo":{"type":"string","description":"브랜드번호"},"safeCertiTgtYn":{"type":"string","description":"안전인증대상여부"},"buyrAgeLmtCd":{"type":"string","description":"구입자나이제한코드(PR004)"},"dispYn":{"type":"string","description":"전시여부"},"saleStatCd":{"type":"string","description":"판매상태코드(PR005)"},"aprvReqDt":{"type":"string","description":"승인요청일자"},"saleStatChgCausCd":{"type":"string","description":"판매상태변경사유코드(PR058)"},"soutCausCd":{"type":"string","description":"품절사유코드(PR032)"},"goodsRegDtm":{"type":"string","format":"date-time","description":"상품등록일시"},"saleStrDtm":{"type":"string","format":"date-time","description":"판매시작일시"},"saleEndDtm":{"type":"string","format":"date-time","description":"판매종료일시"},"buyTypCd":{"type":"string","description":"매입유형코드(PR006)"},"taxGbCd":{"type":"string","description":"과면세구분코드(PR007)"},"stkMgrYn":{"type":"string","description":"재고관리여부"},"buyQtyLmtYn":{"type":"string","description":"구매수량제한여부"},"minLmtQty":{"type":"integer","format":"int32","description":"최소제한수량"},"maxLmtQty":{"type":"integer","format":"int32","description":"최대제한수량"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliGoodsGbCd":{"type":"string","description":"배송상품구분코드(PR010)"},"deliWayCd":{"type":"string","description":"배송수단코드(PR009)"},"deliDday":{"type":"integer","format":"int32","description":"배송기일"},"itmSoutNotiYn":{"type":"string","description":"단품품절알림여부"},"deliPolcNo":{"type":"string","description":"배송정책번호"},"deliPsbRgnCd":{"type":"string","description":"배송가능지역코드"},"rtnPsbYn":{"type":"string","description":"반품가능여부"},"exchPsbYn":{"type":"string","description":"교환가능여부"},"prcCompaExpYn":{"type":"string","description":"가격비교노출여부"},"pkgGoodsPrioRnkCd":{"type":"string","description":"묶음상품우선순위코드(PR035)"},"bpckPsbYn":{"type":"string","description":"합포가능여부"},"hsCd":{"type":"string","description":"hsCd"},"safeStkNotiYn":{"type":"string","description":"안전재고알림여부"},"rglrDeliGoodsYn":{"type":"string","description":"정기배송상품여부"},"regInfPathCd":{"type":"string","description":"등록유입경로코드(PR029)"},"aprvDt":{"type":"string","description":"승인일자"},"retnCausCd":{"type":"string","description":"반려사유코드(PR042)"},"retnCausCdNm":{"type":"string","description":"반려사유코드명(PR042)"},"retnCaus":{"type":"string","description":"반려사유"},"retnDt":{"type":"string","description":"반려일자"},"schPsbYn":{"type":"string","description":"검색가능여부"},"optnYn":{"type":"string","description":"옵션관리여부"},"optnCDYn":{"type":"string","description":"옵션 추가/삭제 여부"},"goodsNoArray":{"type":"array","description":"상품번호배열","items":{"type":"string"}},"szGdeUseYn":{"type":"string","description":"사이즈가이드 사용여부"},"szGdeRegMethodCd":{"type":"string","description":"사이즈가이드 등록방법 코드(PR023)"},"szGdeCd":{"type":"string","description":"사이즈가이드코드(PR024)"},"szGdeConts":{"type":"string","description":"사이즈가이드 내용"},"gftWthdYn":{"type":"string","description":"회수 여부"},"milgRsrvPsbYn":{"type":"string","description":"마일리지적립가능여부"},"gvgfPsbYn":{"type":"string","description":"선물하기가능여부"},"frgnDirPurGoodsYn":{"type":"string","description":"해외직구상품여부"},"entrGoodsNo":{"type":"string","description":"협력사상품번호"},"ordCnclPsbYn":{"type":"string","description":"주문취소가능여부"},"wthdYn":{"type":"string","description":"회수여부"},"ecpnAplyTermGbCd":{"type":"string","description":"e-쿠폰적용기간구분코드(MK015)"},"ecpnIssuDdStdUseDds":{"type":"integer","format":"int32","description":"e-쿠폰발급일기준사용일수"},"ecpnUsePsbStrDt":{"type":"string","format":"date","description":"e-쿠폰사용가능시작일자"},"ecpnUsePsbEndDt":{"type":"string","format":"date","description":"e-쿠폰사용가능종료일자"}}},"PrItmBase":{"type":"object","description":"단품기본","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"optnCatNm1":{"type":"string","description":"옵션분류명_1"},"optnNm1":{"type":"string","description":"옵션명_1"},"optnCatNm2":{"type":"string","description":"옵션분류명_2"},"optnNm2":{"type":"string","description":"옵션명_2"},"optnCatNm3":{"type":"string","description":"옵션분류명_3"},"optnNm3":{"type":"string","description":"옵션명_3"},"optnCatNm4":{"type":"string","description":"옵션분류명_4"},"optnNm4":{"type":"string","description":"옵션명_4"},"optnCatNm5":{"type":"string","description":"옵션분류명_5"},"optnNm5":{"type":"string","description":"옵션명_5"},"lgcItmNo":{"type":"string","description":"자체단품번호"},"itmSaleStatCd":{"type":"string","description":"단품판매상태코드(PR005) 01:임시저장, 02:승인대기, 03:반려, 10:판매중, 20:품절, 40:판매종료"},"itmSaleStatCdNm":{"type":"string","description":"단품판매상태코드명"},"saleStatChgCausCd":{"type":"string","description":"판매상태변경사유코드(PR058) 41:판매종료(정상) 42:판매종료(삭제)"},"repItmYn":{"type":"string","description":"대표단품여부"},"dispSeq":{"type":"integer","format":"int32","description":"전시순서"},"addSupPcost":{"type":"number","description":"추가공급원가"},"addSalePrc":{"type":"number","description":"추가판매가"},"soutCausCd":{"type":"string","description":"품절사유코드(PR032) 10:발송불가 자동품절처리, 11:재고수량 0 품절처리, 12:관리자 수동품절처리, 13:익일배송지연 자동품절처리, 14:모든단품품절로 상품 품절처리, 15:예약상품 품절처리, 16:묶음상품 품절로 인한 품절"},"limtQty":{"type":"integer","format":"int32","description":"예약한정수량"},"stkQty":{"type":"integer","format":"int32","description":"재고수량"},"safeStkNotiYn":{"type":"string","description":"안전재고 알림여부"},"safeStkQty":{"type":"integer","format":"int32","description":"안전재고수량"},"optnCatNo1":{"type":"string","description":"옵션분류번호_1"},"optnNo1":{"type":"string","description":"옵션번호_1"},"optnCatNo2":{"type":"string","description":"옵션분류번호_2"},"optnNo2":{"type":"string","description":"옵션번호_2"},"optnCatNo3":{"type":"string","description":"옵션분류번호_3"},"optnNo3":{"type":"string","description":"옵션번호_3"},"optnCatNo4":{"type":"string","description":"옵션분류번호_4"},"optnNo4":{"type":"string","description":"옵션번호_4"},"optnCatNo5":{"type":"string","description":"옵션분류번호_5"},"optnNo5":{"type":"string","description":"옵션번호_5"},"giftRegistDefaultValue":{"type":"string","writeOnly":true},"addSupPcostByMargn":{"type":"number","writeOnly":true}}},"PrGoodsContInfo":{"type":"object","description":"상품컨텐츠정보","properties":{"goodsNo":{"type":"string","description":"상품번호"},"contTypCd":{"type":"string","description":"컨텐츠유형코드(PR017) 01:상세설명, 02:동영상, 03:상품이미지"},"contSn":{"type":"string","description":"컨텐츠일련번호"},"goodsDtlDesc":{"type":"string","description":"상품상세설명"},"imgGbCd":{"type":"string","description":"이미지구분코드(PR031) P10:기본이미지, P20:추가이미지, M10:동영상"},"dispSeq":{"type":"integer","format":"int32","description":"전시순서"},"contFilePathNm":{"type":"string","description":"컨텐츠파일경로명"},"contFileNm":{"type":"string","description":"컨텐츠파일명"},"trnfTextCont":{"type":"string","description":"대체텍스트내용"},"useYn":{"type":"string","description":"사용여부"},"packageSubImageRegistDefaultValue":{"type":"integer","format":"int32","writeOnly":true}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/goods/giftGoodsApi/registerGiftGoods":{"post":{"tags":["사은품 등록"],"summary":"사은품 등록","description":"## 기능설명\n* 사은품 정보를 등록합니다.\n---\n## 상세설명\n* 사은품 정보를 등록합니다.\n* 필수값을 모두 입력하지 않은 경우 오류 메시지를 보냅니다.\n","operationId":"registGiftGoods","parameters":[{"name":"request","in":"query","description":"사은품 정보 Request","schema":{"type":"GiftGoodsCUDRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftGoodsCUDRequest"}}},"required":true},"responses":{"200":{"description":"사은품 등록 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"사은품 등록 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
