주문반품

반품철회(BO)

post

기능설명

반품접수건을 철회합니다.

상세내용

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 결제대기(31), 접수(32), 회수지시(34) 상태인 경우 철회가 가능합니다.

  • 반품 철회 전 API 호출 시점의 주문 상태를 확인, 철회 가능 여부를 확인합니다.

  • 반품 철회 데이터 생성 및 업데이트합니다.

  • 반품 철회 대상의 주문내역상태(OM005) 값이 회수지시(34) 상태인 경우 배송지시취소수량을 업데이트합니다.

  • 반품 접수시 발생한 비용에 대해 결제 취소를 진행합니다.

  • 반품 철회시 발생하는 결제 및 환불 금액에 대한 검증을 수행합니다.

  • 반품 접수시 무료반품쿠폰을 사용한 경우, 쿠폰을 복원합니다.

  • 반품 철회 완료 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 철회 완료 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

  • release_231009_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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/withdrawalReturn

반품철회(FO)

post

기능설명

반품접수건을 철회합니다.

상세내용

  • 주문기본 테이블의 회원정보(비회원 포함)와 로그인 정보를 비교하여 권한을 확인합니다.

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 결제대기(31), 접수(32), 회수지시(34) 상태인 경우 철회가 가능합니다.

  • 반품 철회 전 API 호출 시점의 주문 상태를 확인, 철회 가능 여부를 확인합니다.

  • 반품 철회 데이터 생성 및 업데이트합니다.

  • 반품 철회 대상의 주문내역상태(OM005) 값이 회수지시(34) 상태인 경우 배송지시취소수량을 업데이트합니다.

  • 반품 접수시 발생한 비용에 대해 결제 취소를 진행합니다.

  • 반품 철회시 발생하는 결제 및 환불 금액에 대한 검증을 수행합니다.

  • 반품 접수시 무료반품쿠폰을 사용한 경우, 쿠폰을 복원합니다.

  • 반품 철회 완료 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 철회 완료 후 처리 이력을 생성합니다.


수정번호

  • release_231009_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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/withdrawalReturnFO

교환중 반품(BO)

post

기능설명

교환접수 진행 중 반품처리합니다.

상세내용

  • 주문내역구분(OM003) 값이 교환(30) 이고, 주문내역상태(OM005) 값이 회수확인(35) 상태인 경우 처리 가능합니다.

  • API 호출 시점의 주문 상태를 재 확인, 교환반품 처리 가능 여부를 확인합니다.

  • 교환 중 반품 처리시 대상 교환건을 철회하고, 반품 절차를 진행합니다. 단, 일반 반품 접수와 달리 교환중반품여부(exchMidRtnYn)값을 (Y)로 생성합니다.

  • 교환 중 반품 처리는 귀책 사유가 당사에 있기 때문에, 추가 결제 배송비가 발생하지 않습니다.

  • 교환 중 반품 처리 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

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

  • Release v2.00_240509 : 교환 취소 후 반품 접수시 배송지시일시 null에서 현재일시로 default 세팅 변경

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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/transformReturn

반품접수 대상 조회(BO)

post

기능설명

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

상세내용

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

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

    1. 주문내역구분(OM003) 값이 주문일반(10) 이거나 교환(30) 인 경우

    2. 주문내역상태(OM005) 값이 출고완료(26) 이거나 **배송완료(27)**인 경우

    3. 반품 가능여부 값이 “Y” 인 경우

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

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

  • 기타 정보에 포함된 공통 코드 목록은 아래와 같습니다.

    1. 클레임대분류코드(OM047)

    2. 클레임중분류코드(OM006)

    3. 배송메시지코드(ME039)

    4. 공동현관출입방법코드(ME040)

    5. 귀책구분코드(CS020)

    6. 부가비용상세구분코드(OM019)

    7. 주문비용구분코드(OM043)

    8. 결제수단코드(OM013)


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

  • release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행

  • Release v2.00_240729 : e-쿠폰 사용 여부 체크 추가, 상품 유형에 따라 클레임 사유 필터링 회수여부(wthdYn)/e쿠폰번호(ecpnNo)/e티켓번호(etcktNo)/회수불필요주문여부(isAllNonReturnable)/e쿠폰주문여부(isAllEcoupon) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

반품처리대상조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230809O000001
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:
dlvpSeqstringOptional

배송지순번

Example: 1
Responses
chevron-right
200

성공

