> 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/store-front-api-reference/order-api/promotion-gift-event.md).

# Promotion Gift Event

## Check Whether Gift Event Is Applicable

> \## Function Description\
> \* Checks whether the selected gift event is actually usable.\
> \---\
> \## Detailed Description\
> \* \*\*This is a member-only API; non-members cannot use it.\*\*\
> \* Checks whether the selected gift event actually meets its application conditions.\
> \* Checks whether the amount after applying benefits to the currently purchased products meets the amount condition of the selected gift event.\
> \---\
> \## Notes\
> \### Related API List\
> \* Item detail lookup:\
> \<a target="\_blank"\
> &#x20;   href="<https://beta-venus-api-goods.x2bee.com/api/goods/swagger-ui/index.html#/상품상세> 관리/seltOrderItmInfo">\
> /api/goods/v1/detail/goods\
> \</a>\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.06\_231218\`\`\` : Fixed duplicate gift event lookup<br>

````json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/orderAeEvtList":{"post":{"tags":["Promotion Gift Event"],"summary":"Check Whether Gift Event Is Applicable","description":"## Function Description\n* Checks whether the selected gift event is actually usable.\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* Checks whether the selected gift event actually meets its application conditions.\n* Checks whether the amount after applying benefits to the currently purchased products meets the amount condition of the selected gift event.\n---\n## Notes\n### Related API List\n* Item detail lookup:\n<a target=\"_blank\"\n    href=\"https://beta-venus-api-goods.x2bee.com/api/goods/swagger-ui/index.html#/상품상세 관리/seltOrderItmInfo\">\n/api/goods/v1/detail/goods\n</a>\n---\n## Revision History\n* ```Release v1.06_231218``` : Fixed duplicate gift event lookup\n","operationId":"getOrderAeEvtList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAeEvtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AeResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderAeEvtRequest":{"required":["ordMediaCd"],"type":"object","properties":{"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"Reference Date/Time","format":"date-time"},"goodsInfo":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/OrderAeGoodsRequest"}}},"description":"Select Gift Event Request"},"OrderAeGoodsRequest":{"required":["goodsNo","itmNo","salePrc"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"salePrc":{"type":"integer","description":"Selling Price (1st Discount)","format":"int64"},"cnt":{"type":"integer","description":"Quantity","format":"int32"},"aeNo":{"type":"string","description":"Gift Promotion No."},"aeGoodsNo":{"type":"string","description":"Gift No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."}},"description":"Product List"},"AeResponse":{"type":"object","properties":{"aeEvtList":{"type":"array","description":"List of Available Gift Events","items":{"$ref":"#/components/schemas/AeEvtInfo"}}}},"AeEvtInfo":{"required":["addEvtTypCd","aeDesc","aeEndDtm","aeGoodsList","aeNm","aeNo","aeStrDtm","goodsNo","itmNo","tmEvtYn"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"aeNo":{"type":"string","description":"Gift Promotion No."},"addEvtTypCd":{"type":"string","description":"Gift Event Type Code (MK012)\n 10 : Purchase Amount Gift\n , 20 : Product Gift\n","enum":["10","20"]},"aeStrDtm":{"type":"string","description":"Gift Event Start Date/Time","format":"date-time"},"aeEndDtm":{"type":"string","description":"Gift Event End Date/Time","format":"date-time"},"payStrDt":{"type":"string","description":"Payment Start Date"},"payEndDt":{"type":"string","description":"Payment End Date"},"tmEvtYn":{"type":"string","description":"Time Event Status","nullable":true},"aplyStrTm":{"type":"string","description":"Application Start Time","nullable":true},"aplyEndTm":{"type":"string","description":"Application End Time","nullable":true},"aeDesc":{"type":"string","description":"Gift Promotion Description"},"aeNm":{"type":"string","description":"Gift Event Name"},"aeGoodsList":{"type":"array","description":"Free Gift List","items":{"$ref":"#/components/schemas/AeFvrInfo"}}},"description":"Gift Promotion Information","nullable":true},"AeFvrInfo":{"required":["aeFvrSeq","aeGoodsNm","aeGoodsNo","aplyMaxAmt","aplyMinAmt"],"type":"object","properties":{"aeFvrSeq":{"type":"string","description":"Gift Event Sequence No."},"aplyMinAmt":{"type":"integer","description":"Minimum Applicable Amount","format":"int64"},"aplyMaxAmt":{"type":"integer","description":"Maximum Applicable Amount","format":"int64"},"aeGoodsNm":{"type":"string","description":"Gift Product Name"},"aeGoodsNo":{"type":"string","description":"Gift Product No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."},"aeGoodsImgPath":{"type":"string","description":"Gift Image Path"}},"description":"Free Gift List"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
````

## Order Form Gift Promotion Retrieval

> \## Function Description\
> \* Looks up the gift events selectable for the current order.\
> \---\
> \## Detailed Description\
> \* \*\*This is a member-only API; non-members cannot use it.\*\*\
> \* If \*\*the same gift event is applicable to multiple products, it is applied to only one product\*\*.\
> \* The criteria for selecting the product are as follows.\
> &#x20; \* Sale price: descending\
> &#x20; \* Product No.: ascending\
> &#x20; \* Item No.: ascending<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/chooseAeEvtList":{"post":{"tags":["Promotion Gift Event"],"summary":"Order Form Gift Promotion Retrieval","description":"## Function Description\n* Looks up the gift events selectable for the current order.\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* If **the same gift event is applicable to multiple products, it is applied to only one product**.\n* The criteria for selecting the product are as follows.\n  * Sale price: descending\n  * Product No.: ascending\n  * Item No.: ascending\n","operationId":"getAeEvtList_1","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAeEvtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AeResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderAeEvtRequest":{"required":["ordMediaCd"],"type":"object","properties":{"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"Reference Date/Time","format":"date-time"},"goodsInfo":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/OrderAeGoodsRequest"}}},"description":"Select Gift Event Request"},"OrderAeGoodsRequest":{"required":["goodsNo","itmNo","salePrc"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"salePrc":{"type":"integer","description":"Selling Price (1st Discount)","format":"int64"},"cnt":{"type":"integer","description":"Quantity","format":"int32"},"aeNo":{"type":"string","description":"Gift Promotion No."},"aeGoodsNo":{"type":"string","description":"Gift No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."}},"description":"Product List"},"AeResponse":{"type":"object","properties":{"aeEvtList":{"type":"array","description":"List of Available Gift Events","items":{"$ref":"#/components/schemas/AeEvtInfo"}}}},"AeEvtInfo":{"required":["addEvtTypCd","aeDesc","aeEndDtm","aeGoodsList","aeNm","aeNo","aeStrDtm","goodsNo","itmNo","tmEvtYn"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"aeNo":{"type":"string","description":"Gift Promotion No."},"addEvtTypCd":{"type":"string","description":"Gift Event Type Code (MK012)\n 10 : Purchase Amount Gift\n , 20 : Product Gift\n","enum":["10","20"]},"aeStrDtm":{"type":"string","description":"Gift Event Start Date/Time","format":"date-time"},"aeEndDtm":{"type":"string","description":"Gift Event End Date/Time","format":"date-time"},"payStrDt":{"type":"string","description":"Payment Start Date"},"payEndDt":{"type":"string","description":"Payment End Date"},"tmEvtYn":{"type":"string","description":"Time Event Status","nullable":true},"aplyStrTm":{"type":"string","description":"Application Start Time","nullable":true},"aplyEndTm":{"type":"string","description":"Application End Time","nullable":true},"aeDesc":{"type":"string","description":"Gift Promotion Description"},"aeNm":{"type":"string","description":"Gift Event Name"},"aeGoodsList":{"type":"array","description":"Free Gift List","items":{"$ref":"#/components/schemas/AeFvrInfo"}}},"description":"Gift Promotion Information","nullable":true},"AeFvrInfo":{"required":["aeFvrSeq","aeGoodsNm","aeGoodsNo","aplyMaxAmt","aplyMinAmt"],"type":"object","properties":{"aeFvrSeq":{"type":"string","description":"Gift Event Sequence No."},"aplyMinAmt":{"type":"integer","description":"Minimum Applicable Amount","format":"int64"},"aplyMaxAmt":{"type":"integer","description":"Maximum Applicable Amount","format":"int64"},"aeGoodsNm":{"type":"string","description":"Gift Product Name"},"aeGoodsNo":{"type":"string","description":"Gift Product No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."},"aeGoodsImgPath":{"type":"string","description":"Gift Image Path"}},"description":"Free Gift List"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Look Up Gift Events for Product Detail

> \## Function Description\
> \* Looks up the list of gift events usable in the product detail page.\
> \---\
> \## Detailed Description\
> \* \*\*This is a member-only API; non-members cannot use it.\*\*\
> \* Looks up gift event information selectable for the product.\
> \* Among selectable gift events, only those whose gift meets the following conditions are looked up.\
> &#x20; \* Stock: exists\
> &#x20; \* Gift status: for sale\
> &#x20; \* Delivery type: combined shipping<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/aeEvtList":{"post":{"tags":["Promotion Gift Event"],"summary":"Look Up Gift Events for Product Detail","description":"## Function Description\n* Looks up the list of gift events usable in the product detail page.\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* Looks up gift event information selectable for the product.\n* Among selectable gift events, only those whose gift meets the following conditions are looked up.\n  * Stock: exists\n  * Gift status: for sale\n  * Delivery type: combined shipping\n","operationId":"getAeEvtList_2","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAeEvtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AeEvtInfo"}}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderAeEvtRequest":{"required":["ordMediaCd"],"type":"object","properties":{"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"Reference Date/Time","format":"date-time"},"goodsInfo":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/OrderAeGoodsRequest"}}},"description":"Select Gift Event Request"},"OrderAeGoodsRequest":{"required":["goodsNo","itmNo","salePrc"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"salePrc":{"type":"integer","description":"Selling Price (1st Discount)","format":"int64"},"cnt":{"type":"integer","description":"Quantity","format":"int32"},"aeNo":{"type":"string","description":"Gift Promotion No."},"aeGoodsNo":{"type":"string","description":"Gift No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."}},"description":"Product List"},"AeEvtInfo":{"required":["addEvtTypCd","aeDesc","aeEndDtm","aeGoodsList","aeNm","aeNo","aeStrDtm","goodsNo","itmNo","tmEvtYn"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"aeNo":{"type":"string","description":"Gift Promotion No."},"addEvtTypCd":{"type":"string","description":"Gift Event Type Code (MK012)\n 10 : Purchase Amount Gift\n , 20 : Product Gift\n","enum":["10","20"]},"aeStrDtm":{"type":"string","description":"Gift Event Start Date/Time","format":"date-time"},"aeEndDtm":{"type":"string","description":"Gift Event End Date/Time","format":"date-time"},"payStrDt":{"type":"string","description":"Payment Start Date"},"payEndDt":{"type":"string","description":"Payment End Date"},"tmEvtYn":{"type":"string","description":"Time Event Status","nullable":true},"aplyStrTm":{"type":"string","description":"Application Start Time","nullable":true},"aplyEndTm":{"type":"string","description":"Application End Time","nullable":true},"aeDesc":{"type":"string","description":"Gift Promotion Description"},"aeNm":{"type":"string","description":"Gift Event Name"},"aeGoodsList":{"type":"array","description":"Free Gift List","items":{"$ref":"#/components/schemas/AeFvrInfo"}}},"description":"Gift Promotion Information","nullable":true},"AeFvrInfo":{"required":["aeFvrSeq","aeGoodsNm","aeGoodsNo","aplyMaxAmt","aplyMinAmt"],"type":"object","properties":{"aeFvrSeq":{"type":"string","description":"Gift Event Sequence No."},"aplyMinAmt":{"type":"integer","description":"Minimum Applicable Amount","format":"int64"},"aplyMaxAmt":{"type":"integer","description":"Maximum Applicable Amount","format":"int64"},"aeGoodsNm":{"type":"string","description":"Gift Product Name"},"aeGoodsNo":{"type":"string","description":"Gift Product No."},"aeGoodsItmNo":{"type":"string","description":"Free Gift Item No."},"aeGoodsImgPath":{"type":"string","description":"Gift Image Path"}},"description":"Free Gift List"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```