> 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/api-en/back-office-api-reference/goods-bo-api/register-gift.md).

# Register Gift

## Register Gift

> \## Function Description\
> \* Registers gift information.\
> \---\
> \## Detailed Description\
> \* Registers gift information.\
> \* Sends an error message if not all required fields are entered.<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":"Register/Modify Free Gift Request","properties":{"prGoodsBase":{"$ref":"#/components/schemas/PrGoodsBase","description":"Gift Basic Information"},"prItmBase":{"$ref":"#/components/schemas/PrItmBase","description":"Gift SKU Information"},"giftImageInfo":{"$ref":"#/components/schemas/PrGoodsContInfo","description":"Gift Image Information"}}},"PrGoodsBase":{"type":"object","description":"Product Basic Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"modlNm":{"type":"string","description":"Model Name"},"homeNm":{"type":"string","description":"Country of Origin"},"mfcoNm":{"type":"string","description":"Manufacturer Name"},"incomNm":{"type":"string","description":"Importer Name"},"salemnNm":{"type":"string","description":"Seller Name"},"manufYm":{"type":"string","description":"Manufacture Year/Month"},"schKwdNm":{"type":"string","description":"Search Keyword"},"seoTitleNm":{"type":"string","description":"SEO Title"},"seoDesc":{"type":"string","description":"SEO Description"},"seoKwdNm":{"type":"string","description":"SEO Keywords"},"lgcGoodsNo":{"type":"string","description":"Internal Product No."},"entrNo":{"type":"string","description":"Vendor No."},"stdCtgNo":{"type":"string","description":"Standard Category No."},"goodsCompCd":{"type":"string","description":"Product Composition Code (PR001)"},"goodsTypCd":{"type":"string","description":"Product Type Code (PR002)"},"saleMethCd":{"type":"string","description":"Sales Method Code (PR003)"},"brandNo":{"type":"string","description":"Brand No."},"safeCertiTgtYn":{"type":"string","description":"Safety Certification Target Status"},"buyrAgeLmtCd":{"type":"string","description":"Purchaser Age Restriction Code (PR004)"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"aprvReqDt":{"type":"string","description":"Approval Request Date"},"saleStatChgCausCd":{"type":"string","description":"Sales Status Change Reason Code (PR058)"},"soutCausCd":{"type":"string","description":"Sold-Out Reason Code (PR032)"},"goodsRegDtm":{"type":"string","format":"date-time","description":"Product Registration Date/Time"},"saleStrDtm":{"type":"string","format":"date-time","description":"Sales Start Date/Time"},"saleEndDtm":{"type":"string","format":"date-time","description":"Sales End Date/Time"},"buyTypCd":{"type":"string","description":"Purchase Type Code (PR006)"},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"stkMgrYn":{"type":"string","description":"Inventory Management Status"},"buyQtyLmtYn":{"type":"string","description":"Purchase Quantity Limit Status"},"minLmtQty":{"type":"integer","format":"int32","description":"Minimum Limit Quantity"},"maxLmtQty":{"type":"integer","format":"int32","description":"Maximum Limit Quantity"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliDday":{"type":"integer","format":"int32","description":"Delivery Lead Time"},"itmSoutNotiYn":{"type":"string","description":"Item Sold-Out Alert Status"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"prcCompaExpYn":{"type":"string","description":"Price Comparison Exposure Status"},"pkgGoodsPrioRnkCd":{"type":"string","description":"Bundled Product Priority Code (PR035)"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"hsCd":{"type":"string","description":"hsCd"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"regInfPathCd":{"type":"string","description":"Registration Inflow Path Code (PR029)"},"aprvDt":{"type":"string","description":"Approval Date"},"retnCausCd":{"type":"string","description":"Rejection Reason Code (PR042)"},"retnCausCdNm":{"type":"string","description":"Rejection Reason Code Name (PR042)"},"retnCaus":{"type":"string","description":"Rejection Reason"},"retnDt":{"type":"string","description":"Rejection Date"},"schPsbYn":{"type":"string","description":"Searchable Status"},"optnYn":{"type":"string","description":"Option Management Status"},"optnCDYn":{"type":"string","description":"Option Add/Delete Status"},"goodsNoArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"szGdeUseYn":{"type":"string","description":"Size Guide Usage Status"},"szGdeRegMethodCd":{"type":"string","description":"Size Guide Registration Method Code (PR023)"},"szGdeCd":{"type":"string","description":"Size Guide Code (PR024)"},"szGdeConts":{"type":"string","description":"Size Guide Content"},"gftWthdYn":{"type":"string","description":"Collection Status"},"milgRsrvPsbYn":{"type":"string","description":"Mileage Accrual Availability Status"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"ecpnAplyTermGbCd":{"type":"string","description":"E-Coupon Application Period Classification Code (MK015)"},"ecpnIssuDdStdUseDds":{"type":"integer","format":"int32","description":"Usage Days Based on E-Coupon Issue Date"},"ecpnUsePsbStrDt":{"type":"string","format":"date","description":"E-Coupon Usage Start Date"},"ecpnUsePsbEndDt":{"type":"string","format":"date","description":"E-Coupon Usage End Date"}}},"PrItmBase":{"type":"object","description":"SKU Basic","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"optnCatNm1":{"type":"string","description":"Option Category Name_1"},"optnNm1":{"type":"string","description":"Option Name 1"},"optnCatNm2":{"type":"string","description":"Option Category Name_2"},"optnNm2":{"type":"string","description":"Option Name 2"},"optnCatNm3":{"type":"string","description":"Option Category Name_3"},"optnNm3":{"type":"string","description":"Option Name 3"},"optnCatNm4":{"type":"string","description":"Option Category Name_4"},"optnNm4":{"type":"string","description":"Option Name 4"},"optnCatNm5":{"type":"string","description":"Option Category Name_5"},"optnNm5":{"type":"string","description":"Option Name 5"},"lgcItmNo":{"type":"string","description":"Internal Item No."},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005) 01: Temporary Save, 02: Pending Approval, 03: Rejected, 10: On Sale, 20: Sold Out, 40: Discontinued"},"itmSaleStatCdNm":{"type":"string","description":"Unit Sales Status Code Name"},"saleStatChgCausCd":{"type":"string","description":"Sales Status Change Reason Code (PR058) 41: Sales Ended (Normal) 42: Sales Ended (Deleted)"},"repItmYn":{"type":"string","description":"Representative Item Status"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"addSupPcost":{"type":"number","description":"Additional Supply Cost"},"addSalePrc":{"type":"number","description":"Additional Sales Price"},"soutCausCd":{"type":"string","description":"Out-of-Stock Reason Code (PR032) 10: Automatic out-of-stock processing due to shipment unavailable, 11: Out-of-stock processing due to 0 stock quantity, 12: Manual out-of-stock processing by administrator, 13: Automatic out-of-stock processing due to next-day delivery delay, 14: Product out-of-stock processing due to all units out of stock, 15: Reserved product out-of-stock processing, 16: Out of stock due to bundle product out of stock"},"limtQty":{"type":"integer","format":"int32","description":"Reserved Limited Quantity"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"safeStkQty":{"type":"integer","format":"int32","description":"Safety Stock Quantity"},"optnCatNo1":{"type":"string","description":"Option Category No._1"},"optnNo1":{"type":"string","description":"Option No._1"},"optnCatNo2":{"type":"string","description":"Option Category No._2"},"optnNo2":{"type":"string","description":"Option No._2"},"optnCatNo3":{"type":"string","description":"Option Category No._3"},"optnNo3":{"type":"string","description":"Option No._3"},"optnCatNo4":{"type":"string","description":"Option Category No._4"},"optnNo4":{"type":"string","description":"Option No._4"},"optnCatNo5":{"type":"string","description":"Option Category No._5"},"optnNo5":{"type":"string","description":"Option No._5"},"giftRegistDefaultValue":{"type":"string","writeOnly":true},"addSupPcostByMargn":{"type":"number","writeOnly":true}}},"PrGoodsContInfo":{"type":"object","description":"Product Content Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"contTypCd":{"type":"string","description":"Content Type Code (PR017) 01: Detailed Description, 02: Video, 03: Product Image"},"contSn":{"type":"string","description":"Content Serial No."},"goodsDtlDesc":{"type":"string","description":"Product Detailed Description"},"imgGbCd":{"type":"string","description":"Image Type Code (PR031) P10: Basic Image, P20: Additional Image, M10: Video"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"contFilePathNm":{"type":"string","description":"Content File Path"},"contFileNm":{"type":"string","description":"Content File Name"},"trnfTextCont":{"type":"string","description":"Alt Text Content"},"useYn":{"type":"string","description":"Usage Status"},"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":["Register Gift"],"summary":"Register Gift","description":"## Function Description\n* Registers gift information.\n---\n## Detailed Description\n* Registers gift information.\n* Sends an error message if not all required fields are entered.\n","operationId":"registGiftGoods","parameters":[{"name":"request","in":"query","description":"Gift Information Request","schema":{"type":"GiftGoodsCUDRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftGoodsCUDRequest"}}},"required":true},"responses":{"200":{"description":"Gift registered successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Failed to register gift","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```