*/*

반품처리대상조회 응답 DTO

claimBusinessTypestring · enumOptional

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

Example: 11Possible values:
post
/v1/claim/return/returnTargetInfo

반품접수 대상 조회(FO)

post

기능설명

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

상세내용

  • 반품 처리 대상 조회 시 주문 회원정보(비회원 포함)와 로그인 정보를 비교하여 권한을 확인합니다.

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

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

    1. 주문내역구분(OM003) 값이 주문일반(10) 이거나 교환(30) 인 경우

    2. 주문내역상태(OM005) 값이 출고완료(26) 이거나 **배송완료(27)**인 경우

    3. 반품 가능여부 값이 “Y” 인 경우

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

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

  • 기타 정보에 포함된 공통 코드 목록은 아래와 같습니다.

    1. 클레임대분류코드(OM047)

    2. 클레임중분류코드(OM006)

    3. 배송메시지코드(ME039)

    4. 공동현관출입방법코드(ME040)

    5. 귀책구분코드(CS020)

    6. 부가비용상세구분코드(OM019)

    7. 주문비용구분코드(OM043)

    8. 결제수단코드(OM013)


수정번호

  • release_231023 : 회원인 경우, 보조 결제수단 및 마일리지 정보 조회 프로세스 제거 (별도의 API로 분리)

  • release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행

  • Release v2.00_240729 : e-쿠폰 사용 여부 체크 추가, 상품 유형에 따라 클레임 사유 필터링 회수여부(wthdYn)/e쿠폰번호(ecpnNo)/e티켓번호(etcktNo)/회수불필요주문여부(isAllNonReturnable)/e쿠폰주문여부(isAllEcoupon) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

반품처리대상조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230809O000001
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:
dlvpSeqstringOptional

배송지순번

Example: 1
Responses
chevron-right
200

성공

*/*

반품처리대상조회 응답 DTO

claimBusinessTypestring · enumOptional

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

Example: 11Possible values:
post
/v1/claim/return/returnTargetInfoFO

반품보류(BO)

post

기능설명

반품보류 처리합니다.

상세내용

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 회수확인(35), 회수완료(36) 상태인 경우 처리 가능합니다.

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

  • 반품 보류 처리시 배송비 발생한 경우 주문 상태를 결제대기 상태로 변경합니다.

  • 반품 불가 처리시 회수완료 대기처리 사유(wthdFnshWaitProcCaus)는 필수값입니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

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

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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/returnPending

반품불가(BO)

post

기능설명

반품접수 불가처리합니다.

상세내용

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 회수확인(35), 회수완료(36) 상태인 경우 처리 가능합니다.

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

  • 반품 불가 처리시 대상 반품건을 철회하고, 주문상세 테이블의 반품가능여부(rtnPsbYn) 속성값이 (N)으로 변경됩니다.

  • 반품 불가 처리시 회수완료 대기처리 사유(wthdFnshWaitProcCaus)는 필수값입니다.

  • 주문배송정보(OP_ORD_DELI_INFO) 테이블의 회수완료구분코드값은 불량반품(20)으로 자동 저장됩니다.

  • 반품 불가 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

  • release_231009_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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/rejectReturn

반품완료(BO)

post

기능설명

반품접수 완료처리합니다.

상세내용

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 회수완료(36) 상태인 경우 처리 가능합니다.

  • API 호출 시점의 주문 상태를 재 확인, 완료 처리 가능 여부를 확인합니다.

  • 주문상세 테이블의 주문내역상태코드(OM005) 값이 반품완료(37) 상태로 변경되며(사은품 포함), 주문완료일시(ordFnshDtm)를 업데이트합니다.

  • 주문배송정보 테이블의 배송완료일시(deliFnshDtm)를 업데이트합니다.

  • 주문시 사용되었던 쿠폰과 주문상품(사은품 포함)의 재고가 복원됩니다. 단, 주문상세의 교환중반품여부(exchMidRtnYn)값이 (Y)이고 주문내역상태값이 회수완료(36)인 경우 재고 복원대상에서 제외됩니다.

  • 환불 절차를 진행합니다.

  • 반품 완료 처리 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 완료 처리 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

  • Release v2.00_240729 : 반품 접수 대상의 '회수여부'가 'N'인 경우, 재고 복원 제외

  • Release v2.00_250801 : 추가 결제 발생한 교환 신청 후 반품 완료 시 교환 상품 배송비 환불되는 현상 개선

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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/completeReturn

반품완료 배치

post

기능설명

반품접수 완료처리합니다.

상세내용

  • 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 회수완료(36) 상태인 경우 처리 가능합니다.

  • API 호출 시점의 주문 상태를 재 확인, 완료 처리 가능 여부를 확인합니다.

  • 주문상세 테이블의 주문내역상태코드(OM005) 값이 반품완료(37) 상태로 변경되며(사은품 포함), 주문완료일시(ordFnshDtm)를 업데이트합니다.

  • 주문배송정보 테이블의 배송완료일시(deliFnshDtm)를 업데이트합니다.

  • 주문시 사용되었던 쿠폰과 주문상품(사은품 포함)의 재고가 복원됩니다. 단, 주문상세의 교환중반품여부(exchMidRtnYn)값이 (Y)이고 주문내역상태값이 회수완료(36)인 경우 재고 복원대상에서 제외됩니다.

  • 환불 절차를 진행합니다.

  • 반품 완료 처리 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 완료 처리 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BATCH 전용 API입니다.


