> 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-2.md).
# 주문취소
## 주문 취소 팝업 정보 조회(BO)
> \## 기능설명\
> \* 주문 내역과 취소 가능 상품 목록, 화면 처리 시 필요한 기타 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* \*\*주문번호(ordNo), 클레임업무유형(claimBusinessType), 시스템유형(systemType)\*\*은 필수 파라미터 입니다.\
> \* 다음의 조건을 모두 충족하는 대상에 대해 주문취소 처리가 가능합니다.\
> \* 주문내역구분(OM003) 값이 \*\*주문일반(10)\*\*인 경우\
> \* 주문내역상태(OM005) 값이 \*\*주문완료(12)\*\* 이거나 \*\*배송지시(21)\*\* 이거나 \*\*출고지시(22)\*\* 이거나 \*\*출고대기(23)\*\* 인 경우\
> \* 일반상품인 경우(사은품 제외)\
> \* 취소 가능 수량이 1개 이상인 경우( \*\*주문수량 – 취소수량 – 반품수량 > 0\*\* )\
> \* 주문 취소 가능 여부가 'Y'인 경우\
> \* 기타 정보에 포함된 사항은 아래와 같습니다.\
> \* 주문취소 중분류 사유 List\
> \* 귀책사유 코드를 Key로 하고 주문취소 중분류 사유를 Value로 하는 Map\
> \---\
> \## 수정번호\
> \* Release v2.00\_240729 : 주문 취소 가능 여부(ordCnclPsbYn)값이 "N"인 경우 대상 제외
```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":{"ClaimTargetRequest":{"type":"object","description":"클레임 가능 대상 조회 요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"claimBusinessType":{"type":"string","description":"클레임 업무 유형","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]},"systemType":{"type":"string","description":"시스템유형"}},"required":["ordNo","systemType"]},"OrderCancelPopupResponse":{"type":"object","description":"클레임 가능 대상 조회 응답 DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"클레임 대상"},"claimCausCdList":{"type":"array","description":"클레임 대분류 사유","items":{"$ref":"#/components/schemas/StStdCd"}},"claimMgrpRspnGbCdMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StStdCd"},"description":"귀책구분코드의 코드를 Key로 하는 클레임 중분류 사유 Map"}}},"ClaimTargetResponse":{"type":"object","description":"클레임 처리대상 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007) 20:PC, 30:모바일웹, 40:안드로이드앱, 50:IOS앱"},"sctnCnclPsbYn":{"type":"string","description":"부분취소가능여부","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"클레임 대상 상품 목록","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"그룹코드 조회/등록/수정 Request","properties":{"grpCd":{"type":"string","description":"그룹코드"},"cd":{"type":"string","description":"코드"},"cdNm":{"type":"string","description":"코드명"},"cdDesc":{"type":"string","description":"코드설명"},"useYn":{"type":"string","description":"사용여부"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"ref1Val":{"type":"string","description":"참조1값 설명"},"ref2Val":{"type":"string","description":"참조2값 설명"},"ref3Val":{"type":"string","description":"참조3값 설명"},"ref4Val":{"type":"string","description":"참조4값 설명"},"ref5Val":{"type":"string","description":"참조5값 설명"},"ref6Val":{"type":"string","description":"참조6값 설명"},"ref7Val":{"type":"string","description":"참조7값 설명"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/claim/orderCancel/getOrderCancelPopupInfo":{"post":{"tags":["주문취소"],"summary":"주문 취소 팝업 정보 조회(BO)","description":"## 기능설명\n* 주문 내역과 취소 가능 상품 목록, 화면 처리 시 필요한 기타 정보를 조회합니다.\n---\n## 상세설명\n* **주문번호(ordNo), 클레임업무유형(claimBusinessType), 시스템유형(systemType)**은 필수 파라미터 입니다.\n* 다음의 조건을 모두 충족하는 대상에 대해 주문취소 처리가 가능합니다.\n * 주문내역구분(OM003) 값이 **주문일반(10)**인 경우\n * 주문내역상태(OM005) 값이 **주문완료(12)** 이거나 **배송지시(21)** 이거나 **출고지시(22)** 이거나 **출고대기(23)** 인 경우\n * 일반상품인 경우(사은품 제외)\n * 취소 가능 수량이 1개 이상인 경우( **주문수량 – 취소수량 – 반품수량 > 0** )\n * 주문 취소 가능 여부가 'Y'인 경우\n* 기타 정보에 포함된 사항은 아래와 같습니다.\n * 주문취소 중분류 사유 List\n * 귀책사유 코드를 Key로 하고 주문취소 중분류 사유를 Value로 하는 Map\n---\n## 수정번호\n* Release v2.00_240729 : 주문 취소 가능 여부(ordCnclPsbYn)값이 \"N\"인 경우 대상 제외\n","operationId":"getOrderCancelPopupInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimTargetRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderCancelPopupResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 주문취소 내역 조회
> \## 기능설명\
> \* 주문취소 내역을 조회합니다.\
> \---\
> \## 상세설명\
> \* 주문내역구분(OM003) 값이 \*\*주문일반(10)\*\*이고 주문내역상태구분(OM005) 값이 \*\*주문취소(13)\*\* 인 정보를 기준으로 검색 Request 조건에 맞는 주문취소 내역을 조회합니다.\
> \* 응답 값 중 개인정보와 관련된 로그인 아이디, 주문자명은 마스킹 처리가 됩니다.\
> \* 파트너 사이트를 통해 접근한 경우, 로그인 정보의 협력사 번호가 검색 조건에 추가됩니다.(→ 협력사 상품 관련 주문건만 조회)
```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":{"OrderCancelSearchRequest":{"type":"object","properties":{"entrNo":{"type":"string","description":"협력사번호"},"ordAccpDtmStart":{"type":"string","format":"date","description":"주문접수검색시작일자"},"ordAccpDtmEnd":{"type":"string","format":"date","description":"주문접수검색종료일자"},"cnclDtRng":{"type":"string","description":"검색범위일자"},"loginId":{"type":"string","description":"로그인아이디"},"cnclOrdDtlStatCd":{"type":"string","description":"주문취소상태코드"},"ordNo":{"type":"string","description":"주문번호"},"ordManNm":{"type":"string","description":"주문자명"},"rcvmnNm":{"type":"string","description":"수취인명"},"ordManCellNo":{"type":"string","description":"주문자연락처"},"rcvmnCellNo":{"type":"string","description":"수취인연락처"},"zipNo":{"type":"string","description":"우편번호"},"ordGbCd":{"type":"string","description":"주문구분코드"},"deliKindCd":{"type":"string","description":"배송종류코드"},"claimCausCd":{"type":"string","description":"취소사유코드"},"goodsNoRng":{"type":"string","description":"상품검색범위코드"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNoFrom":{"type":"string","description":"상품시작번호"},"goodsNoTo":{"type":"string","description":"다건상품번호"},"goodsNoList":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"}}},"RealGridListResponseOrderCancelSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderCancelSearchResponse"}}}},"OrderCancelSearchResponse":{"type":"object","properties":{"claimNo":{"type":"string","description":"클레임번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"uprOrdProcSeq":{"type":"integer","format":"int32","description":"상위주문처리순번"},"siteNm":{"type":"string","description":"사이트이름"},"siteNo":{"type":"string","description":"사이트번호"},"ordNo":{"type":"string","description":"주문번호"},"ordDtlGbCdNm":{"type":"string","description":"주문상세구분코드명"},"ordCmptDtm":{"type":"string","format":"date-time","description":"주문완료일자"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문취소접수일자"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"cnclQty":{"type":"integer","format":"int32","description":"취소수량"},"brandNo":{"type":"string","description":"브랜드번호"},"brandNm":{"type":"string","description":"브랜드명"},"claimMgrpCd":{"type":"string","description":"클레임중분류코드"},"claimMgrpCdNm":{"type":"string","description":"클레임중분류코드명"},"loginId":{"type":"string"},"mbrGradeCd":{"type":"string","description":"회원등급코드"},"mbrGradeCdNm":{"type":"string","description":"회원등급코드명"},"instMbrYn":{"type":"string","description":"관심고객여부"},"ordManNm":{"type":"string","description":"주문자명"},"deliKindCd":{"type":"string","description":"배송종류코드"},"deliKindCdNm":{"type":"string","description":"배송방법코드"},"payNo":{"type":"string","description":"결제번호"},"payGbCd":{"type":"string","description":"결제구분코드(OM012)"},"payWayCd":{"type":"string","description":"결제수단코드(OM013)"},"payWayCdNm":{"type":"string","description":"결제수단코드명"},"payStatCd":{"type":"string","description":"결제상태코드(OM014)"},"payAmt":{"type":"number","description":"결제/환불금액"},"totalAmt":{"type":"number","description":"총결제금액"},"pgAmt":{"type":"number","description":"PG결제금액"},"mainAmt":{"type":"number","description":"실결제금액"},"mileageAmt":{"type":"number","description":"마일리지결제금액"},"ordGbCdNm":{"type":"string","description":"주문구분코드명"},"entrNm":{"type":"string","description":"협력사명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"mbrGbCdNm":{"type":"string","description":"회원구분코드명"},"mainPayWayCd":{"type":"boolean"},"mileagePayWayCd":{"type":"boolean"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/claim/orderCancel/getOrderCancelList":{"post":{"tags":["주문취소"],"summary":"주문취소 내역 조회","description":"## 기능설명\n* 주문취소 내역을 조회합니다.\n---\n## 상세설명\n* 주문내역구분(OM003) 값이 **주문일반(10)**이고 주문내역상태구분(OM005) 값이 **주문취소(13)** 인 정보를 기준으로 검색 Request 조건에 맞는 주문취소 내역을 조회합니다.\n* 응답 값 중 개인정보와 관련된 로그인 아이디, 주문자명은 마스킹 처리가 됩니다.\n* 파트너 사이트를 통해 접근한 경우, 로그인 정보의 협력사 번호가 검색 조건에 추가됩니다.(→ 협력사 상품 관련 주문건만 조회)\n","operationId":"getOrderCancelList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelSearchRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderCancelSearchResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 주문 취소 처리(BO)
> \## 기능설명\
> \* 주문취소를 진행합니다.\
> \---\
> \## 상세설명\
> \* 주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.\
> \* 주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.\
> \* 접수 상품 사은품 유무 체크(-> \*부분 수량 클레임 불가\*)\
> \* 부분취소불가 결제수단 사용 여부 체크(-> \*부분 클레임 불가\*)\
> \* 추가결제금액이 여부 체크(-> \*BO에서 클레임 불가\*)\
> \* 주문 취소 데이터 생성 및 업데이트 합니다.\
> \* 주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.\
> \* 복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.\
> \* 주문 취소 상품에 대한 재고 복원이 일어납니다.\
> \* 환불/결제 처리가 됩니다.\
> \* 주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)\
> \---\
> \## 수정번호\
> \* release\_231009\_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가\
> \* Release v2.00\_240627: 접수 상품 배송번호 일치 여부 체크 로직 제거 ( 전체 취소 기능 추가)
```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":{"ClaimRequest":{"type":"object","description":"클레임 처리 요청 DTO","properties":{"systemType":{"type":"string","description":"시스템유형","enum":["FO","BO"],"minLength":1},"claimBusinessType":{"type":"string","description":"클레임 업무 유형","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"],"minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1},"ordNo":{"type":"string","description":"주문번호"},"mbrNo":{"type":"string","description":"회원번호"},"claimNo":{"type":"string","description":"클레임번호"},"claimGoodsList":{"type":"array","description":"클레임 대상 상품정보 리스트","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"쿠폰 리스트","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"회수지 정보"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"배송지 정보"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"추가결제/환불금액 정보"},"wthdFnshWaitProcCaus":{"type":"string","description":"회수완료 대기처리 사유"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"클레임 요청 상품 정보 DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"goodsNo":{"type":"string","description":"상품번호"},"itmNo":{"type":"string","description":"단품번호"},"exchangeGoodsNo":{"type":"string","description":"교환 상품 번호"},"exchangeItmNo":{"type":"string","description":"교환 단품 번호"},"exchangeItmNm":{"type":"string","description":"교환 단품명"},"claimQty":{"type":"integer","format":"int32","description":"클레임 수량"},"claimLgrpCd":{"type":"string","description":"클레임대분류코드(OM047)"},"claimMgrpCd":{"type":"string","description":"클레임중분류코드(OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"클레임사유기타내용"},"withdrawalDeliNo":{"type":"string","description":"회수 배송번호"},"shipmentDeliNo":{"type":"string","description":"출하 배송번호"}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"클레임 쿠폰 정보 DTO","properties":{"cpnNo":{"type":"string","description":"쿠폰발급번호"}}},"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"]},"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":"환불 계좌 인증여부"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/claim/orderCancel/cancel":{"post":{"tags":["주문취소"],"summary":"주문 취소 처리(BO)","description":"## 기능설명\n* 주문취소를 진행합니다.\n---\n## 상세설명\n* 주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.\n* 주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.\n * 접수 상품 사은품 유무 체크(-> *부분 수량 클레임 불가*)\n * 부분취소불가 결제수단 사용 여부 체크(-> *부분 클레임 불가*)\n * 추가결제금액이 여부 체크(-> *BO에서 클레임 불가*)\n* 주문 취소 데이터 생성 및 업데이트 합니다.\n* 주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.\n* 복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.\n* 주문 취소 상품에 대한 재고 복원이 일어납니다.\n* 환불/결제 처리가 됩니다.\n* 주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)\n---\n## 수정번호\n* release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가\n* Release v2.00_240627: 접수 상품 배송번호 일치 여부 체크 로직 제거 ( 전체 취소 기능 추가)\n","operationId":"cancelOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```