주문취소

주문 취소 팝업 정보 조회(BO)

post

기능설명

• 주문 내역과 취소 가능 상품 목록, 화면 처리 시 필요한 기타 정보를 조회합니다.

---

상세설명

• **주문번호(ordNo), 클레임업무유형(claimBusinessType), 시스템유형(systemType)**은 필수 파라미터 입니다.

• 다음의 조건을 모두 충족하는 대상에 대해 주문취소 처리가 가능합니다.

  • 주문내역구분(OM003) 값이 **주문일반(10)**인 경우

  • 주문내역상태(OM005) 값이 주문완료(12) 이거나 배송지시(21) 이거나 출고지시(22) 이거나 출고대기(23) 인 경우

  • 일반상품인 경우(사은품 제외)

  • 취소 가능 수량이 1개 이상인 경우( 주문수량 – 취소수량 – 반품수량 > 0 )

  • 주문 취소 가능 여부가 'Y'인 경우

• 기타 정보에 포함된 사항은 아래와 같습니다.

  • 주문취소 중분류 사유 List

  • 귀책사유 코드를 Key로 하고 주문취소 중분류 사유를 Value로 하는 Map

---

수정번호

• Release v2.00_240729 : 주문 취소 가능 여부(ordCnclPsbYn)값이 "N"인 경우 대상 제외

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestringRequired

시스템유형

Example: 10

Responses

200

성공

*/*

클레임 가능 대상 조회 응답 DTO

900

업무처리 오류 내용

*/*

post

/v1/claim/orderCancel/getOrderCancelPopupInfo

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/orderCancel/getOrderCancelPopupInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230808O007404",
  "claimBusinessType": 20,
  "systemType": 10
}

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": 1122,
        "rcvmnCellEndNo": 3546,
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": 112,
        "rcvmnTelEndNo": 3546,
        "deliMsg": "부재시 문앞에 두고 가주세요",
        "deliMsgCd": 70,
        "shopTrafMsg": "없음",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrEtcMethod": "없음",
        "comnFrdrPwd": 1234,
        "orgDlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "claimCausCdList": [
    {
      "grpCd": "ME001",
      "cd": 11,
      "cdNm": "상품즉시할인",
      "cdDesc": "다국어 코드설명",
      "useYn": "Y",
      "sortSeq": 1,
      "ref1Val": "기준코드 참조1값에 대한 설명",
      "ref2Val": "기준코드 참조2값에 대한 설명",
      "ref3Val": "기준코드 참조3값에 대한 설명",
      "ref4Val": "기준코드 참조4값에 대한 설명",
      "ref5Val": "기준코드 참조5값에 대한 설명",
      "ref6Val": "기준코드 참조6값에 대한 설명",
      "ref7Val": "기준코드 참조7값에 대한 설명"
    }
  ],
  "claimMgrpRspnGbCdMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "grpCd": "ME001",
      "cd": 11,
      "cdNm": "상품즉시할인",
      "cdDesc": "다국어 코드설명",
      "useYn": "Y",
      "sortSeq": 1,
      "ref1Val": "기준코드 참조1값에 대한 설명",
      "ref2Val": "기준코드 참조2값에 대한 설명",
      "ref3Val": "기준코드 참조3값에 대한 설명",
      "ref4Val": "기준코드 참조4값에 대한 설명",
      "ref5Val": "기준코드 참조5값에 대한 설명",
      "ref6Val": "기준코드 참조6값에 대한 설명",
      "ref7Val": "기준코드 참조7값에 대한 설명"
    }
  }
}

주문취소 내역 조회

post

기능설명

• 주문취소 내역을 조회합니다.

---

상세설명

• 주문내역구분(OM003) 값이 **주문일반(10)**이고 주문내역상태구분(OM005) 값이 주문취소(13) 인 정보를 기준으로 검색 Request 조건에 맞는 주문취소 내역을 조회합니다.

• 응답 값 중 개인정보와 관련된 로그인 아이디, 주문자명은 마스킹 처리가 됩니다.

• 파트너 사이트를 통해 접근한 경우, 로그인 정보의 협력사 번호가 검색 조건에 추가됩니다.(→ 협력사 상품 관련 주문건만 조회)

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

entrNostringOptional

협력사번호

Example: 1000002

ordAccpDtmStartstring · dateOptional

주문접수검색시작일자

Example: 2023-12-31

ordAccpDtmEndstring · dateOptional

주문접수검색종료일자

Example: 2023-12-31

cnclDtRngstringOptional

검색범위일자

Example: 3

loginIdstringOptional

로그인아이디

Example: id123

cnclOrdDtlStatCdstringOptional

주문취소상태코드

Example: 13

ordNostringOptional

주문번호

Example: 20231231O000001

ordManNmstringOptional

주문자명

Example: 홍길동

rcvmnNmstringOptional

수취인명

Example: 홍길동

ordManCellNostringOptional

주문자연락처

Example: 01012345678

rcvmnCellNostringOptional

수취인연락처

Example: 01012345678

zipNostringOptional

우편번호

Example: 05836