수정번호

  • Release v2.00_240729 : 반품 접수 대상의 '회수여부'가 'N'인 경우, 재고 복원 제외

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject[]

클레임 처리 요청 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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

No content

post
/v1/claim/return/completeReturnBatch

No content

반품접수(BO)

post

기능설명

반품대상을 접수처리합니다.

상세내용

  • 반품 접수 전 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.

  • 반품 접수 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.

    1. 접수 상품 배송번호 일치 여부 체크(→ 클레임 불가)

    2. 접수 상품 사은품 유무 체크(→ 부분 수량 클레임 불가)

    3. 부분취소불가 결제수단 사용 여부 체크(→ 부분 클레임 불가)

    4. 주문번호 기준, 기 접수된 반품 건 중 초도 배송비 발생 및 반품 취소 가능 상태(결제대기, 접수, 회수지)인 클레임 유무 체크(→ 추가 반품 접수 불가)

    5. 현 반품 접수 건에 초도 배송비가 발생한 경우, 기 접수된 반품 건 중 반품 취소 가능 상태(결제대기, 접수, 회수지)인 클레임 유무 체크(→ 추가 반품 접수 불가)

  • 반품 접수 데이터 생성 및 업데이트합니다.

  • 추가 결제 금액이 발생한 경우,

    1. 환불 예정금액보다 추가 결제 금액이 큰 경우, 주문내역상태(OM005) 값은 결제대기(31)로 저장되며, 고객의 추가 배송비 결제가 필요합니다.

    2. 환불 예정금액보다 추가 결제 금액이 작거나 같은 경우, 추가 결제 금액이 차감된 금액이 환불됩니다.

  • 반품 접수시 발생하는 결제 및 환불 금액에 대해 검증을 수행합니다.

  • 반품 접수시 무료반품쿠폰을 사용한 경우, 쿠폰을 사용처리합니다.

  • 반품 접수 완료 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 접수 완료 후 처리 이력을 생성합니다.


특이사항

  • 해당 API는 BO 전용 API입니다. BO를 통한 접근만 허용됩니다.


수정번호

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

  • Release v2.00_240729 : 반품 접수 대상이 모두 '회수여부'가 'N'인 경우, 반품 배송비 부과 제외 e-쿠폰 상품 반품의 경우, e-쿠폰 사용 불가 처리

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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/acceptReturn

반품접수(FO)

post

기능설명

반품대상을 접수처리합니다.

상세내용

  • 주문기본 테이블의 회원정보(비회원 포함)와 로그인 정보를 비교하여 권한을 확인합니다.

  • 반품 접수 전 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.

  • 반품 접수 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.

    1. 접수 상품 배송번호 일치 여부 체크(→ 클레임 불가)

    2. 접수 상품 사은품 유무 체크(→ 부분 수량 클레임 불가)

    3. 부분취소불가 결제수단 사용 여부 체크(→ 부분 클레임 불가)

    4. 주문번호 기준, 기 접수된 반품 건 중 초도 배송비 발생 및 반품 취소 가능 상태(결제대기, 접수, 회수지)인 클레임 유무 체크(→ 추가 반품 접수 불가)

    5. 현 반품 접수 건에 초도 배송비가 발생한 경우, 기 접수된 반품 건 중 반품 취소 가능 상태(결제대기, 접수, 회수지)인 클레임 유무 체크(→ 추가 반품 접수 불가)

  • 반품 접수 데이터 생성 및 업데이트합니다.

  • 추가 결제 금액이 발생한 경우, 결제를 진행합니다.

  • 반품 접수시 발생하는 결제 및 환불 금액에 대해 검증을 수행합니다.

  • 반품 접수시 무료반품쿠폰을 사용한 경우, 쿠폰을 사용처리합니다.

  • 반품 접수 완료 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)

  • 반품 접수 완료 후 처리 이력을 생성합니다.


수정번호

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

  • Release v2.00_240700 : 반품 접수 대상이 모두 '회수여부'가 'N'인 경우, 반품 배송비 부과 제외 e-쿠폰 상품 반품의 경우, e-쿠폰 사용 불가 처리

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: 불량반품
claimBusinessstring · enumOptional

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

Example: 11Possible values:
existAddtionPayAmtbooleanOptional
occurPaymentbooleanOptional
Responses
chevron-right
200

성공

*/*
ordNostringOptional

주문번호

Example: 20230808O007404
claimNostringOptional

클레임번호

Example: 20230808C010663
post
/v1/claim/return/acceptReturnFO

Last updated