[프리미엄] 외부 적립금 전환 가이드

샵바이프리미엄 외부 적립금 전환 가이드

적립금 기능은 쇼핑몰 회원의 적립금을 조회/지급/차감할 수 있는 기능입니다.

고객사에서 별도의 적립금 혹은 마일리지등의 혜택을 사용하고 있는 경우, 샵바이의 적립금으로 전환하여 사용할 수 있는 기능을 제공합니다.

업데이트 일자: 2022. 10. 07

[ 적립금 전환 ]

기본 FLOW

(참고) 적립금을 전환하는 개념이므로, 샵바이 쇼핑몰에 적립금이 지급되면, 고객사 입장에서는 적립금이 차감되는 개념입니다.

---

1. 적립금 전환

▶ 적립금 즉시 지급 API 바로가기

고객사에서 별도의 적립금 혹은 마일리지등의 혜택을 사용하고 있는 경우, 샵바이의 적립금으로 전환하여 사용할 수 있습니다.

▶ Request

항목	타입	필수여부	설명
memberNo	Number	O	샵바이 회원번호 (memberId와 배타적) - 미입력 시, memberId 필수로 입력
memberId	String	O	쇼핑몰 회원이 가입한 id - 미입력 시, memberNo 필수로 입력
accumulationAmt	Number	X	적립금 지급 금액
expireYmd	String	X	적립금 유효기간

Example

{"memberNo" : 1,"memberId" : "test","accumulationAmt" : 1000,"expireYmd" : null}

---

2. 적립금 반환

▶ 적립금 즉시 차감 API 바로가기

▶ Query parameter

항목	타입	필수여부	설명
memberNo	Number	O	샵바이 회원번호 (memberId와 배타적) - 미입력 시, memberId 필수로 입력
memberId	String	O	쇼핑몰 회원이 가입한 id - 미입력 시, memberNo 필수로 입력
accumulationAmt	Number	X	적립금 차감 금액
entireSubtracted	String	X	전체 적립금 차감 여부 true 인 경우 해당 회원의 모든 적립금을 삭제함.

---

3. 적립금 조회

▶ 적립금 즉시 조회 API 바로가기

▶ Query parameter

항목	타입	필수여부	설명
memberNo	Number	O	샵바이 회원번호 (memberId와 배타적) - 미입력 시, memberId 필수로 입력
memberId	String	O	쇼핑몰 회원이 가입한 id - 미입력 시, memberNo 필수로 입력
accumulationAmt	Number	X	적립금 차감 금액
entireSubtracted	String	X	전체 적립금 차감 여부 true인 경우 해당 회원의 모든 적립금을 삭제함.
page	Number	X	페이지 번호
pageSize	Number	X	한 페이지당 데이터 건수
startYmd	String	X	시작일
endYmd	String	X	종료일