> For the complete documentation index, see [llms.txt](https://workspace-help.nhn-commerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://workspace-help.nhn-commerce.com/contents/recommended/prm_mileage_transform_guide.md).

# \[엔터프라이즈] 외부 적립금 전환 가이드

샵바이 엔터프라이즈 외부 적립금 전환 가이드

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

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

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

<br>

**\[ 적립금 전환 ]**

기본 FLOW

<figure><img src="https://rlyfaazj0.toastcdn.net/SERVICE/20210812/04_%EC%88%98%EC%A0%95.png" alt=""><figcaption></figcaption></figure>

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

***

**1. 적립금 전환**

[▶](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[ ](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[적립금 즉시 지급 API 바로가기 ](https://server-docs.shopby.co.kr/?url.primaryName=manage/#/Accumulations/create-accumulations-member)

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

▶ Request

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

**Example**

{% code overflow="wrap" %}

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

{% endcode %}

***

**2. 적립금 반환**

[▶](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[ ](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[적립금 즉시 차감 API 바로가기 ](https://server-docs.shopby.co.kr/?url.primaryName=manage/#/Accumulations/delete-accumulations-member)

▶ Query parameter

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

***

**3. 적립금 조회**

[▶](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[ ](https://server-docs.shopby.co.kr/?urls.primaryName=manage#/Profile%20%3E%20Accumulations/create-accumulations-member)[적립금 즉시 조회 API 바로가기 ](https://server-docs.shopby.co.kr/?url.primaryName=manage/#/Accumulations/get-accumulations-by-member)

▶ Query parameter

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