> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/claim-bo-api/undefined-4.md). # 클레임 공통 ## 변경 가능 단품 목록 조회 > \## 기능설명\ > \* 변경 가능 단품 목록 조회\ > \
\ > \
\ > \---\ > \## 상세내용\ > \* 주문/교환 대상 상품의 단품 변경 시 변경 가능한 단품 목록 제공\ > \* 상품 API 호출 ( API URL : \*\*/api/goods/v1/detail/otherItms\*\* )
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimItmOtherInfoRequest":{"type":"object","description":"주문 변경 단품 목록 조회 요청 DTO","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"array","description":"단품번호목록","items":{"type":"string"}},"stkQty":{"type":"integer","format":"int64","description":"재고수량"}}},"ClaimItmOtherInfoListResponse":{"type":"object","description":"주문 변경 단품 목록 조회 DTO","properties":{"goodsNo":{"type":"string","description":"상품번호"},"reqIteNo":{"type":"string","description":"변경할단품번호"},"itmNos":{"type":"array","description":"단품번호목록","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoResponse"}}}},"ClaimItmOtherInfoResponse":{"type":"object","properties":{"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"stkQty":{"type":"integer","format":"int64","description":"남은수량"},"supPcost":{"type":"number","description":"공급가"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"tsalePrc":{"type":"number","description":"최종판매가"},"tsupPrc":{"type":"number","description":"최종공급원가"}}}}},"paths":{"/v1/claim/claimCommon/itmListOtherInfo":{"post":{"tags":["클레임 공통"],"summary":"변경 가능 단품 목록 조회","description":"## 기능설명\n* 변경 가능 단품 목록 조회\n
\n
\n---\n## 상세내용\n* 주문/교환 대상 상품의 단품 변경 시 변경 가능한 단품 목록 제공\n* 상품 API 호출 ( API URL : **/api/goods/v1/detail/otherItms** )\n","operationId":"itmListOtherInfo","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoRequest"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoListResponse"}}}}}}}}}} ``` ## 배송 번호 채번 목록 조회 > \## 기능설명\ > \* 배송 번호 채번 목록 조회\ > \---\ > \## 상세내용\ > \* 요청 데이터의 배송번호 리스트(dlvpList)길이 만큼 신규 배송번호 채번\ > \* 결과 데이터로 채번한 배송번호 목록 전달\ > \* 배송 번호 채번 리스트 조회 API 호출 ( API URL : \*\*/api/order/v1/claim/common/getNewNumberedDeliNo\*\* )
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimDeliNoRequest":{"type":"object","description":"클레임 배송번호 요청 DTO","properties":{"dlvpList":{"type":"array","description":"배송번호 리스트","items":{"type":"string"}}}}}},"paths":{"/v1/claim/claimCommon/getNewNumberedDeliNo":{"post":{"tags":["클레임 공통"],"summary":"배송 번호 채번 목록 조회","description":"## 기능설명\n* 배송 번호 채번 목록 조회\n---\n## 상세내용\n* 요청 데이터의 배송번호 리스트(dlvpList)길이 만큼 신규 배송번호 채번\n* 결과 데이터로 채번한 배송번호 목록 전달\n* 배송 번호 채번 리스트 조회 API 호출 ( API URL : **/api/order/v1/claim/common/getNewNumberedDeliNo** )\n","operationId":"getNewNumberedDeliNo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDeliNoRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}} ``` ## 클레임 상세 내역 조회 > \## 기능설명\ > \* 클레임 상세 내역을 조회\ > \
\ > \
\ > \---\ > \## 상세내용\ > \* 요청 주문번호, 클레임번호에 해당하는 클레임 상세 내역 제공\ > \* 주문 내역 정보, 클레임 상품 정보, 환불/결제 내역, 환불예정쿠폰, 배송지정보 제공\ > \* 클레임 상세 내역 조회 API 호출 ( API URL : \*\*/api/order/v1/claim/common/claimDetailsInfo\*\* )
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimDetailsInfoRequest":{"type":"object","description":"클레임 상세 내역 조회 요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"claimNo":{"type":"string","description":"클레임번호"},"claimBusinessType":{"type":"string","description":"클레임 업무 유형","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimDetailsInfoResponse":{"type":"object","description":"클레임 상세 내역 조회 응답 DTO","properties":{"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"추가결제/환불금액 정보"}}},"ClaimFinalAmtInfo":{"type":"object","description":"클레임 최종 결제/환불금액 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"totAplyAdtnAmt":{"type":"integer","format":"int64","description":"총발생배송비금액"},"totCnclAdtnAmt":{"type":"integer","format":"int64","description":"총취소배송비금액"},"totFvrAdtnAmt":{"type":"integer","format":"int64","description":"총혜택배송비금액"},"totOrdPrc":{"type":"integer","format":"int64","description":"클레임상품금액"},"totDcAmt":{"type":"integer","format":"int64","description":"클레임취소할인금액"},"expectedRefundAmt":{"type":"integer","format":"int64","description":"환불예정금액"},"addtionPayAmt":{"type":"integer","format":"int64","description":"추가결제금액"},"returnAcceptAmt":{"type":"integer","format":"int64","description":"반품접수금액"},"refundAdditionAmtInfoList":{"type":"array","description":"추가결제/환불정보 리스트","items":{"$ref":"#/components/schemas/RefundAdditionAmtInfo"}},"refundPaymentMethodList":{"type":"array","description":"환불결제정보 리스트","items":{"$ref":"#/components/schemas/PaymentClaimResponse"}},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse","description":"환불 계좌정보"}}},"RefundAdditionAmtInfo":{"type":"object","description":"추가결제/환불정보 DTO","properties":{"adtnOcurGbCd":{"type":"string","description":"부가비용발생구분코드(OM017)"},"adtnOcurGbNm":{"type":"string","description":"부가비용발생구분명"},"type":{"type":"string","description":"유형구분","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE"]},"typeNm":{"type":"string","description":"유형구분명"},"goodsNoItmNo":{"type":"string","description":"상품번호+단품번호"},"goodsNm":{"type":"string","description":"상품명"},"ordAmt":{"type":"number","description":"결제금액"},"discountMethod":{"type":"string","description":"혜택상세정보(OM019)"},"discountMethodNm":{"type":"string","description":"혜택상세정보명"},"cnclDcAmt":{"type":"integer","format":"int64","description":"취소혜택금액"},"rtnDlvBenefitInfoList":{"type":"array","description":"반품쿠폰정보 리스트","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}}}},"ClaimDlvBenefitInfo":{"type":"object","description":"클레임 쿠폰정보 DTO","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형(MK002)"},"ourChrgRate":{"type":"integer","format":"int32","description":"당사분담율"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사분담율"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"aplyYn":{"type":"string","description":"적용여부","enum":["Y","N"]}}},"PaymentClaimResponse":{"type":"object","description":"환불가능한 결제수단 DTO","properties":{"payNo":{"type":"string","description":"결제번호"},"ordNo":{"type":"string","description":"주문번호"},"claimNo":{"type":"string","description":"클레임번호"},"uprPayNo":{"type":"string","description":"상위결제번호"},"payGbCd":{"type":"string","description":"결제구분코드(OM012)"},"payGbCdNm":{"type":"string","description":"결제구분코드명(OM012)"},"payWayCd":{"type":"string","description":"결제수단코드(OM013)"},"payWayCdNm":{"type":"string","description":"결제수단코드명(OM013)"},"payStatCd":{"type":"string","description":"결제상태코드(OM014)"},"payStatCdNm":{"type":"string","description":"결제상태코드명(OM014)"},"payAmt":{"type":"number","description":"결제금액"},"rfdPsbAmt":{"type":"number","description":"환불가능금액"},"rfdAmt":{"type":"number","description":"환불금액"},"payFnshDtm":{"type":"string","format":"date-time","description":"결제완료일시"},"trdNo":{"type":"string","description":"거래번호(tid)"},"trdDtm":{"type":"string","format":"date-time","description":"거래일시"},"iscmCd":{"type":"string","description":"발급사코드(OM027)"},"iscmCdNm":{"type":"string","description":"발급사코드명(OM027)"},"payReqCardcoCd":{"type":"string","description":"결제요청카드사코드(OM057)"},"payReqCardcoCdNm":{"type":"string","description":"결제요청카드사코드명(OM057)"},"cardNo":{"type":"string","description":"카드번호"},"cardNm":{"type":"string","description":"카드명"},"cardValiTerm":{"type":"string","description":"카드유효기간"},"nintDivYn":{"type":"string","description":"무이자할부여부"},"divMonCnt":{"type":"integer","format":"int32","description":"할부개월수"},"cardPointUseYn":{"type":"string","description":"카드포인트사용여부"},"mersNo":{"type":"string","description":"가맹점번호"},"acqrCd":{"type":"string","description":"매입사코드(OM028)"},"acqrCdNm":{"type":"string","description":"매입사코드명(OM028)"},"aprvNo":{"type":"string","description":"승인번호"},"aprvDtm":{"type":"string","format":"date-time","description":"승인일시"},"sctnCnclPsbYn":{"type":"string","description":"부분취소가능여부"},"bankCd":{"type":"string","description":"은행코드(OM026)"},"bankCdNm":{"type":"string","description":"은행코드명(OM026)"},"actnNo":{"type":"string","description":"계좌번호"},"dpmnNm":{"type":"string","description":"입금자명"},"dptFcstDt":{"type":"string","description":"입금예정일자"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"입금확인일시"},"rfdBankCd":{"type":"string","description":"환불은행코드(OM026)"},"rfdBankCdNm":{"type":"string","description":"환불은행코드명(OM026)"},"rfdActnNo":{"type":"string","description":"환불계좌번호"},"rfdActnDepositorNm":{"type":"string","description":"환불계좌 예금주명"}}},"RfdInfoResponse":{"type":"object","description":"환불 계좌정보 조회 Response","properties":{"rfdBankCd":{"type":"string","description":"은행코드 (OM026)"},"rfdBankNm":{"type":"string","description":"은행명"},"rfdActnNo":{"type":"string","description":"환불계좌번호"},"rfdActnDepositorNm":{"type":"string","description":"환불 계좌 예금주명"},"rfdActnCertiYn":{"type":"string","description":"환불 계좌 인증여부"}}}}},"paths":{"/v1/claim/claimCommon/claimDetailsInfo":{"post":{"tags":["클레임 공통"],"summary":"클레임 상세 내역 조회","description":"## 기능설명\n* 클레임 상세 내역을 조회\n
\n
\n---\n## 상세내용\n* 요청 주문번호, 클레임번호에 해당하는 클레임 상세 내역 제공\n* 주문 내역 정보, 클레임 상품 정보, 환불/결제 내역, 환불예정쿠폰, 배송지정보 제공\n* 클레임 상세 내역 조회 API 호출 ( API URL : **/api/order/v1/claim/common/claimDetailsInfo** )\n","operationId":"claimDetailsInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDetailsInfoRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimDetailsInfoResponse"}}}}}}}}} ``` ## 클레임 비용 계산 조회 > \## 기능설명\ > \* 클레임 비용 계산 조회\ > \
\ > \
\ > \---\ > \## 상세내용\ > \* 클레임 업무 별 화면 추가 결제/환불 금액 정보 및 환불수단 정보 제공\ > \* 클레임 업무 처리 시 DB 기준 부가비용, 혜택정보 추가결제/환불 예정 데이터 생성 정보 및 쿠폰 사용/복원 정보 제공\ > \* BO 클레임 비용 계산 조회 API 호출 ( API URL : \*\*/api/order/v1/claim/common/claimCalculateCost\*\* )
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimCalculateRequest":{"type":"object","description":"클레임 비용 계산 조회 요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1},"orgClmNo":{"type":"string","description":"현재 클레임 번호"},"newNumberedclmNo":{"type":"string","description":"새로 채번된 클레임 번호"},"claimBusinessType":{"type":"string","description":"클레임 업무 유형","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"],"minLength":1},"systemType":{"type":"string","description":"시스템유형","enum":["FO","BO"],"minLength":1},"claimCalculateWorkType":{"type":"string","description":"클레임 혜택/비용 처리 업무 유형","enum":["VIEW_SEARCH","CLAIM_PROCESS"],"minLength":1},"deliMethodCd":{"type":"string","description":"배송방법코드(LO010)","minLength":1},"selectedRtnDlvBenefitYn":{"type":"string","description":"반품무료쿠폰 화면선택여부","enum":["Y","N"]},"dlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp","description":"배송지정보"},"withdrawalInfo":{"$ref":"#/components/schemas/ClaimDlvp","description":"회수지정보"},"rtnDlvBenefitInfo":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo","description":"반품무료쿠폰정보"},"claimGoodsList":{"type":"array","description":"클레임 대상 상품정보 리스트","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"customerCauseFault":{"type":"boolean"}},"required":["claimBusinessType","claimCalculateWorkType","deliMethodCd","ordMediaCd","ordNo","systemType"]},"ClaimDlvp":{"type":"object","description":"클레임 배송 정보 DTO","properties":{"mbrOrdDlvpGb":{"type":"string","description":"회원주문배송지구분","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"배송지순번"},"zipNoSeq":{"type":"integer","format":"int64","description":"우편번호 순번"},"dlvpNm":{"type":"string","description":"배송지명","minLength":1},"rcvmnNm":{"type":"string","description":"수취인명","minLength":1},"zipNo":{"type":"string","description":"우편번호","minLength":1},"zipAddr":{"type":"string","description":"우편주소","minLength":1},"dtlAddr":{"type":"string","description":"상세주소","minLength":1},"rcvmnEmailAddr":{"type":"string","description":"수취인이메일주소"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnTelRgnNo":{"type":"string","description":"수취인전화지역번호"},"rcvmnTelTxnoNo":{"type":"string","description":"수취인전화국번번호"},"rcvmnTelEndNo":{"type":"string","description":"수취인전화끝번호"},"deliMsg":{"type":"string","description":"배송메시지"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039)"},"shopTrafMsg":{"type":"string","description":"매장전달메시지"},"comnFrdrCogoMethodCd":{"type":"string","description":"공동현관출입방법코드(ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"공동현관기타방법"},"comnFrdrPwd":{"type":"string","description":"공동현관비밀번호"}},"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"]},"ClaimDlvBenefitInfo":{"type":"object","description":"클레임 쿠폰정보 DTO","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형(MK002)"},"ourChrgRate":{"type":"integer","format":"int32","description":"당사분담율"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사분담율"},"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"aplyYn":{"type":"string","description":"적용여부","enum":["Y","N"]}}},"ClaimTargetGoodsResponse":{"type":"object","description":"클레임 처리대상 상품 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"uprOrdProcSeq":{"type":"integer","format":"int32","description":"상위주문처리순번"},"maxOrdProcSeq":{"type":"integer","format":"int32","description":"최대주문처리순번"},"claimNo":{"type":"string","description":"클레임번호"},"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드(OM003)"},"ordDtlGbCdNm":{"type":"string","description":"주문내역구분코드명"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliGbCd":{"type":"string","description":"배송구분코드(LO001)"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"ordQty":{"type":"integer","format":"int32","description":"주문수량"},"cnclQty":{"type":"integer","format":"int32","description":"취소수량"},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"},"claimQty":{"type":"integer","format":"int32","description":"클레임수량"},"claimPossibleQty":{"type":"integer","format":"int32","description":"클레임가능수량"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"deliIndiRsvDtm":{"type":"string","format":"date-time","description":"배송지시예약일시"},"exchMidRtnYn":{"type":"string","description":"교환중반품여부","enum":["Y","N"]},"rtnPsbYn":{"type":"string","description":"반품가능여부","enum":["Y","N"]},"exchPsbYn":{"type":"string","description":"교환가능여부","enum":["Y","N"]},"ordCnclPsbYn":{"type":"string","description":"취소가능여부","enum":["Y","N"]},"wthdYn":{"type":"string","description":"회수여부","enum":["Y","N"]},"ecpnNo":{"type":"string","description":"e쿠폰번호"},"etcktNo":{"type":"string","description":"e티켓번호"},"claimLgrpCd":{"type":"string","description":"클레임대분류코드(OM047)","minLength":1},"claimLgrpCdNm":{"type":"string","description":"클레임대분류코드명"},"claimMgrpCd":{"type":"string","description":"클레임중분류코드(OM006)","minLength":1},"claimMgrpCdNm":{"type":"string","description":"클레임중분류코드명"},"claimCausEtcCont":{"type":"string","description":"클레임사유기타내용"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"chlNo":{"type":"string","description":"채널번호"},"chlDtlNo":{"type":"string","description":"채널상세번호"},"stdCtgNo":{"type":"string","description":"표준카테고리번호"},"infDispCtgNoGbCd":{"type":"string","description":"유입전시카테고리번호구분코드(OM041)"},"infDispCtgNo":{"type":"string","description":"유입전시카테고리번호"},"repDispCtgNo":{"type":"string","description":"대표전시카테고리번호"},"conrNo":{"type":"string","description":"코너번호"},"brandNo":{"type":"string","description":"브랜드번호"},"brandNm":{"type":"string","description":"브랜드명"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"goodsCompCd":{"type":"string","description":"상품구성코드(PR001)"},"goodsTypCd":{"type":"string","description":"상품유형코드(PR002)"},"saleMethCd":{"type":"string","description":"판매방식코드(PR003)"},"taxGbCd":{"type":"string","description":"과면세구분코드(PR007)"},"buyTypCd":{"type":"string","description":"매입유형코드(PR006)"},"supPcost":{"type":"number","description":"공급원가"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"preSalePrc":{"type":"number","description":"할인기준가"},"mrgnRate":{"type":"number","description":"마진율"},"entrNo":{"type":"string","description":"협력사번호"},"deliPolcNo":{"type":"string","description":"배송정책번호"},"deliDday":{"type":"integer","format":"int64","description":"배송기일"},"deliGoodsGbCd":{"type":"string","description":"배송상품구분코드(PR010)"},"deliWayCd":{"type":"string","description":"배송상품구분코드(PR009)"},"bpckPsbYn":{"type":"string","description":"합포장가능여부","enum":["Y","N"]},"hsCd":{"type":"string","description":"HS코드"},"goodsRevWrtYn":{"type":"string","description":"상품리뷰작성여부","enum":["Y","N"]},"bnfAmt":{"type":"number","description":"혜택금액"},"ordPrc":{"type":"number","description":"주문금액"},"aeGoodsYn":{"type":"string","description":"사은품여부","enum":["Y","N"]},"deliNo":{"type":"string","description":"배송번호"},"deliMethodCd":{"type":"string","description":"배송방법코드(LO010)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"deliFnshDtm":{"type":"string","format":"date-time","description":"배송완료일시"},"puTypCd":{"type":"string","description":"수거유형코드(LO006)"},"dlvpNm":{"type":"string","description":"배송지명"},"rcvmnNm":{"type":"string","description":"수취인명"},"dlvpSeq":{"type":"string","description":"배송지순번"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"dlvZipNo":{"type":"string","description":"우편번호(배송지)"},"dlvZipAddr":{"type":"string","description":"우편주소(배송지)"},"dlvDtlAddr":{"type":"string","description":"상세주소(배송지)"},"rcvmnEmailAddr":{"type":"string","description":"수취인이메일주소"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"rcvmnTelRgnNo":{"type":"string","description":"수취인전화지역번호"},"rcvmnTelTxnoNo":{"type":"string","description":"수취인전화국번번호"},"rcvmnTelEndNo":{"type":"string","description":"수취인전화끝번호"},"deliMsg":{"type":"string","description":"배송메시지"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039)"},"shopTrafMsg":{"type":"string","description":"매장전달메시지"},"comnFrdrCogoMethodCd":{"type":"string","description":"공동현관출입방법코드(ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"공동현관기타방법"},"comnFrdrPwd":{"type":"string","description":"공동현관비밀번호"},"orgDlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp"},"orgDeliNo":{"type":"string","description":"원배송번호"},"withdrawalDeliNo":{"type":"string","description":"회수지배송번호"},"dlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp"},"shippingDeliGbCd":{"type":"boolean"},"withdrawalDeliGbCd":{"type":"boolean"},"exchangeShipping":{"type":"boolean"},"withdrawShipping":{"type":"boolean"},"withDlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp","writeOnly":true}},"required":["claimLgrpCd","claimMgrpCd"]},"ClaimCalculateResponse":{"type":"object","description":"클레임 비용 계산 조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"클레임 최종 결제/환불금액 정보"}}},"ClaimFinalAmtInfo":{"type":"object","description":"클레임 최종 결제/환불금액 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"totAplyAdtnAmt":{"type":"integer","format":"int64","description":"총발생배송비금액"},"totCnclAdtnAmt":{"type":"integer","format":"int64","description":"총취소배송비금액"},"totFvrAdtnAmt":{"type":"integer","format":"int64","description":"총혜택배송비금액"},"totOrdPrc":{"type":"integer","format":"int64","description":"클레임상품금액"},"totDcAmt":{"type":"integer","format":"int64","description":"클레임취소할인금액"},"expectedRefundAmt":{"type":"integer","format":"int64","description":"환불예정금액"},"addtionPayAmt":{"type":"integer","format":"int64","description":"추가결제금액"},"returnAcceptAmt":{"type":"integer","format":"int64","description":"반품접수금액"},"refundAdditionAmtInfoList":{"type":"array","description":"추가결제/환불정보 리스트","items":{"$ref":"#/components/schemas/RefundAdditionAmtInfo"}},"refundPaymentMethodList":{"type":"array","description":"환불결제정보 리스트","items":{"$ref":"#/components/schemas/PaymentClaimResponse"}},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse","description":"환불 계좌정보"}}},"RefundAdditionAmtInfo":{"type":"object","description":"추가결제/환불정보 DTO","properties":{"adtnOcurGbCd":{"type":"string","description":"부가비용발생구분코드(OM017)"},"adtnOcurGbNm":{"type":"string","description":"부가비용발생구분명"},"type":{"type":"string","description":"유형구분","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE"]},"typeNm":{"type":"string","description":"유형구분명"},"goodsNoItmNo":{"type":"string","description":"상품번호+단품번호"},"goodsNm":{"type":"string","description":"상품명"},"ordAmt":{"type":"number","description":"결제금액"},"discountMethod":{"type":"string","description":"혜택상세정보(OM019)"},"discountMethodNm":{"type":"string","description":"혜택상세정보명"},"cnclDcAmt":{"type":"integer","format":"int64","description":"취소혜택금액"},"rtnDlvBenefitInfoList":{"type":"array","description":"반품쿠폰정보 리스트","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}}}},"PaymentClaimResponse":{"type":"object","description":"환불가능한 결제수단 DTO","properties":{"payNo":{"type":"string","description":"결제번호"},"ordNo":{"type":"string","description":"주문번호"},"claimNo":{"type":"string","description":"클레임번호"},"uprPayNo":{"type":"string","description":"상위결제번호"},"payGbCd":{"type":"string","description":"결제구분코드(OM012)"},"payGbCdNm":{"type":"string","description":"결제구분코드명(OM012)"},"payWayCd":{"type":"string","description":"결제수단코드(OM013)"},"payWayCdNm":{"type":"string","description":"결제수단코드명(OM013)"},"payStatCd":{"type":"string","description":"결제상태코드(OM014)"},"payStatCdNm":{"type":"string","description":"결제상태코드명(OM014)"},"payAmt":{"type":"number","description":"결제금액"},"rfdPsbAmt":{"type":"number","description":"환불가능금액"},"rfdAmt":{"type":"number","description":"환불금액"},"payFnshDtm":{"type":"string","format":"date-time","description":"결제완료일시"},"trdNo":{"type":"string","description":"거래번호(tid)"},"trdDtm":{"type":"string","format":"date-time","description":"거래일시"},"iscmCd":{"type":"string","description":"발급사코드(OM027)"},"iscmCdNm":{"type":"string","description":"발급사코드명(OM027)"},"payReqCardcoCd":{"type":"string","description":"결제요청카드사코드(OM057)"},"payReqCardcoCdNm":{"type":"string","description":"결제요청카드사코드명(OM057)"},"cardNo":{"type":"string","description":"카드번호"},"cardNm":{"type":"string","description":"카드명"},"cardValiTerm":{"type":"string","description":"카드유효기간"},"nintDivYn":{"type":"string","description":"무이자할부여부"},"divMonCnt":{"type":"integer","format":"int32","description":"할부개월수"},"cardPointUseYn":{"type":"string","description":"카드포인트사용여부"},"mersNo":{"type":"string","description":"가맹점번호"},"acqrCd":{"type":"string","description":"매입사코드(OM028)"},"acqrCdNm":{"type":"string","description":"매입사코드명(OM028)"},"aprvNo":{"type":"string","description":"승인번호"},"aprvDtm":{"type":"string","format":"date-time","description":"승인일시"},"sctnCnclPsbYn":{"type":"string","description":"부분취소가능여부"},"bankCd":{"type":"string","description":"은행코드(OM026)"},"bankCdNm":{"type":"string","description":"은행코드명(OM026)"},"actnNo":{"type":"string","description":"계좌번호"},"dpmnNm":{"type":"string","description":"입금자명"},"dptFcstDt":{"type":"string","description":"입금예정일자"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"입금확인일시"},"rfdBankCd":{"type":"string","description":"환불은행코드(OM026)"},"rfdBankCdNm":{"type":"string","description":"환불은행코드명(OM026)"},"rfdActnNo":{"type":"string","description":"환불계좌번호"},"rfdActnDepositorNm":{"type":"string","description":"환불계좌 예금주명"}}},"RfdInfoResponse":{"type":"object","description":"환불 계좌정보 조회 Response","properties":{"rfdBankCd":{"type":"string","description":"은행코드 (OM026)"},"rfdBankNm":{"type":"string","description":"은행명"},"rfdActnNo":{"type":"string","description":"환불계좌번호"},"rfdActnDepositorNm":{"type":"string","description":"환불 계좌 예금주명"},"rfdActnCertiYn":{"type":"string","description":"환불 계좌 인증여부"}}}}},"paths":{"/v1/claim/claimCommon/claimCalculateCost":{"post":{"tags":["클레임 공통"],"summary":"클레임 비용 계산 조회","description":"## 기능설명\n* 클레임 비용 계산 조회\n
\n
\n---\n## 상세내용\n* 클레임 업무 별 화면 추가 결제/환불 금액 정보 및 환불수단 정보 제공\n* 클레임 업무 처리 시 DB 기준 부가비용, 혜택정보 추가결제/환불 예정 데이터 생성 정보 및 쿠폰 사용/복원 정보 제공\n* BO 클레임 비용 계산 조회 API 호출 ( API URL : **/api/order/v1/claim/common/claimCalculateCost** )\n","operationId":"claimCalculateCost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimCalculateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimCalculateResponse"}}}}}}}}} ```