클레임공통

클레임 배송비 결제 처리

post

기능 설명

  • 결제대기 상태의 클레임에 대해 배송비 추가결제를 진행하고 주문내역상태를 수정합니다.


상세 설명

  • 주문 번호(ordNo), **클레임번호(claimNo)**는 필수로 있어야합니다.

  • 대상 클레임이 결제대기상태를 접수할 수 있는 상태인지 체크합니다.

    • **주문내역구분코드(OM003)**가 반품(20), **교환(30)**인지 확인

    • **주문내역상태코드(OM005)**가 **결제대기(31)**인지 확인

  • 대상 클레임 반품보류이면 주문내역상태를 회수완료(36)로, 반품보류가 아닌 반품 또는 교환일 경우 주문내역상태를 접수(32)로 수정합니다.

  • 대상 클레임 배송비의 결제승인정보를 저장 처리합니다.


수정번호

  • release_231106_01 : 반품보류 주문 배송비 추가결제 후 주문내역상태 수정

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 처리 요청 DTO

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
ordNostringRequired

주문번호

Example: 20230808O007404
mbrNostringOptional

회원번호

Example: 100001311
claimNostringRequired

클레임번호

Example: 20230808C010663
wthdFnshWaitProcCausstringRequired

회수완료 대기처리 사유

Example: 불량반품
occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptional

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
Responses
post
/v1/claim/fee/deliveryFeePayment

No content

비회원 주문 환불 계좌 정보 수정(BO)

post

기능설명

  • 주문번호 기준으로 비회원 주문 환불 계좌 정보를 업데이트합니다.


상세설명


특이사항

  • 예금주명은 주문자명과 일치해야합니다.

  • 필수 값 목록

    • 주문번호

    • 주문자명

    • 환불은행코드

    • 환불계좌번호

    • 환불예금주

Header parameters
AuthorizationanyOptional

Access Token

Body

환불접수등록 Request DTO

ordNostringOptional

주문번호

mbrNostringRequired

회원번호

mbrNmstringRequired

회원명

loginIdstringRequired

로그인ID

rfdTypCdstringRequired

환불유형코드(OM023)

rfdPrgsStatCdstringRequired

환불진행상태코드(OM024)

rfdBankCdstringRequired

환불은행코드(OM026)

rfdActnNostringRequired

환불계좌번호

rfdActnDepositorNmstringRequired

환불예금주

rfdCausCdstringRequired

환불사유코드(OM025)

rfdActnCertiYnstringRequired

환불계좌인증여부

rfdAmtinteger · int64Required

환불금액

rfdCmsnAmtinteger · int64Required

환불수수료금액

acptmnIdstringRequired

접수자ID

rfdSmsSndYnstringRequired

환불SMS발송여부

Responses
post
/v1/claim/common/saveNonMemberRefundActn

비회원 주문 환불 계좌 정보 수정

post

기능설명

  • 주문번호 기준으로 비회원 주문 환불 계좌 정보를 업데이트합니다.


상세설명


특이사항

  • 예금주명은 주문자명과 일치해야합니다.

  • 필수 값 목록

    • 주문번호

    • 주문자명

    • 환불은행코드

    • 환불계좌번호

    • 환불예금주

Header parameters
AuthorizationanyOptional

Access Token

Body

환불접수등록 Request DTO

ordNostringOptional

주문번호

mbrNostringRequired

회원번호

mbrNmstringRequired

회원명

loginIdstringRequired

로그인ID

rfdTypCdstringRequired

환불유형코드(OM023)

rfdPrgsStatCdstringRequired

환불진행상태코드(OM024)

rfdBankCdstringRequired

환불은행코드(OM026)

rfdActnNostringRequired

환불계좌번호

rfdActnDepositorNmstringRequired

환불예금주

rfdCausCdstringRequired

환불사유코드(OM025)

rfdActnCertiYnstringRequired

환불계좌인증여부

rfdAmtinteger · int64Required

환불금액

rfdCmsnAmtinteger · int64Required

환불수수료금액

acptmnIdstringRequired

접수자ID

rfdSmsSndYnstringRequired

환불SMS발송여부

Responses
post
/v1/claim/common/saveNonMemberRefundActnFO

반품/교환 철회대상 조회(BO)

post

기능 설명

  • BO에서 반품/교환 철회대상을 조회합니다.


상세 설명

  • 주문 번호(ordNo), **시스템 유형(systemType)**은 필수로 있어야합니다.

  • 다음의 조건을 모두 충족하는 대상에 대해 반품/교환 철회 처리가 가능합니다.

    • 주문내역구분(OM003) 값이 반품(20) 이거나 **교환(30)**인 경우

    • 주문내역상태(OM005) 값이 결제대기(31), 반품/교환접수(32), **회수지시(32)**인 경우

    • 반품 가능여부(rtnPsbYn) 값이 Y 인 경우

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

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