ordGbCdstringOptional

주문구분코드

Example: 10

deliKindCdstringOptional

배송종류코드

Example: 10

claimCausCdstringOptional

취소사유코드

Example: 100

goodsNoRngstringOptional

상품검색범위코드

Example: eq

goodsNostringOptional

상품번호

Example: 10002297

goodsNoFromstringOptional

상품시작번호

Example: 10002297

goodsNoTostringOptional

다건상품번호

Example: 10002297,10002298

goodsNoListstringOptional

상품번호

Example: 10002297

goodsNmstringOptional

상품명

Example: 상품이름

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderCancel/getOrderCancelList

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/orderCancel/getOrderCancelList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 463

{
  "entrNo": 1000002,
  "ordAccpDtmStart": "2023-12-31",
  "ordAccpDtmEnd": "2023-12-31",
  "cnclDtRng": 3,
  "loginId": "id123",
  "cnclOrdDtlStatCd": 13,
  "ordNo": "20231231O000001",
  "ordManNm": "홍길동",
  "rcvmnNm": "홍길동",
  "ordManCellNo": "01012345678",
  "rcvmnCellNo": "01012345678",
  "zipNo": "05836",
  "ordGbCd": 10,
  "deliKindCd": 10,
  "claimCausCd": 100,
  "goodsNoRng": "eq",
  "goodsNo": 10002297,
  "goodsNoFrom": 10002297,
  "goodsNoTo": "10002297,10002298",
  "goodsNoList": 10002297,
  "goodsNm": "상품이름"
}

{
  "totalCount": 1,
  "payloads": [
    {
      "claimNo": "20231231C000001",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "uprOrdProcSeq": 1,
      "siteNm": "플래티어닷컴",
      "siteNo": 1,
      "ordNo": "20230905O057021",
      "ordDtlGbCdNm": "주문취소",
      "ordCmptDtm": "주문취소",
      "ordAccpDtm": "2023-09-05 13:19:27",
      "goodsNo": 10002297,
      "goodsNm": "상품이름",
      "itmNo": "001",
      "itmNm": "파랑",
      "cnclQty": 1,
      "brandNo": 100002,
      "brandNm": "플래티어",
      "claimMgrpCd": 300,
      "claimMgrpCdNm": "사이즈가 큼",
      "loginId": "text",
      "mbrGradeCd": 20,
      "mbrGradeCdNm": "VVIP",
      "instMbrYn": "Y",
      "ordManNm": "홍길동",
      "deliKindCd": 10,
      "deliKindCdNm": 10,
      "payNo": 10,
      "payGbCd": 10,
      "payWayCd": 32,
      "payWayCdNm": "신용카드",
      "payStatCd": 12,
      "payAmt": 1000,
      "totalAmt": 1000,
      "pgAmt": 1000,
      "mainAmt": 1000,
      "mileageAmt": 1000,
      "ordGbCdNm": "일반주문",
      "entrNm": "플래티어",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1234,
      "ordManCellEndNo": 5678,
      "rcvmnNm": "홍길동",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 5678,
      "ordDtlStatCdNm": "주문완료",
      "mbrGbCdNm": "정회원",
      "mainPayWayCd": true,
      "mileagePayWayCd": true
    }
  ]
}

주문 취소 처리(BO)

post

기능설명

• 주문취소를 진행합니다.

---

상세설명

• 주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.

• 주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.

  • 접수 상품 사은품 유무 체크(-> 부분 수량 클레임 불가)

  • 부분취소불가 결제수단 사용 여부 체크(-> 부분 클레임 불가)

  • 추가결제금액이 여부 체크(-> BO에서 클레임 불가)

• 주문 취소 데이터 생성 및 업데이트 합니다.

• 주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.

• 복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.

• 주문 취소 상품에 대한 재고 복원이 일어납니다.

• 환불/결제 처리가 됩니다.

• 주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

---

수정번호

• release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가

• Release v2.00_240627: 접수 상품 배송번호 일치 여부 체크 로직 제거 ( 전체 취소 기능 추가)

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post

/v1/claim/orderCancel/cancel

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/orderCancel/cancel HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "ordMediaCd": 20,
  "ordNo": "20230808O007404",
  "mbrNo": 100001311,
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": 10002297,
      "itmNo": "001",
      "exchangeGoodsNo": 10002297,
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": 10,
      "claimMgrpCd": 100,
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": 100013106,
      "shipmentDeliNo": 100013105
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": 1234,
    "rcvmnCellEndNo": 5678,
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": 123,
    "rcvmnTelEndNo": 4567,
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": 30,
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": 20,
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": 1234
  },
  "claimDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": 1234,
    "rcvmnCellEndNo": 5678,
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": 123,
    "rcvmnTelEndNo": 4567,
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": 30,
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": 20,
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": 1234
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": 10,
        "adtnOcurGbNm": "발생",
        "type": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "iscmCd": 202,
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": 1,
        "acqrCd": 121,
        "acqrCdNm": "국민카드",
        "aprvNo": 12345678,
        "aprvDtm": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

No content