> 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/order-form.md).
# Order Form
## Place Order
> \## Function Description\
> \- API for creating an order.\
> \---\
> \## Detailed Description\
> \- Approves the payment and creates the order. If the order succeeds, an order-completion notification message and email are sent to the orderer.\
> \---\
> \## Notes\
> \- Creates a non-member login-processing cookie upon successful non-member order.\
> \- If the isProcess value in the error response upon order failure is true, it is mainly a payment-related error; changing the payment method allows reordering with the same information. Redirect to the order form page.\
> \- If the isProcess value in the error response upon order failure is false, it is an error where ordering with the same information is not possible; redirect to the order failure page.\
> \- FO-only API that creates the order using the FO's login information.\
> \- Since login information is looked up internally within the API, the member number (mbrNo) is not required as a parameter.\
> \---\
> \## Revision History\
> \- release\_231009\_01: Internal improvements.\
> \- Release v2.00\_240401 : Added single-product status (snsGoodsYn) when looking up order detail product information\
> \- Release v2.00\_240401 : Added and changed values needed for the order-completion email\
> \- Release v2.00\_240509 : Removed nullable constraint on the request order promotion information value\
> \- Release v2.00\_240530 : Added and changed values needed for the order-completion email when ordered via subscription order\
> \- Release v2.00\_240530 : Added expected shipment completion datetime to order details for vendor evaluation purposes\
> \- Release v2.00\_240613 : Added Toss payment approval\
> \- Release v2.00\_240627 : Added Toss simple payment\
> \- Release v2.00\_240725 : For E-coupon products, applied shipment-completion processing instead of order-completion for the order history status\
> \- Release v2.00\_240808 : Added order-cancellation-allowed status and collection status columns to the order detail table for gift and gifting products\
> \- Release v2.00\_250717 : Added issuance of supporting documents (tax invoices)\
> \- Release v2.00\_250801 : Applied activation of supporting documents (tax invoices) based on configuration
```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/order":{"post":{"tags":["Order Form"],"summary":"Place Order","description":"## Function Description\n- API for creating an order.\n---\n## Detailed Description\n- Approves the payment and creates the order. If the order succeeds, an order-completion notification message and email are sent to the orderer.\n---\n## Notes\n- Creates a non-member login-processing cookie upon successful non-member order.\n- If the isProcess value in the error response upon order failure is true, it is mainly a payment-related error; changing the payment method allows reordering with the same information. Redirect to the order form page.\n- If the isProcess value in the error response upon order failure is false, it is an error where ordering with the same information is not possible; redirect to the order failure page.\n- FO-only API that creates the order using the FO's login information.\n- Since login information is looked up internally within the API, the member number (mbrNo) is not required as a parameter.\n---\n## Revision History\n- release_231009_01: Internal improvements.\n- Release v2.00_240401 : Added single-product status (snsGoodsYn) when looking up order detail product information\n- Release v2.00_240401 : Added and changed values needed for the order-completion email\n- Release v2.00_240509 : Removed nullable constraint on the request order promotion information value\n- Release v2.00_240530 : Added and changed values needed for the order-completion email when ordered via subscription order\n- Release v2.00_240530 : Added expected shipment completion datetime to order details for vendor evaluation purposes\n- Release v2.00_240613 : Added Toss payment approval\n- Release v2.00_240627 : Added Toss simple payment\n- Release v2.00_240725 : For E-coupon products, applied shipment-completion processing instead of order-completion for the order history status\n- Release v2.00_240808 : Added order-cancellation-allowed status and collection status columns to the order detail table for gift and gifting products\n- Release v2.00_250717 : Added issuance of supporting documents (tax invoices)\n- Release v2.00_250801 : Applied activation of supporting documents (tax invoices) based on configuration\n","operationId":"order","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Order Successful"},"900":{"description":"Business processing error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderRegisterRequest":{"required":["ordBaseInfo","ordDlvInfoList","ordGoodsInfoList"],"type":"object","properties":{"ordBaseInfo":{"$ref":"#/components/schemas/OrdBaseInfo"},"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"ordDlvInfoList":{"type":"array","description":"Order Delivery Information","items":{"$ref":"#/components/schemas/OrdDlvInfo"}},"ordBnfInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"accmInfo":{"$ref":"#/components/schemas/AccmResponse"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"proofDocInfo":{"$ref":"#/components/schemas/ProofDocInfo"}},"description":"Place Order Request"},"OrdBaseInfo":{"required":["giftCard","ordGbCd","ordMediaCd","ordNo","ordererInfo","siteNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"siteNo":{"type":"string","description":"Site No."},"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"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026). Required for Bank Transfer Payment","nullable":true},"rfdActnNo":{"type":"string","description":"Refund Account No. Required for Bank Transfer Payment","nullable":true},"rcdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name. Required for Bank Transfer Payment","nullable":true},"rglrDeliNo":{"type":"string","description":"Subscription Order No.","nullable":true},"chlNo":{"type":"string","description":"Channel No.","nullable":true},"chlDtlNo":{"type":"string","description":"Channel Detail No.","nullable":true},"ordererInfo":{"$ref":"#/components/schemas/OrdererInfo"},"giftCard":{"$ref":"#/components/schemas/GiftCard"},"ordGoodsGb":{"type":"string","description":"OM029 (Order Product Classification Code)\n 10: General Product\n , 20: e-Coupon\n","enum":["GENERAL_GOODS","E_COUPON"]}},"description":"Order Basic Information"},"OrdererInfo":{"required":["cellEndNo","cellSctNo","cellTxnoNo","mbrNo","ordManEmailAddr","ordManNm","umemPwd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Non-Member Orderer Name"},"umemPwd":{"type":"string","description":"Non-Member Order Password"},"ordManEmailAddr":{"type":"string","description":"Non-Member Email Address"},"cellSctNo":{"type":"string","description":"Non-Member Mobile Phone Prefix"},"cellTxnoNo":{"type":"string","description":"Non-Member Mobile Phone Middle Digits"},"cellEndNo":{"type":"string","description":"Non-Member Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Non-Member Phone Area Code"},"telTxnoNo":{"type":"string","description":"Non-Member Phone Exchange Code"},"telEndNo":{"type":"string","description":"Non-Member Phone Last Digits"},"ordLmtYn":{"type":"string","description":"Purchase Restriction Status"},"brth":{"type":"string","description":"Date of Birth"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)"},"stafYn":{"type":"string","description":"Employee Status"},"nonMemberAge":{"type":"integer","description":"Non-Member Age","format":"int32"},"nonMemberCertiYn":{"type":"string","description":"Non-Member Verification Status"}},"description":"Orderer Information"},"GiftCard":{"required":["prstTypCd"],"type":"object","properties":{"prstTypCd":{"type":"string","description":"Gift Type Code (OM045)"},"prstMsg":{"type":"string","description":"Gift Message"}},"description":"Gift Card. Required for Gift Orders","nullable":true},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"},"OrdDlvInfo":{"required":["dlvGrpInfoList","dlvpNm","dtlAddr","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"dlvpNm":{"type":"string","description":"Delivery Address Name. Required for General Orders"},"zipNo":{"type":"string","description":"Postal Code. Required for General Orders"},"zipAddr":{"type":"string","description":"Postal Address. Required for General Orders"},"dtlAddr":{"type":"string","description":"Detailed Address. Required for General Orders"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient Phone Last Digits"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other","nullable":true},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code","nullable":true},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No.","nullable":true},"dlvGrpInfoList":{"type":"array","description":"Delivery Group Information List","items":{"$ref":"#/components/schemas/DlvGrpInfo"}}},"description":"Delivery Address List"},"DlvGrpInfo":{"required":["basketGoodsList","deliKindCd","deliMethodCd","deliNo","deliProcTypCd","dlvAmtInfoList"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Combined Delivery No."},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"basketGoodsList":{"type":"array","description":"Cart Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"dlvAmtInfoList":{"type":"array","description":"Delivery Fee Information","items":{"$ref":"#/components/schemas/DlvAmtInfo"}}},"description":"Delivery Group Information DTO"},"DlvAmtInfo":{"required":["aplyAdtnAmt","deliPolcNo","dlexAmt","dlexTypCd","entrNo","ordCostGbCd","stdAdtnAmt"],"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvBenefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"Shipping Fee Info DTO"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"}},"description":"Shipping Benefit Info","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"goods":{"type":"array","description":"Product Information List","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"Order Promotion Information"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"}},"description":"Product Information List"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"Total Accrual Amount","format":"int64"},"accmList":{"type":"array","description":"Accrual Information List","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"Accrual Information","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"Asset Accrual/Usage Reason Code (ME020)\n 21 : Order Accrual\n , 22 : Member Grade Accrual\n , 23 : Reservation Product Accrual\n , 24 : Promotion Accrual\n , 50 : Order Usage\n , 58 : Delivery Fee Usage\n , 29 : Refund Accrual\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"Accrual Rate","format":"double"},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"},"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code"},"rsrvStdAmt":{"type":"integer","description":"Accrual Standard Amount","format":"int64"},"goodsAccmList":{"type":"array","description":"Product Accrual Information List","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"Accrual Information List"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"}},"description":"Product Accrual Information List"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ProofDocInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No. (System ID)"},"ordManNm":{"type":"string","description":"Orderer Name"},"proofType":{"type":"string","description":"Supporting Document Type"},"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"orderTaxInvoiceRequest":{"$ref":"#/components/schemas/TaxInvoice"},"orderCashReceiptRequest":{"$ref":"#/components/schemas/CashReceipt"}},"description":"Supporting Document Info","nullable":true},"TaxInvoice":{"type":"object","properties":{"entrNo":{"type":"string","description":"Company No."},"goodsNm":{"type":"string","description":"Product Name"},"goodsCount":{"type":"integer","description":"Product Count","format":"int32"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"bmanNo":{"type":"string","description":"Business Registration No."},"bmanNm":{"type":"string","description":"Business Name"},"rpstmnNm":{"type":"string","description":"Representative Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Phone Number"},"aempTelTxnoNo":{"type":"string","description":"Contact Phone Number"},"aempTelEndNo":{"type":"string","description":"Contact Phone Number"},"aempEmailId":{"type":"string","description":"Contact Email ID"},"aempEmailDomain":{"type":"string","description":"Contact Email Domain"},"aempEmail":{"type":"string","description":"Contact Email"},"validYn":{"type":"string","description":"Validity Status"}},"description":"Tax Invoice DTO"},"CashReceipt":{"type":"object","properties":{"prsntPurpsCd":{"type":"string","description":"Submission Purpose (OM010)"},"idefNo":{"type":"string","description":"Identification No."},"prchsrNm":{"type":"string","description":"Buyer Name"},"prchsrEmail":{"type":"string","description":"Buyer Email"},"prchsrCell":{"type":"string","description":"Buyer Mobile Phone"},"smsTrnsYn":{"type":"string","description":"SMS Sent Status"},"faxTrnsYn":{"type":"string","description":"FAX Sent Status"},"valiYn":{"type":"string","description":"Validity Status"}},"description":"Cash Receipt DTO"},"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"}}}}
```
## Calculate Actual Business Day
> \## Function Description\
> \- Receives a reference date and calculates and returns the actual business day.\
> \---\
> \## Detailed Description\
> \- Adds the input number of days based on the reference date.\
> \- If a holiday falls within the date calculation, that date is excluded from the sum.\
> \- When calculating the expected shipment completion datetime for an order product, it is calculated at the time the order is completed.\
> \- When calculating the expected shipment completion datetime for an order product, for general products it is based on the order time, and for reserved products it is based on the requested delivery datetime.\
> \- Calculates the automatic approval scheduled date and the explanation-registration-allowed date in the vendor evaluation dispute-raising process in BO.\
> \---\
> \## Revision History\
> \- Release v2.00\_240613: Added holiday business type code parameter, changed URL
```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/orderSheet/workingDay":{"post":{"tags":["Order Form"],"summary":"Calculate Actual Business Day","description":"## Function Description\n- Receives a reference date and calculates and returns the actual business day.\n---\n## Detailed Description\n- Adds the input number of days based on the reference date.\n- If a holiday falls within the date calculation, that date is excluded from the sum.\n- When calculating the expected shipment completion datetime for an order product, it is calculated at the time the order is completed.\n- When calculating the expected shipment completion datetime for an order product, for general products it is based on the order time, and for reserved products it is based on the requested delivery datetime.\n- Calculates the automatic approval scheduled date and the explanation-registration-allowed date in the vendor evaluation dispute-raising process in BO.\n---\n## Revision History\n- Release v2.00_240613: Added holiday business type code parameter, changed URL\n","operationId":"getWorkingDay","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkingDayRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string","format":"date-time"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"WorkingDayRequest":{"required":["dayCount","holiJobGbCd","standardDtm"],"type":"object","properties":{"standardDtm":{"type":"string","description":"Reference Date","format":"date-time"},"dayCount":{"type":"integer","description":"Number of Days","format":"int64"},"holiJobGbCd":{"type":"string","description":"Holiday Business Classification Code (CM001)"}},"description":"Actual Business Date DTO"},"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"}}}}
```
## Validate Order Form Entry
> \## Function Description\
> \- Performs user validation upon entering the order form.\
> \---\
> \## Detailed Description\
> Validates the following information upon entering the order form.\
> \- Whether required order form request information exists\
> \- Non-member authentication status\
> \- Orderer's age\
> \- Whether the user is a member, for gifting orders\
> \---\
> \## Revision History\
> \* release\_231023 : For gifting orders, verifies whether the user is a member
```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/orderSheet/validateOrderSheet":{"post":{"tags":["Order Form"],"summary":"Validate Order Form Entry","description":"## Function Description\n- Performs user validation upon entering the order form.\n---\n## Detailed Description\nValidates the following information upon entering the order form.\n- Whether required order form request information exists\n- Non-member authentication status\n- Orderer's age\n- Whether the user is a member, for gifting orders\n---\n## Revision History\n* release_231023 : For gifting orders, verifies whether the user is a member\n","operationId":"validateOrderSheet","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSheetValidateRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSheetValidateRequest":{"required":["bsketNoList","deliMethodCd","ordGbCd","ordMediaCd"],"type":"object","properties":{"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"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"]},"bsketNoList":{"type":"array","description":"Cart No.","items":{"type":"integer","description":"Cart No.","format":"int64"}}},"description":"Order Form Entry Validation Request DTO"},"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 Tax-exempt Payment Amount
> \## Function Description\
> \- Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.\
> \---\
> \### Detailed Description\
> \- Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.\
> \- Sums the amount of tax-exempt products using the payment allocation process.
```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/orderSheet/taxFreeAmount":{"post":{"tags":["Order Form"],"summary":"Look Up Tax-exempt Payment Amount","description":"## Function Description\n- Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.\n---\n### Detailed Description\n- Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.\n- Sums the amount of tax-exempt products using the payment allocation process.\n","operationId":"taxFreeAmount","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderRegisterRequest":{"required":["ordBaseInfo","ordDlvInfoList","ordGoodsInfoList"],"type":"object","properties":{"ordBaseInfo":{"$ref":"#/components/schemas/OrdBaseInfo"},"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"ordDlvInfoList":{"type":"array","description":"Order Delivery Information","items":{"$ref":"#/components/schemas/OrdDlvInfo"}},"ordBnfInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"accmInfo":{"$ref":"#/components/schemas/AccmResponse"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"proofDocInfo":{"$ref":"#/components/schemas/ProofDocInfo"}},"description":"Place Order Request"},"OrdBaseInfo":{"required":["giftCard","ordGbCd","ordMediaCd","ordNo","ordererInfo","siteNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"siteNo":{"type":"string","description":"Site No."},"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"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026). Required for Bank Transfer Payment","nullable":true},"rfdActnNo":{"type":"string","description":"Refund Account No. Required for Bank Transfer Payment","nullable":true},"rcdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name. Required for Bank Transfer Payment","nullable":true},"rglrDeliNo":{"type":"string","description":"Subscription Order No.","nullable":true},"chlNo":{"type":"string","description":"Channel No.","nullable":true},"chlDtlNo":{"type":"string","description":"Channel Detail No.","nullable":true},"ordererInfo":{"$ref":"#/components/schemas/OrdererInfo"},"giftCard":{"$ref":"#/components/schemas/GiftCard"},"ordGoodsGb":{"type":"string","description":"OM029 (Order Product Classification Code)\n 10: General Product\n , 20: e-Coupon\n","enum":["GENERAL_GOODS","E_COUPON"]}},"description":"Order Basic Information"},"OrdererInfo":{"required":["cellEndNo","cellSctNo","cellTxnoNo","mbrNo","ordManEmailAddr","ordManNm","umemPwd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Non-Member Orderer Name"},"umemPwd":{"type":"string","description":"Non-Member Order Password"},"ordManEmailAddr":{"type":"string","description":"Non-Member Email Address"},"cellSctNo":{"type":"string","description":"Non-Member Mobile Phone Prefix"},"cellTxnoNo":{"type":"string","description":"Non-Member Mobile Phone Middle Digits"},"cellEndNo":{"type":"string","description":"Non-Member Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Non-Member Phone Area Code"},"telTxnoNo":{"type":"string","description":"Non-Member Phone Exchange Code"},"telEndNo":{"type":"string","description":"Non-Member Phone Last Digits"},"ordLmtYn":{"type":"string","description":"Purchase Restriction Status"},"brth":{"type":"string","description":"Date of Birth"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)"},"stafYn":{"type":"string","description":"Employee Status"},"nonMemberAge":{"type":"integer","description":"Non-Member Age","format":"int32"},"nonMemberCertiYn":{"type":"string","description":"Non-Member Verification Status"}},"description":"Orderer Information"},"GiftCard":{"required":["prstTypCd"],"type":"object","properties":{"prstTypCd":{"type":"string","description":"Gift Type Code (OM045)"},"prstMsg":{"type":"string","description":"Gift Message"}},"description":"Gift Card. Required for Gift Orders","nullable":true},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"},"OrdDlvInfo":{"required":["dlvGrpInfoList","dlvpNm","dtlAddr","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"dlvpNm":{"type":"string","description":"Delivery Address Name. Required for General Orders"},"zipNo":{"type":"string","description":"Postal Code. Required for General Orders"},"zipAddr":{"type":"string","description":"Postal Address. Required for General Orders"},"dtlAddr":{"type":"string","description":"Detailed Address. Required for General Orders"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient Phone Last Digits"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other","nullable":true},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code","nullable":true},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No.","nullable":true},"dlvGrpInfoList":{"type":"array","description":"Delivery Group Information List","items":{"$ref":"#/components/schemas/DlvGrpInfo"}}},"description":"Delivery Address List"},"DlvGrpInfo":{"required":["basketGoodsList","deliKindCd","deliMethodCd","deliNo","deliProcTypCd","dlvAmtInfoList"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Combined Delivery No."},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"basketGoodsList":{"type":"array","description":"Cart Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"dlvAmtInfoList":{"type":"array","description":"Delivery Fee Information","items":{"$ref":"#/components/schemas/DlvAmtInfo"}}},"description":"Delivery Group Information DTO"},"DlvAmtInfo":{"required":["aplyAdtnAmt","deliPolcNo","dlexAmt","dlexTypCd","entrNo","ordCostGbCd","stdAdtnAmt"],"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvBenefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"Shipping Fee Info DTO"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"}},"description":"Shipping Benefit Info","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"goods":{"type":"array","description":"Product Information List","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"Order Promotion Information"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"}},"description":"Product Information List"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"Total Accrual Amount","format":"int64"},"accmList":{"type":"array","description":"Accrual Information List","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"Accrual Information","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"Asset Accrual/Usage Reason Code (ME020)\n 21 : Order Accrual\n , 22 : Member Grade Accrual\n , 23 : Reservation Product Accrual\n , 24 : Promotion Accrual\n , 50 : Order Usage\n , 58 : Delivery Fee Usage\n , 29 : Refund Accrual\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"Accrual Rate","format":"double"},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"},"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code"},"rsrvStdAmt":{"type":"integer","description":"Accrual Standard Amount","format":"int64"},"goodsAccmList":{"type":"array","description":"Product Accrual Information List","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"Accrual Information List"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"}},"description":"Product Accrual Information List"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ProofDocInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No. (System ID)"},"ordManNm":{"type":"string","description":"Orderer Name"},"proofType":{"type":"string","description":"Supporting Document Type"},"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"orderTaxInvoiceRequest":{"$ref":"#/components/schemas/TaxInvoice"},"orderCashReceiptRequest":{"$ref":"#/components/schemas/CashReceipt"}},"description":"Supporting Document Info","nullable":true},"TaxInvoice":{"type":"object","properties":{"entrNo":{"type":"string","description":"Company No."},"goodsNm":{"type":"string","description":"Product Name"},"goodsCount":{"type":"integer","description":"Product Count","format":"int32"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"bmanNo":{"type":"string","description":"Business Registration No."},"bmanNm":{"type":"string","description":"Business Name"},"rpstmnNm":{"type":"string","description":"Representative Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Phone Number"},"aempTelTxnoNo":{"type":"string","description":"Contact Phone Number"},"aempTelEndNo":{"type":"string","description":"Contact Phone Number"},"aempEmailId":{"type":"string","description":"Contact Email ID"},"aempEmailDomain":{"type":"string","description":"Contact Email Domain"},"aempEmail":{"type":"string","description":"Contact Email"},"validYn":{"type":"string","description":"Validity Status"}},"description":"Tax Invoice DTO"},"CashReceipt":{"type":"object","properties":{"prsntPurpsCd":{"type":"string","description":"Submission Purpose (OM010)"},"idefNo":{"type":"string","description":"Identification No."},"prchsrNm":{"type":"string","description":"Buyer Name"},"prchsrEmail":{"type":"string","description":"Buyer Email"},"prchsrCell":{"type":"string","description":"Buyer Mobile Phone"},"smsTrnsYn":{"type":"string","description":"SMS Sent Status"},"faxTrnsYn":{"type":"string","description":"FAX Sent Status"},"valiYn":{"type":"string","description":"Validity Status"}},"description":"Cash Receipt DTO"},"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 Order Form
> \## Function Description\
> \- Looks up member and non-member order form information.\
> \---\
> \## Detailed Description\
> Looks up member and non-member order form information upon entering the order form.\
> \
\
> The order form information includes member, payment method, order basic, order product, order delivery, order promotion, and accrual information.\
> \- If multiple products are ordered, looks up payment methods commonly available for all products.\
> \- For member orders, looks up maximum benefit information.\
> \- For non-member orders, sub-payment-method information is not looked up.\
> \- For non-member orders, benefit and accrual information is not looked up.\
> \---\
> \## Revision History\
> \- Release v2.00\_240401 : Applied purchase quantity check and error message display upon entering the order form\
> \- Release v2.00\_240725 : Set order product classification based on product type code upon entering the order form
```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/orderSheet/orderSheet":{"post":{"tags":["Order Form"],"summary":"Look Up Order Form","description":"## Function Description\n- Looks up member and non-member order form information.\n---\n## Detailed Description\nLooks up member and non-member order form information upon entering the order form.\n
\nThe order form information includes member, payment method, order basic, order product, order delivery, order promotion, and accrual information.\n- If multiple products are ordered, looks up payment methods commonly available for all products.\n- For member orders, looks up maximum benefit information.\n- For non-member orders, sub-payment-method information is not looked up.\n- For non-member orders, benefit and accrual information is not looked up.\n---\n## Revision History\n- Release v2.00_240401 : Applied purchase quantity check and error message display upon entering the order form\n- Release v2.00_240725 : Set order product classification based on product type code upon entering the order form\n","operationId":"orderSheet","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSheetRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderSheetResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSheetRequest":{"type":"object","properties":{"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"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"]},"ordGoodsGb":{"type":"string","description":"Order Product Type (OM029)"},"bsketNoList":{"type":"array","description":"Cart No.","items":{"type":"integer","description":"Cart No.","format":"int64"}},"dlvpInfoList":{"type":"array","description":"Delivery Address Information","items":{"$ref":"#/components/schemas/DlvpInfo"}}},"description":"Search Order Form Request DTO"},"DlvpInfo":{"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"emailAddr":{"type":"string","description":"Email Address"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsg":{"type":"string","description":"Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"comnFrdrPwdMask":{"type":"string","description":"Masked Common Entrance Password"},"deliMsgCdNm":{"type":"string","description":"Delivery Message Code Name"},"comnFrdrCogoMethodCdNm":{"type":"string","description":"Common Entrance Access Method Code Name"},"aplyBsketInfoList":{"type":"array","description":"Applied Cart Information","items":{"$ref":"#/components/schemas/AplyBsketInfo"}},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code"},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No."}},"description":"Delivery Address Information DTO"},"AplyBsketInfo":{"type":"object","properties":{"bsketNum":{"type":"integer","description":"Cart No.","format":"int64"},"aplyCnt":{"type":"integer","description":"Applied Product Quantity","format":"int32"}},"description":"Applied Cart Information DTO"},"OrderSheetResponse":{"type":"object","properties":{"orderSheetInfo":{"$ref":"#/components/schemas/OrderSheetInfo"},"orderRegisterRequest":{"$ref":"#/components/schemas/OrderRegisterRequest"}},"description":"Search Order Form Response DTO"},"OrderSheetInfo":{"type":"object","properties":{"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"mainPayMethodInfoList":{"type":"array","description":"Primary Payment Method Info","items":{"$ref":"#/components/schemas/PayMethodInfo"}},"subPayMethodInfoList":{"type":"array","description":"Secondary Payment Method Info","items":{"$ref":"#/components/schemas/PayMethodInfo"}},"memberInfo":{"$ref":"#/components/schemas/MemberInfoResponse"}},"description":"Order Form Info DTO"},"PayMethodInfo":{"type":"object","properties":{"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"]},"langCd":{"type":"string","description":"Payment Method Code","enum":["KOREAN","ENGLISH"]},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"pgGbCd":{"type":"string","description":"PG Classification Code"},"memberSubPaymethodAmount":{"type":"integer","description":"Member's Secondary Payment Method Amount","format":"int64"},"cardCompanyList":{"type":"array","description":"Card Company List (Credit Card Payment)","items":{"$ref":"#/components/schemas/StCdDtlResponse"}},"mainPaymethod":{"type":"boolean"}},"description":"Payment Method Info DTO"},"StCdDtlResponse":{"type":"object","properties":{"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 7"}},"description":"Common Code Response DTO"},"MemberInfoResponse":{"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"mbrGradeNm":{"type":"string","description":"Member Grade Name (ME008)"},"mbrGbCd":{"type":"string","description":"Member Type Code (ME001 - 10: Regular Member, 99: Non-Member)"},"mbrGbNm":{"type":"string","description":"Member Type Name"},"mbrMgrCd":{"type":"string","description":"Member Management Code (ME002)"},"mbrMgrNm":{"type":"string","description":"Member Management Name (ME002)"},"mgrGbCd":{"type":"string","description":"Management Type Code (ME019) 10: Order Caution, 20: Black Consumer, 30: VIP"},"brth":{"type":"string","description":"Date of Birth"},"sexGbCd":{"type":"string","description":"Gender Type Code (ME017)"},"sexGbNm":{"type":"string","description":"Gender Type"},"nafrGbCd":{"type":"string","description":"Domestic/Foreign Type Code (ME018 - 10: Domestic, 20: Foreign)"},"nafrGbNm":{"type":"string","description":"Domestic/Foreign Type Name"},"stafYn":{"type":"string","description":"Employee Status"},"comGbCd":{"type":"string","description":"Employee Company Type Code (ME038)"},"comGbNm":{"type":"string","description":"Employee Company Type Name"},"frstLoginDtm":{"type":"string","description":"First Login Date/Time (subject to the first-login event if there is no first-login information)"},"mbrNm":{"type":"string","description":"Member Name"},"loginId":{"type":"string","description":"Login ID"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix No."},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange No."},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"emailAddr":{"type":"string","description":"Email"},"emailRecvAgrYn":{"type":"string","description":"Email Reception Consent Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent Status"},"histStrDt":{"type":"string","description":"Current Grade Criteria Start Date"},"histEndDt":{"type":"string","description":"Current Grade Criteria End Date"},"smpctAcctLinkGbCd":{"type":"string","description":"Simple Account Linking Classification Code (ME052)"},"smpctAcctLinkGbNm":{"type":"string","description":"Simple Account Linking Type Name"},"frstOrdDt":{"type":"string","description":"First Order Date"},"lstOrdDt":{"type":"string","description":"Last Order Date"},"loginCnt":{"type":"integer","description":"Login Count","format":"int32"},"ordCnt":{"type":"integer","description":"Order Count","format":"int32"},"mbrJoinDtm":{"type":"string","description":"Membership Registration Date","format":"date-time"},"ordLmtYn":{"type":"string","description":"Purchase Restriction Status"},"ciCtacValYn":{"type":"string","description":"CI Verification Information Status"},"appPushAgrYn":{"type":"string","description":"App Push Consent Status"},"pwdChgDtm":{"type":"string","description":"Password Change Date/Time","format":"date-time"},"bmanRegNo":{"type":"string","description":"Business Registration No."},"bmanNm":{"type":"string","description":"Business Name"},"bmanRegDt":{"type":"string","description":"Business Registration Date"},"rpstmnNm":{"type":"string","description":"Representative Name"},"repTelSctNo":{"type":"string","description":"Main Phone Prefix No."},"repTelTxnoNo":{"type":"string","description":"Main Phone Exchange Code"},"repTelEndNo":{"type":"string","description":"Main Phone Last Digits"}},"description":"Member Info DTO"},"OrderRegisterRequest":{"required":["ordBaseInfo","ordDlvInfoList","ordGoodsInfoList"],"type":"object","properties":{"ordBaseInfo":{"$ref":"#/components/schemas/OrdBaseInfo"},"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"ordDlvInfoList":{"type":"array","description":"Order Delivery Information","items":{"$ref":"#/components/schemas/OrdDlvInfo"}},"ordBnfInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"accmInfo":{"$ref":"#/components/schemas/AccmResponse"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"proofDocInfo":{"$ref":"#/components/schemas/ProofDocInfo"}},"description":"Place Order Request"},"OrdBaseInfo":{"required":["giftCard","ordGbCd","ordMediaCd","ordNo","ordererInfo","siteNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"siteNo":{"type":"string","description":"Site No."},"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"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026). Required for Bank Transfer Payment","nullable":true},"rfdActnNo":{"type":"string","description":"Refund Account No. Required for Bank Transfer Payment","nullable":true},"rcdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name. Required for Bank Transfer Payment","nullable":true},"rglrDeliNo":{"type":"string","description":"Subscription Order No.","nullable":true},"chlNo":{"type":"string","description":"Channel No.","nullable":true},"chlDtlNo":{"type":"string","description":"Channel Detail No.","nullable":true},"ordererInfo":{"$ref":"#/components/schemas/OrdererInfo"},"giftCard":{"$ref":"#/components/schemas/GiftCard"},"ordGoodsGb":{"type":"string","description":"OM029 (Order Product Classification Code)\n 10: General Product\n , 20: e-Coupon\n","enum":["GENERAL_GOODS","E_COUPON"]}},"description":"Order Basic Information"},"OrdererInfo":{"required":["cellEndNo","cellSctNo","cellTxnoNo","mbrNo","ordManEmailAddr","ordManNm","umemPwd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Non-Member Orderer Name"},"umemPwd":{"type":"string","description":"Non-Member Order Password"},"ordManEmailAddr":{"type":"string","description":"Non-Member Email Address"},"cellSctNo":{"type":"string","description":"Non-Member Mobile Phone Prefix"},"cellTxnoNo":{"type":"string","description":"Non-Member Mobile Phone Middle Digits"},"cellEndNo":{"type":"string","description":"Non-Member Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Non-Member Phone Area Code"},"telTxnoNo":{"type":"string","description":"Non-Member Phone Exchange Code"},"telEndNo":{"type":"string","description":"Non-Member Phone Last Digits"},"ordLmtYn":{"type":"string","description":"Purchase Restriction Status"},"brth":{"type":"string","description":"Date of Birth"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)"},"stafYn":{"type":"string","description":"Employee Status"},"nonMemberAge":{"type":"integer","description":"Non-Member Age","format":"int32"},"nonMemberCertiYn":{"type":"string","description":"Non-Member Verification Status"}},"description":"Orderer Information"},"GiftCard":{"required":["prstTypCd"],"type":"object","properties":{"prstTypCd":{"type":"string","description":"Gift Type Code (OM045)"},"prstMsg":{"type":"string","description":"Gift Message"}},"description":"Gift Card. Required for Gift Orders","nullable":true},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"},"OrdDlvInfo":{"required":["dlvGrpInfoList","dlvpNm","dtlAddr","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"dlvpNm":{"type":"string","description":"Delivery Address Name. Required for General Orders"},"zipNo":{"type":"string","description":"Postal Code. Required for General Orders"},"zipAddr":{"type":"string","description":"Postal Address. Required for General Orders"},"dtlAddr":{"type":"string","description":"Detailed Address. Required for General Orders"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient Phone Last Digits"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other","nullable":true},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code","nullable":true},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No.","nullable":true},"dlvGrpInfoList":{"type":"array","description":"Delivery Group Information List","items":{"$ref":"#/components/schemas/DlvGrpInfo"}}},"description":"Delivery Address List"},"DlvGrpInfo":{"required":["basketGoodsList","deliKindCd","deliMethodCd","deliNo","deliProcTypCd","dlvAmtInfoList"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Combined Delivery No."},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"basketGoodsList":{"type":"array","description":"Cart Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"dlvAmtInfoList":{"type":"array","description":"Delivery Fee Information","items":{"$ref":"#/components/schemas/DlvAmtInfo"}}},"description":"Delivery Group Information DTO"},"DlvAmtInfo":{"required":["aplyAdtnAmt","deliPolcNo","dlexAmt","dlexTypCd","entrNo","ordCostGbCd","stdAdtnAmt"],"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvBenefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"Shipping Fee Info DTO"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"}},"description":"Shipping Benefit Info","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"goods":{"type":"array","description":"Product Information List","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"Order Promotion Information"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"}},"description":"Product Information List"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"Total Accrual Amount","format":"int64"},"accmList":{"type":"array","description":"Accrual Information List","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"Accrual Information","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"Asset Accrual/Usage Reason Code (ME020)\n 21 : Order Accrual\n , 22 : Member Grade Accrual\n , 23 : Reservation Product Accrual\n , 24 : Promotion Accrual\n , 50 : Order Usage\n , 58 : Delivery Fee Usage\n , 29 : Refund Accrual\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"Accrual Rate","format":"double"},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"},"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code"},"rsrvStdAmt":{"type":"integer","description":"Accrual Standard Amount","format":"int64"},"goodsAccmList":{"type":"array","description":"Product Accrual Information List","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"Accrual Information List"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"}},"description":"Product Accrual Information List"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ProofDocInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No. (System ID)"},"ordManNm":{"type":"string","description":"Orderer Name"},"proofType":{"type":"string","description":"Supporting Document Type"},"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"orderTaxInvoiceRequest":{"$ref":"#/components/schemas/TaxInvoice"},"orderCashReceiptRequest":{"$ref":"#/components/schemas/CashReceipt"}},"description":"Supporting Document Info","nullable":true},"TaxInvoice":{"type":"object","properties":{"entrNo":{"type":"string","description":"Company No."},"goodsNm":{"type":"string","description":"Product Name"},"goodsCount":{"type":"integer","description":"Product Count","format":"int32"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"bmanNo":{"type":"string","description":"Business Registration No."},"bmanNm":{"type":"string","description":"Business Name"},"rpstmnNm":{"type":"string","description":"Representative Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Phone Number"},"aempTelTxnoNo":{"type":"string","description":"Contact Phone Number"},"aempTelEndNo":{"type":"string","description":"Contact Phone Number"},"aempEmailId":{"type":"string","description":"Contact Email ID"},"aempEmailDomain":{"type":"string","description":"Contact Email Domain"},"aempEmail":{"type":"string","description":"Contact Email"},"validYn":{"type":"string","description":"Validity Status"}},"description":"Tax Invoice DTO"},"CashReceipt":{"type":"object","properties":{"prsntPurpsCd":{"type":"string","description":"Submission Purpose (OM010)"},"idefNo":{"type":"string","description":"Identification No."},"prchsrNm":{"type":"string","description":"Buyer Name"},"prchsrEmail":{"type":"string","description":"Buyer Email"},"prchsrCell":{"type":"string","description":"Buyer Mobile Phone"},"smsTrnsYn":{"type":"string","description":"SMS Sent Status"},"faxTrnsYn":{"type":"string","description":"FAX Sent Status"},"valiYn":{"type":"string","description":"Validity Status"}},"description":"Cash Receipt DTO"},"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 Event for Agent Order Form
> \## Function Description\
> \- Looks up whether an ongoing gift event exists for a product ordered by an agent.\
> \---\
> \## Detailed Description\
> \- Looks up whether an ongoing gift event exists for the product upon completion of product selection in an agent order.\
> \---\
> \## Notes\
> \- Identical logic to the aeEvtList (order form gift event lookup) API, except for the method of retrieving member information.
```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/orderSheet/getCounselorOrderAeEvtList":{"post":{"tags":["Order Form"],"summary":"Look Up Gift Event for Agent Order Form","description":"## Function Description\n- Looks up whether an ongoing gift event exists for a product ordered by an agent.\n---\n## Detailed Description\n- Looks up whether an ongoing gift event exists for the product upon completion of product selection in an agent order.\n---\n## Notes\n- Identical logic to the aeEvtList (order form gift event lookup) API, except for the method of retrieving member information.\n","operationId":"getCounselorOrderAeEvtList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSheetAeEvtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AeEvtInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSheetAeEvtRequest":{"type":"object","properties":{"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"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"]},"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"siteNo":{"type":"string","description":"Site No."},"stafYn":{"type":"string","description":"Employee Status"}},"description":"FO Order Form Gift Event Search Request DTO"},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"}}}}
```
## Order Form Gift Promotion Retrieval
> \## Function Description\
> \- Looks up whether an ongoing gift event exists for the ordered product.\
> \---\
> \## Detailed Description\
> Looks up whether an ongoing gift event exists for the ordered product upon entering the order form.\
> \- Gift event information is not looked up for non-member orders.
```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/orderSheet/aeEvtList":{"post":{"tags":["Order Form"],"summary":"Order Form Gift Promotion Retrieval","description":"## Function Description\n- Looks up whether an ongoing gift event exists for the ordered product.\n---\n## Detailed Description\nLooks up whether an ongoing gift event exists for the ordered product upon entering the order form.\n- Gift event information is not looked up for non-member orders.\n","operationId":"getAeEvtList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSheetAeEvtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AeEvtInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSheetAeEvtRequest":{"type":"object","properties":{"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"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"]},"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"siteNo":{"type":"string","description":"Site No."},"stafYn":{"type":"string","description":"Employee Status"}},"description":"FO Order Form Gift Event Search Request DTO"},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"}}}}
```
## Retrieve Order Accrual Information
> \## Function Description\
> \- Looks up accrual information matching the order information.\
> \---\
> \## Detailed Description\
> Looks up accrual information matching the order information when the applied benefit information is changed on the order form screen.\
> \- Accrual information is not looked up for non-member orders.
```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/orderSheet/accumulationInfo":{"post":{"tags":["Order Form"],"summary":"Retrieve Order Accrual Information","description":" ## Function Description\n- Looks up accrual information matching the order information.\n---\n## Detailed Description\nLooks up accrual information matching the order information when the applied benefit information is changed on the order form screen.\n- Accrual information is not looked up for non-member orders.\n","operationId":"getAccumulationInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSheetAccmRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccmResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSheetAccmRequest":{"type":"object","properties":{"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"benefitOrderPromotionInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"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"]}},"description":"FO Order Accrual Retrieval Request DTO"},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"goods":{"type":"array","description":"Product Information List","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"Order Promotion Information"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"}},"description":"Product Information List"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"Total Accrual Amount","format":"int64"},"accmList":{"type":"array","description":"Accrual Information List","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"Accrual Information","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"Asset Accrual/Usage Reason Code (ME020)\n 21 : Order Accrual\n , 22 : Member Grade Accrual\n , 23 : Reservation Product Accrual\n , 24 : Promotion Accrual\n , 50 : Order Usage\n , 58 : Delivery Fee Usage\n , 29 : Refund Accrual\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"Accrual Rate","format":"double"},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"},"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code"},"rsrvStdAmt":{"type":"integer","description":"Accrual Standard Amount","format":"int64"},"goodsAccmList":{"type":"array","description":"Product Accrual Information List","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"Accrual Information List"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"}},"description":"Product Accrual Information 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 Order-Completion Information
> \## Function Description\
> \- API for looking up order-completion information after a successful order.\
> \---\
> \## Detailed Description\
> \- An exception occurs if a claim is in progress for the requested order.\
> \- For non-members, the cookie value created via the non-member login processing API is required.\
> \---\
> \## Revision History\
> \* Release v2.00\_240401 : Added gift name (prestNm) to the product list (OrderCompleteGoodsInfo)\
> \* Release v2.00\_240401 : Added order sequence no. (ordSeq) and main-product order sequence no. (aeOrdSeq) so the gift list can be displayed per purchased product\
> \* Release v2.00\_240401 : Added lookup of single-product status (snsGoodsYn)
```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/order/getOrderCompleteInfo":{"post":{"tags":["Order Form"],"summary":"Look Up Order-Completion Information","description":"## Function Description\n- API for looking up order-completion information after a successful order.\n---\n## Detailed Description\n- An exception occurs if a claim is in progress for the requested order.\n- For non-members, the cookie value created via the non-member login processing API is required.\n---\n## Revision History\n* Release v2.00_240401 : Added gift name (prestNm) to the product list (OrderCompleteGoodsInfo)\n* Release v2.00_240401 : Added order sequence no. (ordSeq) and main-product order sequence no. (aeOrdSeq) so the gift list can be displayed per purchased product\n* Release v2.00_240401 : Added lookup of single-product status (snsGoodsYn)\n","operationId":"getOrderCompleteInfo","parameters":[{"name":"nonmemberInfo","in":"cookie","description":"Non-member Order Information. Required When Looking Up Non-member Order Completion","schema":{"type":"String"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCompleteRequest"}}},"required":true},"responses":{"200":{"description":"Order Completion Retrieved Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCompleteResponse"}}}},"900":{"description":"Business processing error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderCompleteRequest":{"required":["ordNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"systemType":{"type":"string","description":"System Type Code 10: FO, 20: BO","enum":["10","20"],"default":"10"}},"description":"Search Order Completion Request"},"OrderCompleteResponse":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordGbCd":{"type":"string","description":"Order Classification Code (OM002)"},"ordAccpDtm":{"type":"string","description":"Order Date/Time","format":"date-time"},"giftCard":{"$ref":"#/components/schemas/OrderCompleteGiftCard"},"deliveryPlaceList":{"type":"array","description":"Delivery Address List","items":{"$ref":"#/components/schemas/OrderCompleteDeliveryPlace"}},"payInfoList":{"type":"array","description":"Payment Information List","items":{"$ref":"#/components/schemas/OrderCompletePayInfo"}},"orderAmount":{"$ref":"#/components/schemas/OrderAmount"},"aeOrdSeq":{"type":"integer","description":"Main Item Order Sequence No.","format":"int32"},"ordGoodsGb":{"type":"string","description":"Order Product Type (OM029)"}},"description":"Order Completion Info"},"OrderCompleteGiftCard":{"type":"object","properties":{"prstTypCd":{"type":"string","description":"Gift Type Code (OM045)"},"prstMsg":{"type":"string","description":"Gift Message"},"cardImgPath":{"type":"string","description":"Card Image URL"}},"description":"Gift Card","nullable":true},"OrderCompleteDeliveryPlace":{"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsgCdNm":{"type":"string","description":"Delivery Message Code Content"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)","nullable":true},"comnFrdrCogoMethodCdNm":{"type":"string","description":"Common Entrance Access Method Code Content","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code"},"deliveryGroupList":{"type":"array","description":"Delivery Group List","items":{"$ref":"#/components/schemas/OrderCompleteDeliveryGroup"}}},"description":"Delivery Address Information"},"OrderCompleteDeliveryGroup":{"type":"object","properties":{"deliNo":{"type":"string","description":"Delivery No."},"goodsInfoList":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/OrderCompleteGoodsInfo"}}},"description":"Delivery Group List"},"OrderCompleteGoodsInfo":{"type":"object","properties":{"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"ordSaleTypCd":{"type":"string","description":"Order Sales Type Code (OM004)"},"saleMethCd":{"type":"string","description":"Sales Method Code (PR003)"},"prestNm":{"type":"string","description":"Gift Item Name"},"goodsNm":{"type":"string","description":"Product Name"},"goodsImg":{"type":"string","description":"Product Image"},"brandNm":{"type":"string","description":"Brand Name"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"aeOrdSeq":{"type":"integer","description":"Main Item Order Sequence No.","format":"int32"},"sngGoodsYn":{"type":"string","description":"Single Product Status"}},"description":"Product List"},"OrderCompletePayInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayNm":{"type":"string","description":"Payment Method Name"},"cardNm":{"type":"string","description":"Card Name (When the Payment Method Is Credit Card)"},"divMonCnt":{"type":"integer","description":"Number of Installments (When the Payment Method Is Credit Card)","format":"int32"},"bankCd":{"type":"string","description":"Bank Code (When the Payment Method Is Real-Time Account Transfer/Virtual Account)"},"bankNm":{"type":"string","description":"Bank Name (When the Payment Method Is Real-Time Account Transfer/Virtual Account)"},"actnNo":{"type":"string","description":"Account No. (When the Payment Method Is Real-Time Account Transfer/Virtual Account)"},"dpmnNm":{"type":"string","description":"Depositor Name (When the Payment Method Is Virtual Account)"},"dptFcstDt":{"type":"string","description":"Expected Deposit Date (When the Payment Method Is Virtual Account)"}},"description":"Payment Information List"},"OrderAmount":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"saleAmt":{"type":"integer","description":"Sales Amount (Sale Price * Quantity)","format":"int64"},"deliveryAmt":{"type":"integer","description":"Delivery Fee","format":"int64"},"benefitAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"accmAmt":{"type":"integer","description":"Expected Accrual Amount","format":"int64"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"}},"description":"Order Amount Info"},"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 Delivery Group Delivery Fee
> \## Function Description\
> \- Looks up the delivery fee for each delivery group.\
> \---\
> \## Detailed Description\
> \- Additional delivery fees are charged if the requested delivery group's postal code is in a remote area.
```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/delivery/deliveryGroupAmountList":{"post":{"tags":["Order Form"],"summary":"Look Up Delivery Group Delivery Fee","description":"## Function Description\n- Looks up the delivery fee for each delivery group.\n---\n## Detailed Description\n- Additional delivery fees are charged if the requested delivery group's postal code is in a remote area.\n","operationId":"getDeliveryGroupAmountList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDeliveryGroupFeeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryAmountInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderDeliveryGroupFeeRequest":{"required":["deliMethodCd","deliveryGroupFeeRequestList"],"type":"object","properties":{"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"deliveryGroupFeeRequestList":{"type":"array","description":"Delivery Group Shipping Fee Request Info","items":{"$ref":"#/components/schemas/DeliveryFeeRequest"}}},"description":"Search Delivery Group Shipping Fee DTO"},"DeliveryFeeRequest":{"required":["amount","deliPolcNo","entrNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Delivery No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"zipNo":{"type":"string","description":"Postal Code. If empty, the standard shipping fee is used for the lookup"},"amount":{"type":"integer","description":"Sum of Delivery Group Product Amounts","format":"int64"}},"description":"Delivery Group Shipping Fee Request Info DTO"},"DeliveryAmountInfo":{"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"adtnCostInfoList":{"type":"array","description":"Delivery Fee List","items":{"$ref":"#/components/schemas/DlvAdtnCostInfo"}}}},"DlvAdtnCostInfo":{"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code"}},"description":"Delivery Fee 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"}}}}
```
## Retrieve Order Delivery Fee
> \## Function Description\
> \- Looks up the delivery fee when the user changes the order delivery address information on the order form screen.\
> \---\
> \## Detailed Description\
> \- Looks up the delivery fee when the user selects order delivery address information on the order form.\
> \- Creates a delivery group per product and looks up the delivery fee for each delivery group.\
> \- Additional delivery fees may apply if the changed delivery address is a remote area.
```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/delivery/deliveryAmount":{"post":{"tags":["Order Form"],"summary":"Retrieve Order Delivery Fee","description":"## Function Description\n- Looks up the delivery fee when the user changes the order delivery address information on the order form screen.\n---\n## Detailed Description\n- Looks up the delivery fee when the user selects order delivery address information on the order form.\n- Creates a delivery group per product and looks up the delivery fee for each delivery group.\n- Additional delivery fees may apply if the changed delivery address is a remote area.\n","operationId":"getDeliveryAmount","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryAmountRequestBasketGoods"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrdDlvInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryAmountRequestBasketGoods":{"required":["deliMethodCd"],"type":"object","properties":{"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"dlvpInfo":{"$ref":"#/components/schemas/DlvpInfo"},"goodsList":{"type":"array","description":"Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"allClaim":{"type":"boolean","description":"Full Claim Status"},"allNonReturnable":{"type":"boolean"}},"description":"Retrieve Delivery Fee Request DTO"},"DlvpInfo":{"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"emailAddr":{"type":"string","description":"Email Address"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsg":{"type":"string","description":"Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"comnFrdrPwdMask":{"type":"string","description":"Masked Common Entrance Password"},"deliMsgCdNm":{"type":"string","description":"Delivery Message Code Name"},"comnFrdrCogoMethodCdNm":{"type":"string","description":"Common Entrance Access Method Code Name"},"aplyBsketInfoList":{"type":"array","description":"Applied Cart Information","items":{"$ref":"#/components/schemas/AplyBsketInfo"}},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code"},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No."}},"description":"Delivery Address Information DTO"},"AplyBsketInfo":{"type":"object","properties":{"bsketNum":{"type":"integer","description":"Cart No.","format":"int64"},"aplyCnt":{"type":"integer","description":"Applied Product Quantity","format":"int32"}},"description":"Applied Cart Information DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"OrdDlvInfo":{"required":["dlvGrpInfoList","dlvpNm","dtlAddr","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"dlvpNm":{"type":"string","description":"Delivery Address Name. Required for General Orders"},"zipNo":{"type":"string","description":"Postal Code. Required for General Orders"},"zipAddr":{"type":"string","description":"Postal Address. Required for General Orders"},"dtlAddr":{"type":"string","description":"Detailed Address. Required for General Orders"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient Phone Last Digits"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other","nullable":true},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code","nullable":true},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No.","nullable":true},"dlvGrpInfoList":{"type":"array","description":"Delivery Group Information List","items":{"$ref":"#/components/schemas/DlvGrpInfo"}}},"description":"Delivery Address List"},"DlvGrpInfo":{"required":["basketGoodsList","deliKindCd","deliMethodCd","deliNo","deliProcTypCd","dlvAmtInfoList"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Combined Delivery No."},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"basketGoodsList":{"type":"array","description":"Cart Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"dlvAmtInfoList":{"type":"array","description":"Delivery Fee Information","items":{"$ref":"#/components/schemas/DlvAmtInfo"}}},"description":"Delivery Group Information DTO"},"DlvAmtInfo":{"required":["aplyAdtnAmt","deliPolcNo","dlexAmt","dlexTypCd","entrNo","ordCostGbCd","stdAdtnAmt"],"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvBenefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"Shipping Fee Info DTO"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"}},"description":"Shipping Benefit Info","nullable":true},"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"}}}}
```
## Agent Order Placement
> \## Function Description\
> \- API that creates an order entered by a customer service agent.\
> \---\
> \## Detailed Description\
> \- Creates an order paid with the member's mileage. When the order succeeds, an order completion AlimTalk message and email are sent to the member.\
> \---\
> \## Special Notes\
> \- Same logic as the order (Place Order) API.\
> \- The difference is that the order is created using the member number (mbrNo) parameter, which is a required parameter.\
> \---\
> \## Revision History\
> \- Release v2.00\_240530 : Changed API URL and Swagger\
> \---
```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/counselorOrder":{"post":{"tags":["Order Form"],"summary":"Agent Order Placement","description":"## Function Description\n- API that creates an order entered by a customer service agent.\n---\n## Detailed Description\n- Creates an order paid with the member's mileage. When the order succeeds, an order completion AlimTalk message and email are sent to the member.\n---\n## Special Notes\n- Same logic as the order (Place Order) API.\n- The difference is that the order is created using the member number (mbrNo) parameter, which is a required parameter.\n---\n## Revision History\n- Release v2.00_240530 : Changed API URL and Swagger\n---\n","operationId":"counselorOrder","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Order Successful"},"900":{"description":"Business processing error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderRegisterRequest":{"required":["ordBaseInfo","ordDlvInfoList","ordGoodsInfoList"],"type":"object","properties":{"ordBaseInfo":{"$ref":"#/components/schemas/OrdBaseInfo"},"ordGoodsInfoList":{"type":"array","description":"Order Product Information","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"ordDlvInfoList":{"type":"array","description":"Order Delivery Information","items":{"$ref":"#/components/schemas/OrdDlvInfo"}},"ordBnfInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"accmInfo":{"$ref":"#/components/schemas/AccmResponse"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"proofDocInfo":{"$ref":"#/components/schemas/ProofDocInfo"}},"description":"Place Order Request"},"OrdBaseInfo":{"required":["giftCard","ordGbCd","ordMediaCd","ordNo","ordererInfo","siteNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"siteNo":{"type":"string","description":"Site No."},"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"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026). Required for Bank Transfer Payment","nullable":true},"rfdActnNo":{"type":"string","description":"Refund Account No. Required for Bank Transfer Payment","nullable":true},"rcdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name. Required for Bank Transfer Payment","nullable":true},"rglrDeliNo":{"type":"string","description":"Subscription Order No.","nullable":true},"chlNo":{"type":"string","description":"Channel No.","nullable":true},"chlDtlNo":{"type":"string","description":"Channel Detail No.","nullable":true},"ordererInfo":{"$ref":"#/components/schemas/OrdererInfo"},"giftCard":{"$ref":"#/components/schemas/GiftCard"},"ordGoodsGb":{"type":"string","description":"OM029 (Order Product Classification Code)\n 10: General Product\n , 20: e-Coupon\n","enum":["GENERAL_GOODS","E_COUPON"]}},"description":"Order Basic Information"},"OrdererInfo":{"required":["cellEndNo","cellSctNo","cellTxnoNo","mbrNo","ordManEmailAddr","ordManNm","umemPwd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Non-Member Orderer Name"},"umemPwd":{"type":"string","description":"Non-Member Order Password"},"ordManEmailAddr":{"type":"string","description":"Non-Member Email Address"},"cellSctNo":{"type":"string","description":"Non-Member Mobile Phone Prefix"},"cellTxnoNo":{"type":"string","description":"Non-Member Mobile Phone Middle Digits"},"cellEndNo":{"type":"string","description":"Non-Member Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Non-Member Phone Area Code"},"telTxnoNo":{"type":"string","description":"Non-Member Phone Exchange Code"},"telEndNo":{"type":"string","description":"Non-Member Phone Last Digits"},"ordLmtYn":{"type":"string","description":"Purchase Restriction Status"},"brth":{"type":"string","description":"Date of Birth"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)"},"stafYn":{"type":"string","description":"Employee Status"},"nonMemberAge":{"type":"integer","description":"Non-Member Age","format":"int32"},"nonMemberCertiYn":{"type":"string","description":"Non-Member Verification Status"}},"description":"Orderer Information"},"GiftCard":{"required":["prstTypCd"],"type":"object","properties":{"prstTypCd":{"type":"string","description":"Gift Type Code (OM045)"},"prstMsg":{"type":"string","description":"Gift Message"}},"description":"Gift Card. Required for Gift Orders","nullable":true},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"Gift Promotion Information","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"Order Product DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Time","format":"date-time"},"itmNo":{"type":"string","description":"Item No."},"bsketNo":{"type":"integer","description":"Cart No.","format":"int64"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"bsketQty":{"type":"integer","description":"Cart Quantity","format":"int32"},"goodsNm":{"type":"string","description":"Product Name"},"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."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchase Age Restriction Code"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStrDtm":{"type":"string","description":"Sales Start Date/Time","format":"date-time"},"saleEndDtm":{"type":"string","description":"Sales End Date/Time","format":"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","description":"Minimum Limit Quantity","format":"int32"},"maxLmtQty":{"type":"integer","description":"Maximum Limit Quantity","format":"int32"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"preSalePrc":{"type":"integer","description":"Previous Selling Price","format":"int64"},"mrgnRate":{"type":"number","description":"Margin Rate","format":"double"},"payMeanInfo":{"type":"string","description":"Payment Method"},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","description":"Item Quantity","format":"int64"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time","format":"date-time"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date","format":"date"},"hsCd":{"type":"string","description":"Item Classification Code"},"wishYn":{"type":"string","description":"Wishlist Status"},"maxDcAmt":{"type":"integer","description":"Maximum Benefit Amount","format":"int64"},"goodsImg":{"type":"string","description":"Product Image"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005)"},"gvgfPsbYn":{"type":"string","description":"Gift Option Availability Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"sngGoodsYn":{"type":"string","description":"Single Product Status"},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."},"entrGoodsNo":{"type":"string","description":"Vendor Product No."},"entrItmNo":{"type":"string","description":"Vendor SKU No."},"ordCnclPsbYn":{"type":"string","description":"Order Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Cart Product DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Total Discount Amount","format":"int64"},"benefitList":{"type":"array","description":"Benefit Information List","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"Product Benefit Information","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"Discount Amount by Quantity","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Benefit Information 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"},"OrdDlvInfo":{"required":["dlvGrpInfoList","dlvpNm","dtlAddr","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"dlvpNm":{"type":"string","description":"Delivery Address Name. Required for General Orders"},"zipNo":{"type":"string","description":"Postal Code. Required for General Orders"},"zipAddr":{"type":"string","description":"Postal Address. Required for General Orders"},"dtlAddr":{"type":"string","description":"Detailed Address. Required for General Orders"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient Phone Last Digits"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input"},"deliMsg":{"type":"string","description":"Delivery Message","nullable":true},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other","nullable":true},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method","nullable":true},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password","nullable":true},"pcccSeq":{"type":"string","description":"Member Customs Clearance Code Sequence No."},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Code","nullable":true},"newPersCstmCd":{"type":"string","description":"New Customs Clearance No.","nullable":true},"dlvGrpInfoList":{"type":"array","description":"Delivery Group Information List","items":{"$ref":"#/components/schemas/DlvGrpInfo"}}},"description":"Delivery Address List"},"DlvGrpInfo":{"required":["basketGoodsList","deliKindCd","deliMethodCd","deliNo","deliProcTypCd","dlvAmtInfoList"],"type":"object","properties":{"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"deliNo":{"type":"string","description":"Combined Delivery No."},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"basketGoodsList":{"type":"array","description":"Cart Product Information","items":{"$ref":"#/components/schemas/BasketGoods"}},"dlvAmtInfoList":{"type":"array","description":"Delivery Fee Information","items":{"$ref":"#/components/schemas/DlvAmtInfo"}}},"description":"Delivery Group Information DTO"},"DlvAmtInfo":{"required":["aplyAdtnAmt","deliPolcNo","dlexAmt","dlexTypCd","entrNo","ordCostGbCd","stdAdtnAmt"],"type":"object","properties":{"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvBenefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"Shipping Fee Info DTO"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"}},"description":"Shipping Benefit Info","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"},"isMaxYn":{"type":"string","description":"Maximum Benefit Status"},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"goods":{"type":"array","description":"Product Information List","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"Order Promotion Information"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"dcAmt":{"type":"integer","description":"Discount Amount","format":"int64"}},"description":"Product Information List"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"Total Accrual Amount","format":"int64"},"accmList":{"type":"array","description":"Accrual Information List","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"Accrual Information","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"Asset Accrual/Usage Reason Code (ME020)\n 21 : Order Accrual\n , 22 : Member Grade Accrual\n , 23 : Reservation Product Accrual\n , 24 : Promotion Accrual\n , 50 : Order Usage\n , 58 : Delivery Fee Usage\n , 29 : Refund Accrual\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"Accrual Rate","format":"double"},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"},"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"In-House Cost Sharing Ratio","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost Sharing Ratio","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Code"},"rsrvStdAmt":{"type":"integer","description":"Accrual Standard Amount","format":"int64"},"goodsAccmList":{"type":"array","description":"Product Accrual Information List","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"Accrual Information List"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"accmAmt":{"type":"integer","description":"Accrued Amount","format":"int64"}},"description":"Product Accrual Information List"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ProofDocInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No. (System ID)"},"ordManNm":{"type":"string","description":"Orderer Name"},"proofType":{"type":"string","description":"Supporting Document Type"},"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"orderTaxInvoiceRequest":{"$ref":"#/components/schemas/TaxInvoice"},"orderCashReceiptRequest":{"$ref":"#/components/schemas/CashReceipt"}},"description":"Supporting Document Info","nullable":true},"TaxInvoice":{"type":"object","properties":{"entrNo":{"type":"string","description":"Company No."},"goodsNm":{"type":"string","description":"Product Name"},"goodsCount":{"type":"integer","description":"Product Count","format":"int32"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"bmanNo":{"type":"string","description":"Business Registration No."},"bmanNm":{"type":"string","description":"Business Name"},"rpstmnNm":{"type":"string","description":"Representative Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Phone Number"},"aempTelTxnoNo":{"type":"string","description":"Contact Phone Number"},"aempTelEndNo":{"type":"string","description":"Contact Phone Number"},"aempEmailId":{"type":"string","description":"Contact Email ID"},"aempEmailDomain":{"type":"string","description":"Contact Email Domain"},"aempEmail":{"type":"string","description":"Contact Email"},"validYn":{"type":"string","description":"Validity Status"}},"description":"Tax Invoice DTO"},"CashReceipt":{"type":"object","properties":{"prsntPurpsCd":{"type":"string","description":"Submission Purpose (OM010)"},"idefNo":{"type":"string","description":"Identification No."},"prchsrNm":{"type":"string","description":"Buyer Name"},"prchsrEmail":{"type":"string","description":"Buyer Email"},"prchsrCell":{"type":"string","description":"Buyer Mobile Phone"},"smsTrnsYn":{"type":"string","description":"SMS Sent Status"},"faxTrnsYn":{"type":"string","description":"FAX Sent Status"},"valiYn":{"type":"string","description":"Validity Status"}},"description":"Cash Receipt DTO"},"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"}}}}
```
## Issue Order No.
> \## Function Description\
> \- Issues an order number.\
> \---\
> \## Detailed Description\
> Called just before payment on the order form to issue the order number.
```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/orderSheet/ordNo":{"get":{"tags":["Order Form"],"summary":"Issue Order No.","description":"## Function Description\n- Issues an order number.\n---\n## Detailed Description\nCalled just before payment on the order form to issue the order number.\n","operationId":"getNextOrdNo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"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"}}}}
```