수정 번호

  • Release v2.00_240729 : 회수여부(wthdYn) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

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

ordNostringRequired

주문번호

Example: 20230808O007404
claimBusinessTypestring · enumOptional

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
orgClmNostringOptional

원클레임 번호

Example: 20230808C010663
systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:
dlvpSeqstringOptional

배송지순번

Example: 1
systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptional

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
systemstring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
post
/v1/claim/common/getReturnExchangeCancelTargetInfo

배송 번호 채번 처리

post

기능 설명

  • 배송 번호 채번 목록 조회합니다.


상세 설명

  • 요청 **배송번호 리스트(dlvpList)**는 필수로 있어야합니다.

  • 요청하는 **배송번호 리스트(dlvpList)**의 수에 따라 배송번호를 채번합니다.

  • 배송번호 채번 완료 후 채번한 배송번호 목록을 전달합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 배송번호 요청 DTO

dlvpListstring[]Required

배송번호 리스트

Example: shipment
Responses
post
/v1/claim/common/getNewNumberedDeliNo

클레임 배송비 결제대기상태 대상 정보

post

기능 설명

  • FO에서 클레임 배송비 결제대기상태 대상 정보를 조회합니다.


상세 설명

  • 주문 번호(ordNo), **클레임번호(claimNo)**는 필수로 있어야합니다.

  • 대상 클레임의 추가배송비를 조회합니다.

  • 대상 클레임의 상품목록을 조회합니다.

    • 주문내역구분(OM003) 값이 반품(20) 이거나 **교환(30)**인 경우

    • 주문내역상태(OM005) 값이 **결제대기(31)**인 경우

    • 반품 가능여부(rtnPsbYn) 값이 Y 인 경우

    • 대상 클레임 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 상세 내역 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404
claimNostringRequired

클레임번호

Example: 20230801C008072
Responses
post
/v1/claim/common/getClaimPayWaitStateInfo

이미지 업로드 처리

post

기능 설명

  • 이미지 S3 업로드 처리합니다.


상세 설명

  • 시스템 유형(systemType), 주문 번호(ordNo), **업로드 파일(MultipartHttpServletRequest)**은 필수로 있어야합니다.

  • 클레임 중분류상품불량일 경우에만 처리합니다.

  • **첨부파일업로드모듈(AttacheFileKind)**에 따라 업로드 경로 설정됩니다.

  • 업로드 완료 시 주문번호, 주문순번, 주문처리순번, 파일URL, 파일명이 포함된 **주문상세첨부파일정보(PrOrdDtlAtchFileInfo)**를 전달합니다.

Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
post
/v1/claim/common/claimImgUpload

클레임 상세 내역 조회(B0)

post

기능설명

  • 클레임 상세 내역을 조회합니다.


상세설명

  • **주문번호(ordNo), 클레임번호(claimNo)**는 필수 파라미터입니다.

  • 요청 주문번호, 클레임번호에 해당하는 클레임 상세 내역을 제공합니다.

  • 주문 내역 정보, 클레임 상품 정보, 환불/결제 내역, 환불예정쿠폰, 배송지정보를 제공합니다.


수정번호

  • Release v2.00_240711 : 배송 지역그룹 별 추가 배송비 적용

  • Release v2.00_240729 : 회수여부(wthdYn), 상품유형코드(goodsTypCd), 쿠폰번호(ecpnNo) 추가

  • Release v2.00_250818 : 교환 완료 후 반품 시 상위 결제 정보 메핑 변경

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 상세 내역 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404
claimNostringRequired

클레임번호

Example: 20230801C008072
Responses
post
/v1/claim/common/claimDetailsInfo

클레임 상세 내역 조회(FO)

post

기능설명

  • 클레임 상세 내역을 조회합니다.


상세설명

  • **주문번호(ordNo), 클레임번호(claimNo)**는 필수 파라미터입니다.

  • 요청 주문번호, 클레임번호에 해당하는 클레임 상세 내역을 제공합니다.

  • 주문 내역 정보, 클레임 상품 정보, 환불/결제 내역, 환불예정쿠폰, 배송지정보를 제공합니다.


수정번호

  • Release 2.00_240401: 주문구분코드 추가, 증정품명 추가

  • Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

  • Release v2.00_240711 : 배송 지역그룹 별 추가 배송비 적용

  • Release v2.00_240729 : 회수여부(wthdYn), 상품유형코드(goodsTypCd), 쿠폰번호(ecpnNo) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 상세 내역 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404
