> 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/store-front-api/order-api/undefined-13.md). # 프로모션 할인 ## 주문서 배송비 쿠폰 조회 > \## 기능설명\ > \* 배송그룹별 배송비쿠폰 정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* \*\*비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.\*\*\ > \* 동일한 쿠폰이 하나 이상의 배송그룹에 노출 될 수 있습니다.\ > \* 현재 정책에서는 \*\*주문당 하나의 배송비 쿠폰을 적용\*\*할 수 있습니다.\ > \* 프로모션 유형에 따라 무료배송쿠폰, 무료반품쿠폰을 조회할 수 있습니다.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/orderDlvBenefitList":{"post":{"tags":["프로모션 할인"],"summary":"주문서 배송비 쿠폰 조회","description":"## 기능설명\n* 배송그룹별 배송비쿠폰 정보를 조회합니다.\n---\n## 상세설명\n* **비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.**\n* 동일한 쿠폰이 하나 이상의 배송그룹에 노출 될 수 있습니다.\n* 현재 정책에서는 **주문당 하나의 배송비 쿠폰을 적용**할 수 있습니다.\n* 프로모션 유형에 따라 무료배송쿠폰, 무료반품쿠폰을 조회할 수 있습니다.\n","operationId":"getDlvBenefitInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlvOrderApiRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionDlvOrderResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DlvOrderApiRequest":{"required":["baseDtm","deliGrpInfoList","mbrGradeCd","mbrNo","promoTypCd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"promoTypCd":{"type":"string","description":"프로모션 유형(무료배송쿠폰, 무료반품비쿠폰)","enum":["14","15"]},"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"deliGrpInfoList":{"type":"array","description":"배송 그룹 리스트","items":{"$ref":"#/components/schemas/DeliGrpRequest"}}},"description":"배송비쿠폰 조회 Request"},"DeliGrpRequest":{"required":["deliNo","entrNo"],"type":"object","properties":{"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"}},"description":"배송그룹 정보"},"PromotionDlvOrderResponse":{"required":["deliGrpInfo","usePsbClmDlvCpnCnt","usePsbDlvCpnCnt"],"type":"object","properties":{"usePsbDlvCpnCnt":{"type":"integer","description":"사용가능무료배송쿠폰수","format":"int32"},"usePsbClmDlvCpnCnt":{"type":"integer","description":"사용가능무료반품쿠폰수","format":"int32"},"deliGrpInfo":{"type":"array","description":"배송그룹 리스트","items":{"$ref":"#/components/schemas/DeliGrpInfo"}}}},"DeliGrpInfo":{"required":["benefitList","deliNo","entrNo"],"type":"object","properties":{"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"},"benefitList":{"type":"array","description":"혜택정보","items":{"$ref":"#/components/schemas/DlvBenefitInfo"}}},"description":"배송그룹 정보"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"ordCostGbCd":{"type":"string","description":"비용구분코드(OM043)"}},"description":"배송혜택정보","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"}}}} ``` ## 주문서 최대혜택가 조회 > \## 기능설명\ > \* 조건에 따라 \*\*최대혜택조회/사용가능한 할인정보\*\*를 조회합니다.\ > \---\ > \## 상세설명\ > \* \*\*비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.\*\*\ > \* \*\*선택된 쿠폰/할인\*\*이 있는 경우 : 최대혜택 조회\ > \* \*\*선택된 쿠폰/할인\*\*이 없는 경우 : 선택된 쿠폰/할인 사용 가능 체크\ > \* 전달받은 상품에 사용 가능한 혜택 정보를 체크하여 계산합니다.\ > \* 할인으로 인해 상품의 역마진이 발생하는 혜택은 조회되지 않습니다.\ > \---\ > \## 수정번호\ > \* Release v1.03\_231106: 임직원 할인 한도 관리 추가\ > \* Release v2.00\_240530: 최대혜택 계산 시 주문 수량을 고려하도록 함
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/orderBenefitList":{"post":{"tags":["프로모션 할인"],"summary":"주문서 최대혜택가 조회","description":"## 기능설명\n* 조건에 따라 **최대혜택조회/사용가능한 할인정보**를 조회합니다.\n---\n## 상세설명\n* **비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.**\n* **선택된 쿠폰/할인**이 있는 경우 : 최대혜택 조회\n* **선택된 쿠폰/할인**이 없는 경우 : 선택된 쿠폰/할인 사용 가능 체크\n* 전달받은 상품에 사용 가능한 혜택 정보를 체크하여 계산합니다.\n* 할인으로 인해 상품의 역마진이 발생하는 혜택은 조회되지 않습니다.\n---\n## 수정번호\n* Release v1.03_231106: 임직원 할인 한도 관리 추가\n* Release v2.00_240530: 최대혜택 계산 시 주문 수량을 고려하도록 함\n","operationId":"getBenefitInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBenefitRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BenefitResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderBenefitRequest":{"required":["baseDtm","comGbCd","goodsList","mbrGradeCd","mbrNo","ordMediaCd","ordTypeGbCd","orderBnfList","stafYn"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"comGbCd":{"type":"string","description":"회사구분코드(ME038)"},"stafYn":{"type":"string","description":"임직원여부"},"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"ordTypeGbCd":{"type":"string","description":"주문 유형\n 10 : 장바구니\n , 20 : 주문\n , 30 : 클레임\n","enum":["10","20","30"]},"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"goodsList":{"type":"array","description":"상품 혜택 리스트","items":{"$ref":"#/components/schemas/GoodsBenefitInfo"}},"orderBnfList":{"type":"array","description":"주문 혜택 리스트","items":{"$ref":"#/components/schemas/BenefitInfo"}}},"description":"쿠폰혜택조회 Request"},"GoodsBenefitInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","itmNo","marketingDisplayNo","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"dispCtgNo":{"type":"string","description":"전시카테고리번호"},"brandNo":{"type":"string","description":"브랜드번호"},"entrNo":{"type":"string","description":"협력사번호"},"chlNo":{"type":"string","description":"채널번호"},"marketingDisplayNo":{"type":"string","description":"기획전번호"},"cnt":{"type":"integer","description":"수량","format":"int32"},"bnfList":{"type":"array","description":"선택된 혜택 정보","items":{"$ref":"#/components/schemas/BenefitInfo"}}},"description":"상품 혜택 리스트"},"BenefitInfo":{"required":["promoNo"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션 번호"},"cpnIsuNo":{"type":"string","description":"쿠폰발급 번호"}},"description":"주문 혜택 리스트"},"BenefitResponse":{"required":["goodsBenefitList","orderBenefitList","totalDcAmt"],"type":"object","properties":{"totalDcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"goodsBenefitList":{"type":"array","description":"상품혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/GoodsBenefitResponse"}},"orderBenefitList":{"type":"array","description":"주문혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"}}},"description":"쿠폰혜택조회 Response"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"benefitList":{"type":"array","description":"혜택정보리스트","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"상품혜택정보","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"개수별할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"혜택정보리스트"},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"goods":{"type":"array","description":"상품정보 리스트","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"주문프로모션정보"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}},"description":"상품정보 리스트"},"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"}}}} ``` ## 상품상세 최대혜택가조회 > \## 기능설명\ > \* 상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.\ > \---\ > \## 상세설명\ > \* 상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.\ > \* 회원의 경우 최대혜택 계산 시 다운로드 가능한 쿠폰도 계산 대상에 포함합니다.\ > \* 최대 혜택 계산에 적용 되는 할인 정보\ > \* 비회원\ > \* 프로모션(할인) : 상품즉시할인(적용회원등급: 전체 선택, 전체 미선택(데이터 마이그레이션 고려))\ > \* 회원\ > \* 프로모션(할인) : 임직원할인, 상품즉시할인\ > \* 보유한 쿠폰 : 상품할인쿠폰\ > \* 다운로드 가능한 쿠폰\ > \* 프로모션유형 : 상품할인쿠폰\ > \* 쿠폰발급주체 : 고정판촉쿠폰\ > \* 쿠폰발급방식 : 고객다운로드발급, 할인쿠폰코드발급\ > \---\ > \## 수정번호\ > \* Release v1.03\_231106: 임직원 할인 한도 관리 추가
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/maxDcAmt":{"post":{"tags":["프로모션 할인"],"summary":"상품상세 최대혜택가조회","description":"## 기능설명\n* 상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.\n---\n## 상세설명\n* 상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.\n* 회원의 경우 최대혜택 계산 시 다운로드 가능한 쿠폰도 계산 대상에 포함합니다.\n* 최대 혜택 계산에 적용 되는 할인 정보\n * 비회원\n * 프로모션(할인) : 상품즉시할인(적용회원등급: 전체 선택, 전체 미선택(데이터 마이그레이션 고려))\n * 회원\n * 프로모션(할인) : 임직원할인, 상품즉시할인\n * 보유한 쿠폰 : 상품할인쿠폰\n * 다운로드 가능한 쿠폰\n * 프로모션유형 : 상품할인쿠폰\n * 쿠폰발급주체 : 고정판촉쿠폰\n * 쿠폰발급방식 : 고객다운로드발급, 할인쿠폰코드발급\n---\n## 수정번호\n* Release v1.03_231106: 임직원 할인 한도 관리 추가\n","operationId":"getGoodsMaxBenefit","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsBenefitRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoodsMaxBenefitResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"GoodsBenefitRequest":{"required":["goodsList","ordMediaCd"],"type":"object","properties":{"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"goodsList":{"type":"array","description":"상품 리스트","items":{"$ref":"#/components/schemas/GoodsDetailMaxBenefitGoodsInfo"}}},"description":"상품상세최대혜택가조회 Request"},"GoodsDetailMaxBenefitGoodsInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","itmNo","marketingDisplayNo","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"},"cnt":{"type":"integer","description":"수량","format":"int32"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"dispCtgNo":{"type":"string","description":"전시카테고리번호"},"brandNo":{"type":"string","description":"브랜드번호"},"entrNo":{"type":"string","description":"협력사번호"},"chlNo":{"type":"string","description":"채널번호"},"marketingDisplayNo":{"type":"string","description":"기획전번호"}},"description":"상품 리스트"},"GoodsMaxBenefitResponse":{"required":["goodsNo","itmNo","maxBenefitAmt","salePrc"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"salePrc":{"type":"integer","description":"판매가","format":"int64"},"maxBenefitAmt":{"type":"integer","description":"최대할인혜택금액(최대혜택가)","format":"int64"},"promoList":{"type":"array","description":"프로모션 리스트","items":{"$ref":"#/components/schemas/GoodsPromotionInfo"}}}},"GoodsPromotionInfo":{"required":["dcAmt","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명(쿠폰명)"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}},"description":"프로모션 리스트"},"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"}}}} ``` ## 상품별 즉시할인가 조회 > \## 기능설명\ > \* 상품별 사용 가능한 상품즉시할인을 조회합니다.\ > \---\ > \## 상세설명\ > \* 전달 받은 상품별로 할인율이 가장 큰 상품즉시할인을 조회하는 API입니다.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/goodsDirectDiscountList":{"post":{"tags":["프로모션 할인"],"summary":"상품별 즉시할인가 조회","description":"## 기능설명\n* 상품별 사용 가능한 상품즉시할인을 조회합니다.\n---\n## 상세설명\n* 전달 받은 상품별로 할인율이 가장 큰 상품즉시할인을 조회하는 API입니다.\n","operationId":"getGoodsDirectDiscountInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsDirectDiscountRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoodsDirectDiscountInfo"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"GoodsDirectDiscountRequest":{"required":["baseDtm","goodsList"],"type":"object","properties":{"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"goodsList":{"type":"array","description":"상품 리스트","items":{"$ref":"#/components/schemas/DisplayGoodsInfo"}}}},"DisplayGoodsInfo":{"required":["goodsNo","itmNo","salePrc","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"}},"description":"상품 리스트"},"GoodsDirectDiscountInfo":{"required":["dcAmt","dcRateAmt","fixamtFxrtGbCd","goodsNo","itmNo","promoNm","promoNo","salePrc"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"salePrc":{"type":"integer","description":"판매가","format":"int64"},"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구분 코드(MK005)\n 01 : 정액\n , 02 : 정률\n","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인율금액","format":"int64"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}}},"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"}}}} ``` ## 최대 배송비 혜택 조회 > \## 기능설명\ > \* 주문서 쿠폰 목록 조회 API에서 배송비 쿠폰 정보만 조회하는 API입니다.\ > \---\ > \## 상세설명\ > \* 배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.\ > \* 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/getMaxBenefitDeliveryCoupon":{"post":{"tags":["프로모션 할인"],"summary":"최대 배송비 혜택 조회","description":"## 기능설명\n* 주문서 쿠폰 목록 조회 API에서 배송비 쿠폰 정보만 조회하는 API입니다.\n---\n## 상세설명\n* 배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.\n * 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc\n","operationId":"getMaxBenefitDeliveryCoupon","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponPopupRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DlvCouponInfo"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CouponPopupRequest":{"required":["baseDtm","comGbCd","goodsList","mbrGradeCd","mbrNo","stafYn"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"comGbCd":{"type":"string","description":"회사구분코드(ME038)"},"stafYn":{"type":"string","description":"임직원여부"},"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"goodsList":{"type":"array","description":"주문 상품정보","items":{"$ref":"#/components/schemas/CouponPopupGoodsInfo"}},"dlvGrpList":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}},"cpnPopupGbCd":{"type":"string","description":"쿠폰팝업구분코드\n 10 : 주문서\n , 20 : 쿠폰선택팝업\n","enum":["10","20"]}},"description":"쿠폰선택팝업 Request"},"CouponPopupGoodsInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","itmNo","marketingDisplayNo","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"dispCtgNo":{"type":"string","description":"전시카테고리번호"},"brandNo":{"type":"string","description":"브랜드번호"},"entrNo":{"type":"string","description":"협력사번호"},"chlNo":{"type":"string","description":"채널번호"},"marketingDisplayNo":{"type":"string","description":"기획전번호"},"cnt":{"type":"integer","description":"수량","format":"int32"},"goodsNm":{"type":"string","description":"상품명"},"brandNm":{"type":"string","description":"브랜드명"}},"description":"주문 상품정보"},"PromotionDeliGrpValidationRequest":{"required":["deliNo","entrNo"],"type":"object","properties":{"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"},"benefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"선택된 배송비 쿠폰 정보"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"ordCostGbCd":{"type":"string","description":"비용구분코드(OM043)"}},"description":"배송혜택정보","nullable":true},"DlvCouponInfo":{"required":["dlvCpnCnt"],"type":"object","properties":{"dlvCpnCnt":{"type":"integer","description":"사용 가능한 배송비 쿠폰 수","format":"int64"},"dlvGrpInfo":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}}}},"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"}}}} ``` ## 주문서 쿠폰 목록 조회 > \## 기능설명\ > \* 주문서 쿠폰 선택 팝업에서 사용하는 API입니다.\ > \---\ > \## 상세설명\ > \* 쿠폰 선택 팝업 진입 시 사용 가능한 혜택정보를 조회하며, 조회 내용은 아래와 같습니다.\ > \* 임직원 할인 : 상품별로 사용 가능한 임직원 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.\ > \* 상품 즉시 할인 : 상품별로 사용 가능한 상품 즉시 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.\ > \* 상품 단위 혜택 정보 : 상품별로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\ > \* 장바구니 단위 혜택 정보 : 주문서 단위로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\ > \* 회원 보유 쿠폰 정보 : 회원이 보유하고 있는 쿠폰(배송비 쿠폰 제외) 정보를 담고 있습니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\ > \* 배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.\ > \* 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc\ > \* 최대 혜택 정보 : 사용 가능한 혜택 정보들 중 최대 혜택인 할인 정보를 담고 있습니다.\ > \---\ > \## 수정번호\ > \* Release v1.03\_231106: 임직원 할인 한도 관리 추가\ > \* Release v2.00\_240509: 적용대상 - 기획전 정보 조회 추가\ > \* Release v2.00\_241205: 쿠폰에서 설정한 최소구매수량/최소구매금액이 주문한 상품의 개수와 관계없이 무조건 한개 기준으로 체크하고 있었던 것을 수정
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/getCouponPopupData":{"post":{"tags":["프로모션 할인"],"summary":"주문서 쿠폰 목록 조회","description":"## 기능설명\n* 주문서 쿠폰 선택 팝업에서 사용하는 API입니다.\n---\n## 상세설명\n* 쿠폰 선택 팝업 진입 시 사용 가능한 혜택정보를 조회하며, 조회 내용은 아래와 같습니다.\n * 임직원 할인 : 상품별로 사용 가능한 임직원 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.\n * 상품 즉시 할인 : 상품별로 사용 가능한 상품 즉시 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.\n * 상품 단위 혜택 정보 : 상품별로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\n * 장바구니 단위 혜택 정보 : 주문서 단위로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\n * 회원 보유 쿠폰 정보 : 회원이 보유하고 있는 쿠폰(배송비 쿠폰 제외) 정보를 담고 있습니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.\n * 배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.\n * 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc\n * 최대 혜택 정보 : 사용 가능한 혜택 정보들 중 최대 혜택인 할인 정보를 담고 있습니다.\n---\n## 수정번호\n* Release v1.03_231106: 임직원 할인 한도 관리 추가\n* Release v2.00_240509: 적용대상 - 기획전 정보 조회 추가\n* Release v2.00_241205: 쿠폰에서 설정한 최소구매수량/최소구매금액이 주문한 상품의 개수와 관계없이 무조건 한개 기준으로 체크하고 있었던 것을 수정\n","operationId":"getCouponPopupData","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponPopupRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CouponPopupResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CouponPopupRequest":{"required":["baseDtm","comGbCd","goodsList","mbrGradeCd","mbrNo","stafYn"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"comGbCd":{"type":"string","description":"회사구분코드(ME038)"},"stafYn":{"type":"string","description":"임직원여부"},"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"goodsList":{"type":"array","description":"주문 상품정보","items":{"$ref":"#/components/schemas/CouponPopupGoodsInfo"}},"dlvGrpList":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}},"cpnPopupGbCd":{"type":"string","description":"쿠폰팝업구분코드\n 10 : 주문서\n , 20 : 쿠폰선택팝업\n","enum":["10","20"]}},"description":"쿠폰선택팝업 Request"},"CouponPopupGoodsInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","itmNo","marketingDisplayNo","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"dispCtgNo":{"type":"string","description":"전시카테고리번호"},"brandNo":{"type":"string","description":"브랜드번호"},"entrNo":{"type":"string","description":"협력사번호"},"chlNo":{"type":"string","description":"채널번호"},"marketingDisplayNo":{"type":"string","description":"기획전번호"},"cnt":{"type":"integer","description":"수량","format":"int32"},"goodsNm":{"type":"string","description":"상품명"},"brandNm":{"type":"string","description":"브랜드명"}},"description":"주문 상품정보"},"PromotionDeliGrpValidationRequest":{"required":["deliNo","entrNo"],"type":"object","properties":{"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"},"benefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"선택된 배송비 쿠폰 정보"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"ordCostGbCd":{"type":"string","description":"비용구분코드(OM043)"}},"description":"배송혜택정보","nullable":true},"CouponPopupResponse":{"type":"object","properties":{"executivesDiscountInfo":{"$ref":"#/components/schemas/PromotionSelectedInfo"},"goodsDirectDiscountInfo":{"$ref":"#/components/schemas/PromotionSelectedInfo"},"goodsBenefitInfo":{"type":"array","description":"상품 단위 혜택 정보","items":{"$ref":"#/components/schemas/CouponBenefitinfo"}},"basketCouponBenefitinfo":{"type":"array","description":"장바구니 단위 혜택 정보","items":{"$ref":"#/components/schemas/BasketCouponBenefitinfo"}},"promoList":{"type":"array","description":"회원 보유 쿠폰 정보","items":{"$ref":"#/components/schemas/PromotionInfo"}},"dlvCouponInfo":{"$ref":"#/components/schemas/DlvCouponInfo"},"maxBenefitInfo":{"$ref":"#/components/schemas/BenefitResponse"}},"description":"쿠폰선택팝업 Response"},"PromotionSelectedInfo":{"type":"object","properties":{"totalDcAmt":{"type":"integer","description":"전체 할인 금액","format":"int64"},"goodsList":{"type":"array","description":"상품별 할인 금액","items":{"$ref":"#/components/schemas/DiscountGoodsInfo"}}},"description":"선택된 프로모션(할인/마일리지) 정보"},"DiscountGoodsInfo":{"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"brandNm":{"type":"string","description":"브랜드명"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인 금액","format":"int64"},"bnfInfo":{"$ref":"#/components/schemas/OrderPromotionInfo"}},"description":"상품할인 정보"},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"개수별할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"혜택정보리스트"},"CouponBenefitinfo":{"required":["goodsNo","itmNo","promoNoList"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"promoNoList":{"type":"array","items":{"type":"string","description":"사용 가능 혜택번호 리스트"}}},"description":"상품 단위 혜택 정보"},"BasketCouponBenefitinfo":{"required":["goodsList","promoNo"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"goodsList":{"type":"array","description":"사용 가능한 상품 리스트","items":{"$ref":"#/components/schemas/BasketCouponGoodsInfo"}}},"description":"장바구니 단위 혜택 정보"},"BasketCouponGoodsInfo":{"required":["goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"}},"description":"사용 가능한 상품 리스트"},"PromotionInfo":{"required":["baseAmt","couponIssuedInfo","entrChrgRate","fixamtFxrtGbCd","goodsNo","itmNo","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"couponIssuedInfo":{"type":"array","description":"쿠폰 발급 정보 리스트","items":{"$ref":"#/components/schemas/CouponIssuedInfo"}},"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"baseAmt":{"type":"integer","description":"기준금액","format":"int64"}},"description":"회원 보유 쿠폰 정보"},"CouponIssuedInfo":{"required":["cpnIsuDtm","cpnIsuNo","cpnNo","mbrNo","useYn","valiEndDtm","valiStrtDtm"],"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"mbrNo":{"type":"string","description":"회원번호"},"cpnNo":{"type":"string","description":"프로모션번호"},"cpnIsuDtm":{"type":"string","description":"쿠폰발급일시","format":"date-time"},"valiStrtDtm":{"type":"string","description":"유효시작일시","format":"date-time"},"valiEndDtm":{"type":"string","description":"유효종료일시","format":"date-time"},"useYn":{"type":"string","description":"사용여부"}},"description":"쿠폰 발급 정보 리스트"},"DlvCouponInfo":{"required":["dlvCpnCnt"],"type":"object","properties":{"dlvCpnCnt":{"type":"integer","description":"사용 가능한 배송비 쿠폰 수","format":"int64"},"dlvGrpInfo":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}}}},"BenefitResponse":{"required":["goodsBenefitList","orderBenefitList","totalDcAmt"],"type":"object","properties":{"totalDcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"goodsBenefitList":{"type":"array","description":"상품혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/GoodsBenefitResponse"}},"orderBenefitList":{"type":"array","description":"주문혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"}}},"description":"쿠폰혜택조회 Response"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"benefitList":{"type":"array","description":"혜택정보리스트","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"상품혜택정보","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"goods":{"type":"array","description":"상품정보 리스트","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"주문프로모션정보"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}},"description":"상품정보 리스트"},"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"}}}} ``` ## 상담원 주문서 프로모션 목록 조회 > \## 기능 설명\ > \- 상담원이 입력한 주문에서 선택 가능한 프로모션을 조회하는 API입니다.\ > \---\ > \## 상세 설명\ > \- BO 상담원 주문 진행 도중 선택 가능한 프로모션을 조회합니다.\ > \---\ > \## 특이사항\ > \- getCouponPopupData(프로모션 할인) API와 동일 로직입니다.\ > \- 다른점은 파라미터의 회원번호(mbrNo)로 주문을 생성하며, 회원번호는 필수 파라미터입니다.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/getCounselorOrderCouponPopupData":{"post":{"tags":["프로모션 할인"],"summary":"상담원 주문서 프로모션 목록 조회","description":"## 기능 설명\n- 상담원이 입력한 주문에서 선택 가능한 프로모션을 조회하는 API입니다.\n---\n## 상세 설명\n- BO 상담원 주문 진행 도중 선택 가능한 프로모션을 조회합니다.\n---\n## 특이사항\n- getCouponPopupData(프로모션 할인) API와 동일 로직입니다.\n- 다른점은 파라미터의 회원번호(mbrNo)로 주문을 생성하며, 회원번호는 필수 파라미터입니다.\n","operationId":"getCounselorOrderCouponPopupData","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponPopupRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CouponPopupResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CouponPopupRequest":{"required":["baseDtm","comGbCd","goodsList","mbrGradeCd","mbrNo","stafYn"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"comGbCd":{"type":"string","description":"회사구분코드(ME038)"},"stafYn":{"type":"string","description":"임직원여부"},"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"baseDtm":{"type":"string","description":"기준일시","format":"date-time"},"goodsList":{"type":"array","description":"주문 상품정보","items":{"$ref":"#/components/schemas/CouponPopupGoodsInfo"}},"dlvGrpList":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}},"cpnPopupGbCd":{"type":"string","description":"쿠폰팝업구분코드\n 10 : 주문서\n , 20 : 쿠폰선택팝업\n","enum":["10","20"]}},"description":"쿠폰선택팝업 Request"},"CouponPopupGoodsInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","itmNo","marketingDisplayNo","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"salePrc":{"type":"integer","description":"판매가(1차할인)","format":"int64"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"dispCtgNo":{"type":"string","description":"전시카테고리번호"},"brandNo":{"type":"string","description":"브랜드번호"},"entrNo":{"type":"string","description":"협력사번호"},"chlNo":{"type":"string","description":"채널번호"},"marketingDisplayNo":{"type":"string","description":"기획전번호"},"cnt":{"type":"integer","description":"수량","format":"int32"},"goodsNm":{"type":"string","description":"상품명"},"brandNm":{"type":"string","description":"브랜드명"}},"description":"주문 상품정보"},"PromotionDeliGrpValidationRequest":{"required":["deliNo","entrNo"],"type":"object","properties":{"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"},"benefitInfo":{"$ref":"#/components/schemas/DlvBenefitInfo"}},"description":"선택된 배송비 쿠폰 정보"},"DlvBenefitInfo":{"required":["cpnIsuNo","entrChrgRate","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"ordCostGbCd":{"type":"string","description":"비용구분코드(OM043)"}},"description":"배송혜택정보","nullable":true},"CouponPopupResponse":{"type":"object","properties":{"executivesDiscountInfo":{"$ref":"#/components/schemas/PromotionSelectedInfo"},"goodsDirectDiscountInfo":{"$ref":"#/components/schemas/PromotionSelectedInfo"},"goodsBenefitInfo":{"type":"array","description":"상품 단위 혜택 정보","items":{"$ref":"#/components/schemas/CouponBenefitinfo"}},"basketCouponBenefitinfo":{"type":"array","description":"장바구니 단위 혜택 정보","items":{"$ref":"#/components/schemas/BasketCouponBenefitinfo"}},"promoList":{"type":"array","description":"회원 보유 쿠폰 정보","items":{"$ref":"#/components/schemas/PromotionInfo"}},"dlvCouponInfo":{"$ref":"#/components/schemas/DlvCouponInfo"},"maxBenefitInfo":{"$ref":"#/components/schemas/BenefitResponse"}},"description":"쿠폰선택팝업 Response"},"PromotionSelectedInfo":{"type":"object","properties":{"totalDcAmt":{"type":"integer","description":"전체 할인 금액","format":"int64"},"goodsList":{"type":"array","description":"상품별 할인 금액","items":{"$ref":"#/components/schemas/DiscountGoodsInfo"}}},"description":"선택된 프로모션(할인/마일리지) 정보"},"DiscountGoodsInfo":{"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"brandNm":{"type":"string","description":"브랜드명"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인 금액","format":"int64"},"bnfInfo":{"$ref":"#/components/schemas/OrderPromotionInfo"}},"description":"상품할인 정보"},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"개수별할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"혜택정보리스트"},"CouponBenefitinfo":{"required":["goodsNo","itmNo","promoNoList"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"promoNoList":{"type":"array","items":{"type":"string","description":"사용 가능 혜택번호 리스트"}}},"description":"상품 단위 혜택 정보"},"BasketCouponBenefitinfo":{"required":["goodsList","promoNo"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"goodsList":{"type":"array","description":"사용 가능한 상품 리스트","items":{"$ref":"#/components/schemas/BasketCouponGoodsInfo"}}},"description":"장바구니 단위 혜택 정보"},"BasketCouponGoodsInfo":{"required":["goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"}},"description":"사용 가능한 상품 리스트"},"PromotionInfo":{"required":["baseAmt","couponIssuedInfo","entrChrgRate","fixamtFxrtGbCd","goodsNo","itmNo","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"couponIssuedInfo":{"type":"array","description":"쿠폰 발급 정보 리스트","items":{"$ref":"#/components/schemas/CouponIssuedInfo"}},"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"baseAmt":{"type":"integer","description":"기준금액","format":"int64"}},"description":"회원 보유 쿠폰 정보"},"CouponIssuedInfo":{"required":["cpnIsuDtm","cpnIsuNo","cpnNo","mbrNo","useYn","valiEndDtm","valiStrtDtm"],"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"mbrNo":{"type":"string","description":"회원번호"},"cpnNo":{"type":"string","description":"프로모션번호"},"cpnIsuDtm":{"type":"string","description":"쿠폰발급일시","format":"date-time"},"valiStrtDtm":{"type":"string","description":"유효시작일시","format":"date-time"},"valiEndDtm":{"type":"string","description":"유효종료일시","format":"date-time"},"useYn":{"type":"string","description":"사용여부"}},"description":"쿠폰 발급 정보 리스트"},"DlvCouponInfo":{"required":["dlvCpnCnt"],"type":"object","properties":{"dlvCpnCnt":{"type":"integer","description":"사용 가능한 배송비 쿠폰 수","format":"int64"},"dlvGrpInfo":{"type":"array","description":"배송그룹 정보","items":{"$ref":"#/components/schemas/PromotionDeliGrpValidationRequest"}}}},"BenefitResponse":{"required":["goodsBenefitList","orderBenefitList","totalDcAmt"],"type":"object","properties":{"totalDcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"goodsBenefitList":{"type":"array","description":"상품혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/GoodsBenefitResponse"}},"orderBenefitList":{"type":"array","description":"주문혜택정보 리스트","nullable":true,"items":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"}}},"description":"쿠폰혜택조회 Response"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"benefitList":{"type":"array","description":"혜택정보리스트","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"상품혜택정보","nullable":true},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"goods":{"type":"array","description":"상품정보 리스트","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"주문프로모션정보"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}},"description":"상품정보 리스트"},"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"}}}} ``` ## 상담원 주문 적립 정보 조회 > \## 기능설명\ > \* 상담원 주문시 회원의 적립정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* 주문 시점에는 기본적립, 회원 등급 추가적립, 프로모션 적립 3가지가 있습니다.\ > \* 기본 적립 : 별 다른 조건 없이 주문 시 정해진 적립율만큼 적립.\ > \* 회원 등급 추가 적립 : 기준금액을 초과하는 경우 회원의 등급에 맞는 적립율만큼 추가 적립.\ > \* 프로모션 적립 : 상품별로 적용 가능한 상품마일리지의 적립율 만큼 추가 적립. \*\*단, 상품별로 하나의 프로모션 적립만 가능.\*\*
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/getCounselorOrderAccumulationInfo":{"post":{"tags":["프로모션 할인"],"summary":"상담원 주문 적립 정보 조회","description":"## 기능설명\n* 상담원 주문시 회원의 적립정보를 조회합니다.\n---\n## 상세설명\n* 주문 시점에는 기본적립, 회원 등급 추가적립, 프로모션 적립 3가지가 있습니다.\n * 기본 적립 : 별 다른 조건 없이 주문 시 정해진 적립율만큼 적립.\n * 회원 등급 추가 적립 : 기준금액을 초과하는 경우 회원의 등급에 맞는 적립율만큼 추가 적립.\n * 프로모션 적립 : 상품별로 적용 가능한 상품마일리지의 적립율 만큼 추가 적립. **단, 상품별로 하나의 프로모션 적립만 가능.**\n","operationId":"getCounselorOrderAccumulationInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounselorOrderAccmRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccmResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CounselorOrderAccmRequest":{"required":["mbrGradeCd","mbrNo"],"type":"object","properties":{"ordGoodsInfoList":{"type":"array","description":"주문상품정보","items":{"$ref":"#/components/schemas/OrdGoodsInfo"}},"benefitOrderPromotionInfo":{"$ref":"#/components/schemas/BenefitOrderPromotionInfo"},"ordMediaCd":{"type":"string","description":"주문매체 코드(OM007)\n 10 : 전화상담(CC)\n, 20 : PC\n, 30 : 모바일웹\n, 40 : 안드로이드앱\n, 50 : IOS앱\n, 60 : 정기주문\n","enum":["10","20","30","40","50","60"]},"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCd":{"type":"string","description":"회원등급코드"}},"description":"FO 주문서 적립 조회 Request DTO"},"OrdGoodsInfo":{"required":["basketGoods"],"type":"object","properties":{"basketGoods":{"$ref":"#/components/schemas/BasketGoods"},"aplyGoodsBnfInfo":{"$ref":"#/components/schemas/GoodsBenefitResponse"},"aeEvtList":{"type":"array","description":"사은행사정보","nullable":true,"items":{"$ref":"#/components/schemas/AeEvtInfo"}}},"description":"주문상품 DTO"},"BasketGoods":{"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"deliProcTypCd":{"type":"string","description":"PR008(배송처리유형코드)\n 10: CNTR_DLV(센터배송)\n,20: CORP_DLV(업체배송)\n,30: E_COUPON_DLV(e-쿠폰배송)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"배송정책번호"},"deliNo":{"type":"string","description":"배송번호"},"entrNo":{"type":"string","description":"협력사번호"},"ordQty":{"type":"integer","description":"주문수량","format":"int32"},"salePrc":{"type":"integer","description":"판매가","format":"int64"},"dcAmt":{"type":"integer","description":"할인가","format":"int64"},"sysModDtm":{"type":"string","description":"시스템수정시간","format":"date-time"},"itmNo":{"type":"string","description":"단품번호"},"bsketNo":{"type":"integer","description":"장바구니번호","format":"int64"},"chlNo":{"type":"string","description":"채널번호"},"chlDtlNo":{"type":"string","description":"채널상세번호"},"infDispCtgNoGbCd":{"type":"string","description":"유입전시카테고리번호구분코드(OM041)"},"infDispCtgNo":{"type":"string","description":"유입전시카테고리번호"},"repDispCtgNo":{"type":"string","description":"대표전시카테고리번호"},"conrNo":{"type":"string","description":"코너번호"},"bsketQty":{"type":"integer","description":"장바구니 수량","format":"int32"},"goodsNm":{"type":"string","description":"상품명"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"goodsCompCd":{"type":"string","description":"상품구성코드(PR001)"},"goodsTypCd":{"type":"string","description":"상품유형코드(PR002)"},"saleMethCd":{"type":"string","description":"판매방식코드(PR003)"},"brandNo":{"type":"string","description":"브랜드번호"},"brandNm":{"type":"string","description":"브랜드명"},"buyrAgeLmtCd":{"type":"string","description":"구매연령제한코드"},"dispYn":{"type":"string","description":"전시여부"},"saleStatCd":{"type":"string","description":"판매상태코드(PR005)"},"saleStrDtm":{"type":"string","description":"판매시작일시","format":"date-time"},"saleEndDtm":{"type":"string","description":"판매종료일시","format":"date-time"},"buyTypCd":{"type":"string","description":"매입유형코드(PR006)"},"taxGbCd":{"type":"string","description":"과면세구분코드(PR007)"},"stkMgrYn":{"type":"string","description":"재고관리여부"},"buyQtyLmtYn":{"type":"string","description":"구매수량제한여부"},"minLmtQty":{"type":"integer","description":"최소제한수량","format":"int32"},"maxLmtQty":{"type":"integer","description":"최대제한수량","format":"int32"},"safeStkNotiYn":{"type":"string","description":"안전재고알림여부"},"deliGoodsGbCd":{"type":"string","description":"배송상품구분코드(PR010)"},"deliWayCd":{"type":"string","description":"배송수단코드(PR009)"},"deliPsbRgnCd":{"type":"string","description":"배송가능지역코드(PR030)"},"deliDday":{"type":"integer","description":"배송기일","format":"int64"},"bpckPsbYn":{"type":"string","description":"합포장가능여부"},"rtnPsbYn":{"type":"string","description":"반품가능여부"},"exchPsbYn":{"type":"string","description":"교환가능여부"},"supPcost":{"type":"integer","description":"공급원가","format":"int64"},"norPrc":{"type":"integer","description":"정상가","format":"int64"},"preSalePrc":{"type":"integer","description":"종전판매가","format":"int64"},"mrgnRate":{"type":"number","description":"마진율","format":"double"},"payMeanInfo":{"type":"string","description":"결제수단"},"itmNm":{"type":"string","description":"단품명"},"stkQty":{"type":"integer","description":"단품수량","format":"int64"},"prestNm":{"type":"string","description":"증정품명"},"rsvStrtDtm":{"type":"string","description":"예약시작일시","format":"date-time"},"rsvEndDtm":{"type":"string","description":"예약종료일시","format":"date-time"},"fwdidcPrarDy":{"type":"string","description":"출고지시예정일자","format":"date"},"hsCd":{"type":"string","description":"품목분류코드"},"wishYn":{"type":"string","description":"위시리스트 여부"},"maxDcAmt":{"type":"integer","description":"최대혜택금액","format":"int64"},"goodsImg":{"type":"string","description":"상품이미지"},"itmSaleStatCd":{"type":"string","description":"단품판매상태코드(PR005)"},"gvgfPsbYn":{"type":"string","description":"선물하기가능여부"},"rglrDeliGoodsYn":{"type":"string","description":"정기배송상품여부"},"sngGoodsYn":{"type":"string","description":"단일상품여부"},"marketingDisplayNo":{"type":"string","description":"기획전번호"},"entrGoodsNo":{"type":"string","description":"협력사상품번호"},"entrItmNo":{"type":"string","description":"협력사단품번호"},"ordCnclPsbYn":{"type":"string","description":"주문취소가능여부"},"wthdYn":{"type":"string","description":"회수여부"},"frgnDirPurGoodsYn":{"type":"string","description":"해외직구상품여부"}},"description":"장바구니 상품 DTO"},"GoodsBenefitResponse":{"required":["benefitList","dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"전체할인금액","format":"int64"},"benefitList":{"type":"array","description":"혜택정보리스트","items":{"$ref":"#/components/schemas/OrderPromotionInfo"}}},"description":"상품혜택정보","nullable":true},"OrderPromotionInfo":{"required":["dcAmt","dcAmtPerCnt","entrChrgRate","fixamtFxrtGbCd","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"dcAmtPerCnt":{"type":"integer","description":"개수별할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"혜택정보리스트"},"AeEvtInfo":{"required":["addEvtTypCd","aeDesc","aeEndDtm","aeGoodsList","aeNm","aeNo","aeStrDtm","goodsNo","itmNo","tmEvtYn"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"aeNo":{"type":"string","description":"사은행사번호"},"addEvtTypCd":{"type":"string","description":"사은행사 유형 코드(MK012)\n 10 : 구매금액사은품\n , 20 : 상품사은품\n","enum":["10","20"]},"aeStrDtm":{"type":"string","description":"사은행사시작일시","format":"date-time"},"aeEndDtm":{"type":"string","description":"사은행사종료일시","format":"date-time"},"payStrDt":{"type":"string","description":"지급시작일자"},"payEndDt":{"type":"string","description":"지급종료일자"},"tmEvtYn":{"type":"string","description":"타임행사여부","nullable":true},"aplyStrTm":{"type":"string","description":"적용시작시간","nullable":true},"aplyEndTm":{"type":"string","description":"적용종료시간","nullable":true},"aeDesc":{"type":"string","description":"사은행사설명"},"aeNm":{"type":"string","description":"사은행사명"},"aeGoodsList":{"type":"array","description":"사은품리스트","items":{"$ref":"#/components/schemas/AeFvrInfo"}}},"description":"사은행사정보","nullable":true},"AeFvrInfo":{"required":["aeFvrSeq","aeGoodsNm","aeGoodsNo","aplyMaxAmt","aplyMinAmt"],"type":"object","properties":{"aeFvrSeq":{"type":"string","description":"사은행사순번"},"aplyMinAmt":{"type":"integer","description":"적용최소금액","format":"int64"},"aplyMaxAmt":{"type":"integer","description":"적용최대금액","format":"int64"},"aeGoodsNm":{"type":"string","description":"사은품상품명"},"aeGoodsNo":{"type":"string","description":"사은품상품번호"},"aeGoodsItmNo":{"type":"string","description":"사은품단품번호"},"aeGoodsImgPath":{"type":"string","description":"사은품이미지경로"}},"description":"사은품리스트"},"BenefitOrderPromotionInfo":{"required":["dcAmt","entrChrgRate","fixamtFxrtGbCd","goods","ourChrgRate","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인률/금액","format":"int64"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"isMaxYn":{"type":"string","description":"최대혜택여부"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"goods":{"type":"array","description":"상품정보 리스트","items":{"$ref":"#/components/schemas/OrderBenefitGoodsInfo"}}},"description":"주문프로모션정보"},"OrderBenefitGoodsInfo":{"required":["dcAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"dcAmt":{"type":"integer","description":"할인금액","format":"int64"}},"description":"상품정보 리스트"},"AccmResponse":{"required":["accmList","totalAccmAmt"],"type":"object","properties":{"totalAccmAmt":{"type":"integer","description":"전체적립금액","format":"int64"},"accmList":{"type":"array","description":"적립 정보 리스트","items":{"$ref":"#/components/schemas/AccmPromotionInfo"}}},"description":"적립정보","nullable":true},"AccmPromotionInfo":{"required":["accmAmt","accmGbCd","accmRate","fixamtFxrtGbCd","promoNm","promoNo"],"type":"object","properties":{"accmGbCd":{"type":"string","description":"자산적립사용사유코드(ME020)\n 21 : 주문적립\n , 22 : 회원등급적립\n , 23 : 예약상품적립\n , 24 : 프로모션적립\n , 50 : 주문사용\n , 58 : 배송비사용\n , 29 : 환불적립\n","enum":["21","22","23","24","50","58","29"]},"accmRate":{"type":"number","description":"적립율","format":"double"},"accmAmt":{"type":"integer","description":"적립금액","format":"int64"},"promoNo":{"type":"string","description":"프로모션 번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션유형","nullable":true,"enum":["40"]},"ourChrgRate":{"type":"integer","description":"자사분담률","format":"int32"},"entrChrgRate":{"type":"integer","description":"협력사분담률","format":"int32"},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드"},"rsrvStdAmt":{"type":"integer","description":"적립기준금액","format":"int64"},"goodsAccmList":{"type":"array","description":"상품적립정보 리스트","items":{"$ref":"#/components/schemas/AccmInfo"}}},"description":"적립 정보 리스트"},"AccmInfo":{"required":["accmAmt","goodsNo","itmNo"],"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"accmAmt":{"type":"integer","description":"적립금액","format":"int64"}},"description":"상품적립정보 리스트"},"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"}}}} ``` ## 주문서 쿠폰 사용 처리 > \## 기능설명\ > \* 주문에서 선택한 쿠폰들을 사용처리합니다.\ > \---\ > \## 상세설명\ > \* \*\*비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.\*\*\ > \* 주문에서 선택한 쿠폰들을 사용처리합니다.\ > \* 아래 조건에 부합하는 쿠폰만 사용이 가능합니다.\ > \* 쿠폰 기간 : 유효\ > \* 사용여부 : 미사용
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnUse":{"post":{"tags":["프로모션 할인"],"summary":"주문서 쿠폰 사용 처리","description":"## 기능설명\n* 주문에서 선택한 쿠폰들을 사용처리합니다.\n---\n## 상세설명\n* **비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.**\n* 주문에서 선택한 쿠폰들을 사용처리합니다.\n* 아래 조건에 부합하는 쿠폰만 사용이 가능합니다.\n * 쿠폰 기간 : 유효\n * 사용여부 : 미사용\n","operationId":"useCpn","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnUseRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CpnUseRequest":{"required":["mbrNo","ordNo"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"ordNo":{"type":"string","description":"주문번호"},"cpnInfo":{"type":"array","description":"쿠폰 리스트","items":{"$ref":"#/components/schemas/CpnUseInfo"}},"cpnIsuNoList":{"type":"array","items":{"type":"string"}}},"description":"사용 쿠폰정보 요청 DTO"},"CpnUseInfo":{"required":["cpnIsuNo"],"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"사용 쿠폰정보 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"}}}} ``` ## 쿠폰 취소/복원 > \## 기능설명\ > \* 쿠폰을 취소/복원합니다.\ > \---\ > \## 상세설명\ > \* 주문서\ > \* \*\*복원구분코드\*\*가 10일 경우\ > \* 기존의 쿠폰 발급 정보에서 사용 관련 정보 제거합니다.\ > \* 클레임/기타\ > \* \*\*복원구분코드\*\*가 20(클레임) 이거나 99(기타) 일 경우\ > \* 기존의 발급된 정보를 이용해 새로운 쿠폰 발급합니다.\ > \* 쿠폰번호, 원쿠폰발급번호, 회원알림여부, 회원번호\ > \* 발급된 쿠폰의 유효기간이 지났다면, 현재 일자에서 \*\*ST001 의 쿠폰복원유효일수\*\* 만큼 유효한 쿠폰을 재발급합니다.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnCancel":{"post":{"tags":["프로모션 할인"],"summary":"쿠폰 취소/복원","description":"## 기능설명\n* 쿠폰을 취소/복원합니다.\n---\n## 상세설명\n* 주문서\n * **복원구분코드**가 10일 경우\n * 기존의 쿠폰 발급 정보에서 사용 관련 정보 제거합니다.\n* 클레임/기타\n * **복원구분코드**가 20(클레임) 이거나 99(기타) 일 경우\n * 기존의 발급된 정보를 이용해 새로운 쿠폰 발급합니다.\n * 쿠폰번호, 원쿠폰발급번호, 회원알림여부, 회원번호\n * 발급된 쿠폰의 유효기간이 지났다면, 현재 일자에서 **ST001 의 쿠폰복원유효일수** 만큼 유효한 쿠폰을 재발급합니다.\n","operationId":"cnclCpn","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnCnclRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CpnCnclRequest":{"required":["mbrNo","ordNo","restoreGbCd"],"type":"object","properties":{"mbrNo":{"type":"string","description":"회원번호"},"ordNo":{"type":"string","description":"주문번호"},"restoreGbCd":{"type":"string","description":"쿠폰복원유형\n 10 : 주문서\n, 20 : 클레임\n, 99 : 기타\n","enum":["10","20","99"]},"cpnInfo":{"type":"array","description":"쿠폰 리스트","items":{"$ref":"#/components/schemas/CpnCnclInfo"}},"cpnIsuNoList":{"type":"array","items":{"type":"string"}}},"description":"복원 쿠폰정보 요청 DTO"},"CpnCnclInfo":{"required":["cpnIsuNo"],"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"}},"description":"복원 쿠폰정보 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"}}}} ``` ## 회원별 쿠폰 건수 조회 > \## 기능설명\ > \* BO API 에서 회원의 쿠폰과 배송 관련 쿠폰의 개수를 조회합니다.\ > \---\ > \## 상세설명\ > \* 회원이 보유하고 있는 쿠폰들 중 미사용이면서 기간이 유효한 쿠폰의 개수를 조회합니다.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/mbrCpnCnt":{"get":{"tags":["프로모션 할인"],"summary":"회원별 쿠폰 건수 조회","description":"## 기능설명\n* BO API 에서 회원의 쿠폰과 배송 관련 쿠폰의 개수를 조회합니다.\n---\n## 상세설명\n* 회원이 보유하고 있는 쿠폰들 중 미사용이면서 기간이 유효한 쿠폰의 개수를 조회합니다.\n","operationId":"getMbrCpnCnt","parameters":[{"name":"mbrNo","in":"query","description":"회원번호","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MbrCpnCntResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"MbrCpnCntResponse":{"type":"object","properties":{"dlvCnt":{"type":"integer","description":"무료배송쿠폰수량","format":"int32"},"cpnCnt":{"type":"integer","description":"일반쿠폰수량","format":"int32"}},"description":"회원이 보유한 쿠폰 수량"},"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"}}}} ``` ## 쿠폰 기본 정보 조회 > \## 기능설명\ > \* 전달받은 프로모션 번호의 기본 정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* 전달받은 프로모션 번호들로 현재 진행중인 프로모션의 기본 정보를 조회합니다.\ > \## 수정번호\ > \* Release v2.00\_240401: 이벤트 쿠폰 조회 적용가능매체 추가
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnInfoList":{"get":{"tags":["프로모션 할인"],"summary":"쿠폰 기본 정보 조회","description":"## 기능설명\n* 전달받은 프로모션 번호의 기본 정보를 조회합니다.\n---\n## 상세설명\n* 전달받은 프로모션 번호들로 현재 진행중인 프로모션의 기본 정보를 조회합니다.\n## 수정번호\n* Release v2.00_240401: 이벤트 쿠폰 조회 적용가능매체 추가\n","operationId":"getCouponInfo","parameters":[{"name":"promoNoList","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","description":"프로모션번호 리스트"}}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponInfoResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CouponInfoResponse":{"required":["aplyTermGbCd","appOnly","dcRateAmt","fixamtFxrtGbCd","maxDcAmt","minBuyAmt","minBuyQty","promoNo","promoStatCd","promoTypCd","valiEndDtm","valiStrtDtm"],"type":"object","properties":{"promoNo":{"type":"string","description":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션 유형 코드(MK002)\n 11 : 상품할인쿠폰\n , 12 : 장바구니쿠폰\n , 13 : 중복할인쿠폰\n , 14 : 무료배송쿠폰\n , 15 : 무료반품쿠폰\n , 20 : 임직원할인\n , 21 : 상품즉시할인\n , 40 : 상품마일리지\n","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"프로모션상태코드(MK003)\n 10 : 진행\n, 20 : 중단\n","enum":["10","20"]},"promoDesc":{"type":"string","description":"프로모션설명"},"aplyTermGbCd":{"type":"string","description":"적용기간구분코드 코드(MK015)\n 01 : 기간기준\n , 02 : 발급일기준\n","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","description":"발급일기준쿠폰사용일수","format":"int32"},"valiStrtDtm":{"type":"string","description":"유효시작일시","format":"date-time"},"valiEndDtm":{"type":"string","description":"유효종료일시","format":"date-time"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구분 코드(MK005)\n 01 : 정액\n , 02 : 정률\n","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"할인율금액","format":"int64"},"appOnly":{"type":"boolean","description":"앱전용여부"},"minBuyQty":{"type":"integer","description":"최소구매수량","format":"int32"},"minBuyAmt":{"type":"integer","description":"최소구매금액","format":"int64"},"maxDcAmt":{"type":"integer","description":"최대할인금액","format":"int64"},"mediaCdNmArray":{"type":"string","description":"적용가능매체"}}},"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"}}}} ```