마일리지

마일리지 사용/적립 처리

post

기능설명

마일리지 사용 또는 적립을 진행합니다.

상세설명

회원의 마일리지 사용 또는 적립을 진행합니다.
마일리지 사용 시에는 적립된 마일리지를 사용하는 우선순위가 존재합니다.
마일리지 적립 시에는 적립 구분코드에 따라 사용 유효기간이 다르게 설정되어 적립됩니다.
마일리지 사용 우선순위
- 마일리지 종료 유효기간이 가장 짧은 마일리지
- 마일리지 금액이 적은 마일리지
마일리지 적립 유효기간
- 기본적립, 상품리뷰, 회원등급별추가 적립 : 1년
- 프로모션, 고객보상, 환불, 이벤트 적립 : 30일

특이사항

외부 접속이 차단된 API로, 내부 서버에서만 접근이 가능합니다.

수정번호

Release v1.01_231010: 마일리지 소멸기간 자동화 처리(이벤트/환불/고객보상)
Release v1.03_231106: 마일리지 적립 전문 항목 추가(적립대상코드)
Release v1.03_231106: 마일리지 적립 시 상품평 월/년 최대 적립 금액 체크 로직 추가

Query parameters

mlgUseRfdRequestVostringRequired

MlgUseRfdRequestVo

Header parameters

AuthorizationanyOptional

Access Token

Body

마일리지 사용/적립 처리 RequestVO

mbrNostringRequired

회원번호

Example: 100001641

Responses

200

성공

*/*

마일리지 사용/적립 내역 Response

900

업무처리 오류 내용

*/*

post/v1/mileage/mlgSaveUse

POST /api/member/v1/mileage/mlgSaveUse?mlgUseRfdRequestVo=text HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "mbrNo": 100001641,
  "mlgList": [
    {
      "astGbCd": 20,
      "rsrvUseGbCd": 10,
      "astRsrvUseCausCd": 11,
      "rsrvGbCd": 100,
      "rsrvTgtCd": 111,
      "ocurMlg": 100,
      "astMgrNo": "20230824O213892",
      "astMgrDtlNo": "text",
      "astMgrMemo": "text"
    }
  ]
}

{
  "mlgList": [
    {
      "astMgrSeq": 3773196,
      "ocurMlg": 4000,
      "astMgrNo": "20230825O389712",
      "astMgrDtlNo": "20230825C014982_31_399592"
    }
  ]
}

보유 마일리지 요약 조회

get

기능설명

마일리지 정보를 요약하여 조회합니다.

상세설명

회원이 보유하고 있는 마일리지 정보를 요약하여 조회합니다.
마일리지 요약 종류
- 현재 보유 마일리지
- 당일 소멸 예정 마일리지
- 당월 소멸 예정 마일리지

Query parameters

userDetailUserDetailRequired

회원 정보

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

마일리지 - 잔여금액 Summary Response

crrtMlginteger · int64Optional

현재 사용 가능 마일리지

Example: 7800

tdayDappFcstMlginteger · int64Optional

당일 소멸 예정 마일리지

Example: 210

tmthDappFcstMlginteger · int64Optional

당월 소멸 예정 마일리지

Example: 300

900

업무처리 오류 내용

*/*

get/v1/mileage/mlgSum

GET /api/member/v1/mileage/mlgSum?userDetail=null HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

{
  "crrtMlg": 7800,
  "tdayDappFcstMlg": 210,
  "tmthDappFcstMlg": 300
}

마일리지 사용/적립 목록 조회

get

기능설명

마일리지 사용/적립 목록을 조회합니다.

상세설명

회원의 마일리지 사용/적립 상세 내용 목록을 조회합니다.
마일리지 조회 기간
- 1주일 : 조회하는 날짜로부터 1주일 전 까지의 데이터를 조회합니다.
- 1개월 : 조회하는 날짜로부터 1개월 전 까지의 데이터를 조회합니다.
- 3개월 : 조회하는 날짜로부터 3개월 전 까지의 데이터를 조회합니다.
- 상세조회 : 조회 시작 날짜와 종료 날짜를 설정하여 데이터를 조회합니다. 단, 3개월 이내의 데이터만 조회가 가능합니다.

Query parameters

mlgDtlListRequeststringRequired

MlgDtlListRequest

userDetailUserDetailRequired

회원 정보

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

마일리지 사용/적립 상세내역 조회 Response

totCntinteger · int64Optional

조회된 총 건수

Example: 19

pageIdxinteger · int64Optional

페이지 번호

Example: 1

900

업무처리 오류 내용

*/*

get/v1/mileage/mlgDtlList

GET /api/member/v1/mileage/mlgDtlList?mlgDtlListRequest=text&userDetail=null HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

{
  "totCnt": 19,
  "pageIdx": 1,
  "mlgList": [
    {
      "astRsrvUseGbCd": 20,
      "astRsrvUseGbNm": "사용",
      "astRsrvUseCausCd": 50,
      "astRsrvUseCausNm": "주문사용(20230816O009012)",
      "ocurDt": "2023.08.16",
      "ocurAmt": 80100
    }
  ]
}

가용 마일리지 조회

get

기능설명

회원의 사용 가능한 마일리지를 조회합니다.

상세설명

마일리지로 상품을 결제 하기 전, 회원의 사용 가능 마일리지를 조회합니다.

특이사항

외부 접속이 차단된 API로, 내부 서버에서만 접근이 가능합니다.

Query parameters

milgAvalRequeststringRequired

MilgAvalRequest

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

마일리지 - 사용가능 금액조회 Response

mlgAvalAmtinteger · int64Optional

잔여 마일리지

Example: 100000

900

업무처리 오류 내용

*/*

get/v1/mileage/mlgBalAmtInfo

GET /api/member/v1/mileage/mlgBalAmtInfo?milgAvalRequest=text HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

{
  "mlgAvalAmt": 100000
}

이전로그인

다음본인인증 결과

마지막 업데이트 7개월 전