claimNostringRequired

클레임번호

Example: 20230801C008072
Responses
post
/v1/claim/common/claimDetailsInfoFO

클레임 비용 계산 조회(BO)

post

기능설명

  • 클레임 비용 계산 조회


상세내용

  • 클레임 업무 별 화면 추가 결제/환불 금액 정보 및 환불수단 정보 제공

  • 클레임 업무 처리 시 DB 기준 부가비용, 혜택정보 추가결제/환불 예정 데이터 생성 정보 및 쿠폰 사용/복원 정보 제공


수정번호

  • Release v2.00_240627 : 주문 취소시 복수 개의 배송 그룹에 대해 접수가 가능하도록 비용 계산 로직 수정 (전체 취소 기능 추가)

  • Release v2.00_240711 : 배송 지역그룹 별 추가 배송비 적용

  • Release v2.00_240729 : 접수 대상이 모두 '회수여부'가 'N'인 경우, 회수 배송비 0원 부과

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 비용 계산 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230912O058151
ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:
claimCalculateWorkTypestring · enumRequired

ClaimCalculateWorkType(클레임 혜택/비용처리 업무유형) * 10 : 클레임처리 화면조회 * 20 : 클레임처리 * 30 : 클레임상세내역 화면조회

Example: 10Possible values:
deliMethodCdstring · enumRequired

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
orgClmNostringOptional

현재 클레임 번호

Example: 20230912C018562
newNumberedClmNostringOptional

새로 채번된 클레임 번호

Example: 20230912C018563
selectedRtnDlvBenefitYnstring · enumOptional

반품무료쿠폰 화면선택여부

Example: NPossible values:
customerCauseFaultbooleanOptional
Responses
post
/v1/claim/common/claimCalculateCost

클레임 비용 계산 조회(FO)

post

기능 설명

  • 클레임 비용 계산 조회


상세 내용

  • 클레임 업무 별 화면 추가 결제/환불 금액 정보 및 환불수단 정보 제공

  • 클레임 업무 처리 시 DB 기준 부가비용, 혜택정보 추가결제/환불 예정 데이터 생성 정보 및 쿠폰 사용/복원 정보 제공

수정번호

  • Release v2.00_240401 : 배송비용 발생으로 인한 추가결제 연관 비용 체크 수정

  • Release v2.00_240509 : 쿠폰 적용대상에 기획전 정보 저장 추가

  • Release v2.00_240627 : 주문 취소시 복수 개의 배송 그룹에 대해 접수가 가능하도록 비용 계산 로직 수정 (전체 취소 기능 추가)

  • Release v2.00_240711 : 배송 지역그룹 별 추가 배송비 적용

  • Release v2.00_240729 : 접수 대상이 모두 '회수여부'가 'N'인 경우, 회수 배송비 0원 부과

Header parameters
AuthorizationanyOptional

Access Token

Body

클레임 비용 계산 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230912O058151
ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:
systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:
claimCalculateWorkTypestring · enumRequired

ClaimCalculateWorkType(클레임 혜택/비용처리 업무유형) * 10 : 클레임처리 화면조회 * 20 : 클레임처리 * 30 : 클레임상세내역 화면조회

Example: 10Possible values:
deliMethodCdstring · enumRequired

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
orgClmNostringOptional

현재 클레임 번호

Example: 20230912C018562
newNumberedClmNostringOptional

새로 채번된 클레임 번호

Example: 20230912C018563
selectedRtnDlvBenefitYnstring · enumOptional

반품무료쿠폰 화면선택여부

Example: NPossible values:
customerCauseFaultbooleanOptional
Responses
post
/v1/claim/common/claimCalculateCostFO

클레임 추가 결제정보 조회

post

기능 설명

  • 클레임 추가결제에 필요한 정보를 조회합니다.


상세 설명

  • 사용가능한 주결제수단, 보조결제수단 목록을 조회합니다.

  • 로그인된 회원 정보가 있을 경우, 사용가능 마일리지 정보도 보조결제수단목록에 포함되어 조회됩니다.

Header parameters
AuthorizationanyOptional

Access Token

Responses
post
/v1/claim/common/additionalFeePaymentInfo

비회원 주문 환불 계좌 정보 조회

get

기능설명

  • 주문번호 기준으로 비회원 주문 환불 계좌 정보를 조회합니다.


상세설명

  • op_ord_base 테이블에서 환불 계좌 정보를 조회합니다.

  • 주문번호는 필수 파라미터입니다.


특이사항

  • 전달하는 데이터 중 계좌번호는 마스킹 처리되어 출력됩니다.

Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
get
/v1/claim/common/getNonMemberRefundActnInfo

Last updated