Member Information Management

Modify Business Address

post

Function Description

Modifies the business address of the business member.

Detailed Description

Modifies the business address of the business member.
Adds a member information change history entry when the business address is modified.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

requeststringRequired

MemberBusinessAddressChgRequest

Body

Business Address Save Request

mbrNostring · min: 1Required

Member No.

Example: 100000300

bplcZipNostring · min: 1Required

Business Postal Code

Example: 5836

bplcZipAddrstring · min: 1Required

Business Postal Address

Example: 서울 송파구 법원로9길 26

bplcDtlAddrstring · min: 1Required

Business Address

Example: 서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/member/memberMgmt/updateBmanAddress

POST /api/bo/v1/member/memberMgmt/updateBmanAddress?request=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "mbrNo": 100000300,
  "bplcZipNo": 5836,
  "bplcZipAddr": "서울 송파구 법원로9길 26",
  "bplcDtlAddr": "서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층"
}

text

Register Refund Account

post

Function Description

Registers the member's refund account.

Detailed Description

Notes

The account holder name must match the member's name.
Account verification must be completed.
Required value list
- Account No.
- Bank Code
- Account Verification Status

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Refund Account Registration Request

mbrNostringOptional

Member No.

Example: 10000001

rfdBankCdstringOptional

Bank Code (OM026)

Example: 201

rfdActnNostringOptional

Account Number

Example: 1111-22-000874

rfdActnDepositorNmstringOptional

Refund Account Holder

Example: 홍길동

rfdActnCertiYnstringOptional

Account Verification Status

Example: Y

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/member/memberMgmt/saveMemberRefundActn

POST /api/bo/v1/member/memberMgmt/saveMemberRefundActn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "mbrNo": 10000001,
  "rfdBankCd": 201,
  "rfdActnNo": "1111-22-000874",
  "rfdActnDepositorNm": "홍길동",
  "rfdActnCertiYn": "Y"
}

text

Save/Modify/Delete Member Delivery Address

post

Function Description

Saves, modifies, or deletes a delivery address.

Detailed Description

Saves the member's delivery address.
Modifies the member's delivery address.
Deletes the member's delivery address.

Revision History

Release v1.06_231218: Delivery addresses can be registered up to the Reference 1 value of common code ST017.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

saveMemberDeliverystringRequired

SaveMemberDelivery

Body

Member Delivery Address Save and Delete Request

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/member/memberMgmt/saveMemberDelivery

POST /api/bo/v1/member/memberMgmt/saveMemberDelivery?saveMemberDelivery=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2262

{
  "realGridCUD": {
    "all": [
      {
        "mbrNo": 100001731,
        "mbrDlvpSeq": 1,
        "dlvpNm": "회사",
        "rcvmnNm": "플래티어",
        "baseDlvpYn": "Y",
        "zipNoSeq": 0,
        "zipNo": 5836,
        "zipAddr": "서울 송파구 문정동 법원로 9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
        "emailAddr": "venus@plateer.com",
        "cellSctNo": "010",
        "cellTxnoNo": 1234,
        "cellEndNo": 1234,
        "telRgnNo": "02",
        "telTxnoNo": 123,
        "telEndNo": 1234,
        "deliMsgCd": 10,
        "deliMsg": "부재 시 연락주세요",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrEtcMethod": "경비실 호출 하세요",
        "comnFrdrPwd": 12345,
        "useYn": "Y",
        "userSortSeq": 0
      }
    ],
    "create": [
      {
        "mbrNo": 100001731,
        "mbrDlvpSeq": 1,
        "dlvpNm": "회사",
        "rcvmnNm": "플래티어",
        "baseDlvpYn": "Y",
        "zipNoSeq": 0,
        "zipNo": 5836,
        "zipAddr": "서울 송파구 문정동 법원로 9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
        "emailAddr": "venus@plateer.com",
        "cellSctNo": "010",
        "cellTxnoNo": 1234,
        "cellEndNo": 1234,
        "telRgnNo": "02",
        "telTxnoNo": 123,
        "telEndNo": 1234,
        "deliMsgCd": 10,
        "deliMsg": "부재 시 연락주세요",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrEtcMethod": "경비실 호출 하세요",
        "comnFrdrPwd": 12345,
        "useYn": "Y",
        "userSortSeq": 0
      }
    ],
    "update": [
      {
        "mbrNo": 100001731,
        "mbrDlvpSeq": 1,
        "dlvpNm": "회사",
        "rcvmnNm": "플래티어",
        "baseDlvpYn": "Y",
        "zipNoSeq": 0,
        "zipNo": 5836,
        "zipAddr": "서울 송파구 문정동 법원로 9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
        "emailAddr": "venus@plateer.com",
        "cellSctNo": "010",
        "cellTxnoNo": 1234,
        "cellEndNo": 1234,
        "telRgnNo": "02",
        "telTxnoNo": 123,
        "telEndNo": 1234,
        "deliMsgCd": 10,
        "deliMsg": "부재 시 연락주세요",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrEtcMethod": "경비실 호출 하세요",
        "comnFrdrPwd": 12345,
        "useYn": "Y",
        "userSortSeq": 0
      }
    ],
    "delete": [
      {
        "mbrNo": 100001731,
        "mbrDlvpSeq": 1,
        "dlvpNm": "회사",
        "rcvmnNm": "플래티어",
        "baseDlvpYn": "Y",
        "zipNoSeq": 0,
        "zipNo": 5836,
        "zipAddr": "서울 송파구 문정동 법원로 9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
        "emailAddr": "venus@plateer.com",
        "cellSctNo": "010",
        "cellTxnoNo": 1234,
        "cellEndNo": 1234,
        "telRgnNo": "02",
        "telTxnoNo": 123,
        "telEndNo": 1234,
        "deliMsgCd": 10,
        "deliMsg": "부재 시 연락주세요",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrEtcMethod": "경비실 호출 하세요",
        "comnFrdrPwd": 12345,
        "useYn": "Y",
        "userSortSeq": 0
      }
    ]
  }
}

No content

Register Employee

post

Function Description

Registers a member as an employee.

Detailed Description

Registers a member as an employee.
The same employee number cannot be registered for the same company.

Revision History

Release v1.03_231106:
- INSERT into the employee discount limit and employee discount limit history tables upon initial employee registration
- UPDATE the USE_YN value of the employee discount limit table to 'N' upon employee re-registration
- When re-registering as an employee of a different company, fully exhaust the remaining employee discount limit of the existing company and INSERT into the new company's history table

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Employee Registration Request

mbrNostringOptional

Member No.

Example: 1000001

stafMgrNostringOptional

Employee No.

Example: 1001

comGbCdstringOptional

Company Classification Code

Example: P00

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/member/memberMgmt/modifyStaf

POST /api/bo/v1/member/memberMgmt/modifyStaf HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "mbrNo": 1000001,
  "stafMgrNo": 1001,
  "comGbCd": "P00"
}

No content

Save Member Contact Information

post

Function Description

Saves the member's contact information.

Detailed Description

Saves the member's contact information.
Member contact information
- Email address
- Phone number

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

requeststringRequired

MemberContactChgRequest

Body

Member Contact Information Save Request

mbrNostringOptional

Member No.

Example: 100000300

emailAddrstringOptional

Email Address

Example: venus@plateer.com

telRgnNostringOptional

Phone Area Code

Example: 02

telTxnoNostringOptional

Phone Exchange Code

Example: 123

telEndNostringOptional

Phone Last Digits

Example: 1234

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/member/memberMgmt/memberUpdateContact

POST /api/bo/v1/member/memberMgmt/memberUpdateContact?request=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "mbrNo": 100000300,
  "emailAddr": "venus@plateer.com",
  "telRgnNo": "02",
  "telTxnoNo": 123,
  "telEndNo": 1234,
  "etMbrInfoChgHistList": [
    {
      "mbrInfoChgSeq": "text",
      "mbrNo": 100000300,
      "chgTgtTypCd": "02",
      "chgCont": "임시비밀번호발급"
    }
  ]
}

No content

Save Member Address

post

Function Description

Saves the member's address.

Detailed Description

Saves the address among the member's personal information.
Adds a member information change history entry when personal information is modified.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

requeststringRequired

MemberAddressChgRequest

Body

Save Member Address Request

mbrNostringOptional

Member No.

Example: 100000300

zipNoSeqinteger · int64Optional

Postal Code Sequence No.

Example: 0

zipNostringOptional

Postal Code

Example: 5836

zipAddrstringOptional

Postal Address

Example: 서울 송파구 법원로9길 26

dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층

nafrGbCdstringOptional

Domestic 10, Overseas 20

Example: 10

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/member/memberMgmt/memberUpdateAddress

POST /api/bo/v1/member/memberMgmt/memberUpdateAddress?request=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "mbrNo": 100000300,
  "zipNoSeq": 0,
  "zipNo": 5836,
  "zipAddr": "서울 송파구 법원로9길 26",
  "dtlAddr": "에이치비지니스파크 D동 6층",
  "nafrGbCd": 10,
  "etMbrInfoChgHist": {
    "mbrInfoChgSeq": "text",
    "mbrNo": 100000300,
    "chgTgtTypCd": "02",
    "chgCont": "임시비밀번호발급"
  }
}

No content

Password Reset

post

Function Description

Resets the password.

Detailed Description

Resets the member's password.
When a customer loses their password, a randomly combined password is set and delivered to the member's registered phone number.
The temporary password is generated as a 10-character combination of uppercase letters, lowercase letters, and numbers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

requeststringRequired

MemberInitPwdRequest

Body

Reset Password Request

loginIdstringOptional

Example: venus17

mbrNostringOptional

Member No.

Example: 100000300

pwdIniCausContstringOptional

Password Reset Reason

Example: 비밀번호 분실

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/member/memberMgmt/initializePassword

POST /api/bo/v1/member/memberMgmt/initializePassword?request=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "loginId": "venus17",
  "mbrNo": 100000300,
  "pwdIniCausCont": "비밀번호 분실"
}

text

Retrieve Consent History List

get

Function Description

Retrieves the member's consent history list.

Detailed Description

Retrieves the member's marketing consent history list.
A history entry accumulates each time the member changes their marketing consent.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

MemberDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v2/member/memberMgmt/getAgreeHistory

GET /api/bo/v2/member/memberMgmt/getAgreeHistory?request=[object+Object]&MemberDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "siteNm": "플래티어닷컴",
      "svcAgrTypNm": "이메일수신동의",
      "agrYn": "Y",
      "sysRegDtm": "2023-05-11 12:30:00"
    }
  ]
}

Retrieve Marketing/Service Consent List

get

Function Description

Retrieves the member's marketing/service consent list.

Detailed Description

Retrieves the count of the member's marketing/service consent list.
Consent list
- SMS Consent
- Email Consent
- Push Notification Consent

Revision History

Release_240125_01: Added Kakao consent

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ServiceAgreeHistRequeststringRequired

ServiceAgreeHistRequest

Responses

200

Success

*/*

Marketing/Service Consent List Response

siteNmstringOptional

Site Name

Example: 플래티어닷컴

smsRecvAgrYnstringOptional

SMS Consent

Example: Y

emailRecvAgrYnstringOptional

Email Consent

Example: Y

appPushAgrYnstringOptional

Push Notification Consent

Example: Y

kakaoRecvAgrYnstringOptional

Kakao Consent

Example: Y

900

Business processing error details

*/*

get/v1/member/memberMgmt/getServiceAgreeHist

GET /api/bo/v1/member/memberMgmt/getServiceAgreeHist?request=[object+Object]&ServiceAgreeHistRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "siteNm": "플래티어닷컴",
    "smsRecvAgrYn": "Y",
    "emailRecvAgrYn": "Y",
    "appPushAgrYn": "Y",
    "kakaoRecvAgrYn": "Y"
  }
]

Retrieve Marketing/Service Consent List Count

get

Function Description

Retrieves the count of the member's marketing/service consent list.

Detailed Description

Retrieves the count of the member's marketing/service consent list.
Consent list
- SMS Consent
- Email Consent
- Push Notification Consent

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ServiceAgreeHistRequeststringRequired

ServiceAgreeHistRequest

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getServiceAgreeHistCount

GET /api/bo/v1/member/memberMgmt/getServiceAgreeHistCount?request=[object+Object]&ServiceAgreeHistRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Product Review List

get

Function Description

Retrieves the member's product review list.

Detailed Description

Retrieves the list of product reviews written by the member.
Retrieves the count of product reviews written by the member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

GoodsReviewRequeststringRequired

GoodsReviewRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getProductReview

GET /api/bo/v1/member/memberMgmt/getProductReview?request=[object+Object]&GoodsReviewRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "revNo": "text",
      "revCont": "text",
      "revGbCd": 10,
      "revGbNm": "text",
      "ansCont": "text",
      "revContCnt": "text",
      "reco": "text",
      "replyCnt": "text",
      "goodsNo": "text",
      "goodsNm": "text",
      "revScrVal": "text",
      "ansCnt": 1
    }
  ]
}

Retrieve Product Q&A List

get

Function Description

Retrieves the member's product Q&A list.

Detailed Description

Retrieves the list of product Q&As submitted by the member.
Retrieves the count of product Q&As submitted by the member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

GoodsQaRequeststringRequired

GoodsQaRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getProductQa

GET /api/bo/v1/member/memberMgmt/getProductQa?request=[object+Object]&GoodsQaRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "questNo": "text",
      "questTypCdNm": "text",
      "procStatCdNm": "text",
      "questCont": "상품문의",
      "mdId": "text"
    }
  ]
}

Retrieve Participated Event List

get

Function Description

Retrieves the list of events the member has participated in.

Detailed Description

Retrieves the list of events the member has participated in.
Retrieves the count of events the member has participated in.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getParticipationEvent

GET /api/bo/v1/member/memberMgmt/getParticipationEvent?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "evtNo": "text",
      "evtNm": "text",
      "aplyDt": "text",
      "strDt": "text",
      "endDt": "text",
      "evtPrgsStatCd": "text",
      "evtPrgsStatNm": "text",
      "winDt": "text",
      "winYn": "text"
    }
  ]
}

Retrieve Domestic/Foreign Status

get

Function Description

Retrieves domestic/foreign status.

Detailed Description

Retrieves the member's domestic/foreign status.

Notes

This API only uses the mbrNo field of the Request DTO.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

requeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getNafrGbNmYn

GET /api/bo/v1/member/memberMgmt/getNafrGbNmYn?request=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Retrieve Mileage List

get

Function Description

Retrieves the member's mileage list.

Detailed Description

Retrieves the member's mileage list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

anyRequired

Responses

200

Success

*/*

Retrieve Mileage List Response

astRsrvUseGbNmstringOptional

Type

Example: 적립

astRsrvUseCausNmstringOptional

Reason

Example: 주문적립

ocurDtmstring · date-timeOptional

Processing Date/Time

Example: 2023-01-01 12:00:00

ocurAmtnumberOptional

Accrued/Used Amount

Example: 1000

balAmtnumberOptional

Balance

Example: 1000

astMgrNostringOptional

Related No.

Example: 1

valiEndDtstringOptional

Usage End Date/Time

Example: 2023-01-01

astMgrMemostringOptional

Memo

Example: Text

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMilgHistory

GET /api/bo/v1/member/memberMgmt/getMilgHistory?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "astRsrvUseGbNm": "적립",
    "astRsrvUseCausNm": "주문적립",
    "ocurDtm": "2023-01-01 12:00:00",
    "ocurAmt": 1000,
    "balAmt": 1000,
    "astMgrNo": 1,
    "valiEndDt": "2023-01-01",
    "astMgrMemo": "Text"
  }
]

Retrieve Refund Account Information

get

Function Description

Retrieves the member's refund account information.

Detailed Description

Retrieves the member's refund account information.
If valid authorization is not present, the account information is masked.
For a non-member, retrieves the refund account information corresponding to the order number.
Masking list
- Member Name
- Refund Account No.
- Refund Account Holder Name

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

MemberDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Refund Account Information Response

mbrNostringOptional

Member No.

Example: 10000001

mbrNmstringOptional

Member Name

Example: 홍길동

rfdActnNostringOptional

Refund Account No.

Example: 11111-00-124111

rfdActnDepositorNmstringOptional

Refund Account Holder

Example: 홍길동

rfdActnCertiYnstringOptional

Refund Account Verification Status

Example: Y

rfdBankCdstringOptional

Refund Account Bank Code

Example: 201

loginIdstringOptional

Member ID

Example: x2bee12

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberRefundActnInfo

GET /api/bo/v1/member/memberMgmt/getMemberRefundActnInfo?mbrDetailRequest=[object+Object]&MemberDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mbrNo": 10000001,
  "mbrNm": "홍길동",
  "rfdActnNo": "11111-00-124111",
  "rfdActnDepositorNm": "홍길동",
  "rfdActnCertiYn": "Y",
  "rfdBankCd": 201,
  "loginId": "x2bee12"
}

Retrieve Member Customs Clearance No. - List

get

Function Description

Retrieves the member's customs clearance number history.

Detailed Description

Retrieves the customs clearance number search list for the target member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Customs Clearance No. Retrieval Response

mbrNostringOptional

Member No.

Example: 100000300

rcvmnNmstringOptional

Recipient Name

Example: 홍길동

cellPhonestringOptional

Mobile Phone Number

Example: 1012345678

zipNostringOptional

Postal Code

Example: 12345

persCstmCdstringOptional

Personal Customs Clearance Number

Example: P1234567890123

sysRegIdstringOptional

Registrant ID

Example: admin

sysRegDtmstringOptional

Registration Date/Time

Example: 2022-08-17 17:39:36

sysModIdstringOptional

Modifier ID

Example: admin

sysModDtmstringOptional

Modification Date/Time

Example: 2022-08-17 17:39:36

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberPcccInfoListByMemberNoData

GET /api/bo/v1/member/memberMgmt/getMemberPcccInfoListByMemberNoData?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "mbrNo": 100000300,
    "rcvmnNm": "홍길동",
    "cellPhone": 1012345678,
    "zipNo": 12345,
    "persCstmCd": "P1234567890123",
    "sysRegId": "admin",
    "sysRegDtm": "2022-08-17 17:39:36",
    "sysModId": "admin",
    "sysModDtm": "2022-08-17 17:39:36"
  }
]

Member List Retrieval

get

Function Description

Retrieves the member list.

Detailed Description

Retrieves the list of members matching the given conditions data.
Search conditions
- Period search
  - Searches by setting a start date and end date based on the member registration date.
  - The search period cannot exceed 30 days.
- Full period search
  - When searching the full period, enter member information (member name or member number or login ID) or mobile phone number to search.

Revision History

Release v1.07_231228: Removed the member status code from the Request (search conditions) due to removal of the dormant member logic
Release v2.00_240613: Improved period search condition
Release v2.00_240627: Modified due to addition of (ME025) Kakao Talk service type
Release v2.00_250711: Added business member search condition (for business members, only approved members are searched)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrMgmtSearchRequestMemberMgmtSearchRequestRequired

Member List Retrieval

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberList

GET /api/bo/v1/member/memberMgmt/getMemberList?mbrMgmtSearchRequest=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "mbrNo": 100000300,
      "socialNm": "네이버",
      "mbrNm": "홍*동",
      "mbrStatCd": 10,
      "loginId": "ven***************",
      "emailAddr": "ves*****@plateer.com",
      "cellNo": "010-****-1234",
      "zipAddr": "서울 송파구 ******",
      "dtlAddr": "***",
      "mbrJoinDtm": "2023-08-17 17:39:36",
      "sysModId": 999999999,
      "sysModDtm": "2023-09-12 17:39:36",
      "joinGbCd": 10,
      "mbrMgrCd": 99,
      "mbrMgrNm": "소셜회원",
      "mbrGradeNm": "GREEN",
      "mbrStatNm": "정상회원",
      "stafYn": "N",
      "mbrCareConsumeYn": "N",
      "siteNm": "x2bee",
      "smsRecvAgrYn": "N",
      "emailRecvAgrYn": "N",
      "appPushAgrYn": "N",
      "kakaoRecvAgrYn": "N"
    }
  ]
}

Retrieve Member Additional Information

get

Function Description

Retrieves the member's additional information.

Detailed Description

Retrieves the member's additional information.

Revision History

Release v2.00_240530: Added social login (Google, Apple)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

MemberDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Additional Information Response

mbrJoinDtmstring · date-timeOptional

Membership Registration Date/Time

Example: 2023-01-01 12:30:00

lstLoginDtmstring · date-timeOptional

Last Login Date/Time

Example: 2023-01-01 12:30:00

lstOrdDtmstring · date-timeOptional

Last Order Date/Time

Example: 2023-01-01 12:30:00

snsLinkYnstringOptional

SNS Integration Status

Example: Y

snsLinkStrDtmstring · date-timeOptional

SNS Integration Date and Time

Example: 2023-01-01 12:30:00

siteNostringOptional

Registered Site No.

Example: 1

siteNmstringOptional

Registration Site Name

Example: 플래티어닷컴

pwdChgDtmstringOptional

Password Change Date/Time

Example: 2023-01-01 12:30:00

stpRvcDtstringOptional

Dormant Status Release Date

Example: 2023-01-01

lgcMbrNostringOptional

Core System Member No.

Example: 123456

mbrNostringOptional

Member No.

Example: 10000001

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberJoinInfo

GET /api/bo/v1/member/memberMgmt/getMemberJoinInfo?request=[object+Object]&MemberDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mbrJoinDtm": "2023-01-01 12:30:00",
  "lstLoginDtm": "2023-01-01 12:30:00",
  "lstOrdDtm": "2023-01-01 12:30:00",
  "snsLinkYn": "Y",
  "snsLinkStrDtm": "2023-01-01 12:30:00",
  "siteNo": 1,
  "siteNm": "플래티어닷컴",
  "pwdChgDtm": "2023-01-01 12:30:00",
  "stpRvcDt": "2023-01-01",
  "lgcMbrNo": 123456,
  "mbrNo": 10000001,
  "snsLinkInfoList": [
    {
      "mbrNo": "text",
      "smpctAcctLinkGbCd": "text",
      "smpctAcctLinkGbCdNm": "text",
      "snsLinkYn": "text",
      "snsLinkStrDtm": "2026-01-01T00:00:00.000Z",
      "snsLinkEndDtm": "2026-01-01T00:00:00.000Z",
      "snsLinkId": "text",
      "snsMbrNo": "text",
      "rmkConts": "text"
    }
  ]
}

Retrieve Member Details

get

Function Description

Retrieves the member's detail information.

Detailed Description

Retrieves the member's personal information and detail content.
Personal information masking conditions
- When the administrator does not have personal information viewing authorization
- When the administrator has personal information viewing authorization but does not have authorization for the corresponding item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberInfo

GET /api/bo/v1/member/memberMgmt/getMemberInfo?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "memberInfo": {
    "mbrNo": 100000300,
    "mbrNm": "플래티어",
    "loginId": "venus17",
    "id": "venus17",
    "mbrMgrCd": 10,
    "mbrGbNm": "정회원",
    "mbrMgrNm": "일반회원",
    "stafMgrNo": 2134,
    "instMbrYn": "N",
    "instMbrGb": "VIP/주문주의",
    "ordLmtYn": "N",
    "stafYn": "Y",
    "mbrStatCd": 10,
    "mbrStatNm": "정상회원",
    "mbrGradeNm": "GREEN",
    "solarYn": "Y",
    "brth": 19990101,
    "sexGbNm": "남",
    "nafrGbNm": "Y",
    "telNo": "02-123-1234",
    "telRgnNo": "02",
    "telTxnoNo": 123,
    "telEndNo": 1234,
    "cellNo": "010-1234-1234",
    "cellSctNo": "010",
    "cellTxnoNo": 1234,
    "cellEndNo": 1234,
    "emailAddr": "venus@plateer.com",
    "zipNoSeq": 0,
    "zipNo": 5836,
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "zipAddr": "서울 송파구 법원로9길 26",
    "siteNo": 1,
    "joinGbNm": "국문",
    "adlCertiYn": "Y",
    "adlCertiDtm": "2023-08-17 17:39:36",
    "mbrJoinDtm": "2023-08-17 17:39:36",
    "frstOrdDtm": "2023-08-17 17:39:36",
    "lstOrdDtm": "2023-08-17 17:39:36",
    "frstLoginDtm": "2023-08-17 17:39:36",
    "lstLoginDtm": "2023-08-17 17:39:36",
    "mbrCertiGbNm": "본인인증",
    "pwdQuestCont": "text",
    "pwdAnsCont": "text",
    "pwdFailCnt": 1,
    "pwdIniYn": "N",
    "pwdChgDtm": "2023-08-17 17:39:36",
    "pwdIniCausCont": "비밀번호 분실",
    "ciCtacVal": "xksiajw77s221aZXSa",
    "stpProcDt": "2023-08-17 17:39:36",
    "stpRvcDt": "2023-08-17 17:39:36",
    "mbrWdraDtm": "2023-08-17 17:39:36",
    "mbrWdraCausCont": "사이트 이용 계획 없음",
    "comGbNm": "플래티어",
    "smpctAcctLinkGbCd": 20,
    "smpctAcctLinkGbNm": "카카오",
    "bmanRegNo": 1234567890123,
    "bmanRegDt": 20230817,
    "rpstmnNm": "홍길동",
    "repTelSctNo": "02-123-1234",
    "repTelTxnoNo": 123,
    "repTelEndNo": 1234,
    "repTelNo": 10,
    "bmanNm": "플래티어",
    "bplcZipNo": 5836,
    "bplcZipAddr": "서울 송파구 법원로9길 26",
    "bplcDtlAddr": "에이치비지니스파크 D동 6층",
    "atchFilePathNm": "https://www.plateer.com/attach/bman/1234567890123.jpg",
    "aempNm": "홍길동",
    "aempCellSctNo": "010",
    "aempCellTxnoNo": 1234,
    "aempCellEndNo": 1234
  },
  "realGridList": {
    "totalCount": 1,
    "payloads": [
      {
        "mbrNo": 100001731,
        "mbrDlvpSeq": 1,
        "dlvpNm": "회사",
        "rcvmnNm": "플래티어",
        "baseDlvpYn": "Y",
        "nafrGbNmYn": "Y",
        "zipNoSeq": 1,
        "zipNo": 5836,
        "zipAddr": "서울 송파구 문정동 법원로 9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
        "emailAddr": "venus@plateer.com",
        "telNo": "02-123-1234",
        "telRgnNo": "02",
        "telTxnoNo": 123,
        "telEndNo": 1234,
        "cellNo": "010-1234-1234",
        "cellSctNo": "010",
        "cellTxnoNo": 1234,
        "cellEndNo": 1234,
        "deliMsgCd": 10,
        "deliMsgNm": "문 앞에 두고 가주세요.",
        "deliMsg": "부재 시 연락주세요",
        "comnFrdrCogoMethodCd": 10,
        "comnFrdrCogoMethodNm": "공통현관 출입번호",
        "comnFrdrEtcMethod": "경비실 호출 하세요",
        "comnFrdrPwd": 12345,
        "useYn": "Y",
        "sysRegId": 999999999,
        "sysRedDtm": "2023-08-17 17:39:36",
        "sysModId": 999999999,
        "sysModDtm": "2023-08-17 17:39:36"
      }
    ]
  }
}

Retrieve Member History List

get

Function Description

Dynamically retrieves the member's various history lists.

Detailed Description

The member's personal information change history can be dynamically retrieved according to history type.
Supports various history types such as address (11), mobile phone number (12), phone number (13), email (14), etc.
Multiple history types can be retrieved at once via the history type list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

memberHistoryRequeststringRequired

MemberHistoryRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberHistoryList

GET /api/bo/v1/member/memberMgmt/getMemberHistoryList?memberHistoryRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "mbrNo": 100000151,
      "mbrNm": "홍길동",
      "chgTgtTypCd": 11,
      "chgTgtTypNm": "주소",
      "chgCont": "서울 송파구 법원로9길 26",
      "sysRegId": 999999999,
      "sysRegDtm": "2023-07-26 18:38:07",
      "mbrInfoChgSeq": 1
    }
  ]
}

Retrieve Member Grade History - List

get

Function Description

Retrieves the member grade history.

Detailed Description

Retrieves the member grade change history list for the target member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Grade History Retrieval Response

mbrNostringOptional

Member No.

Example: 100000300

mbrGradeCdstringOptional

Member Grade Code (ME008)

Example: 20

mbrGradeNmstringOptional

Member Grade Name (ME008)

Example: VVIP

histStrDtmstringOptional

History Start Date/Time

Example: 2022-08-17 17:39:36

histEndDtmstringOptional

History End Date/Time

Example: 2023-08-17 17:39:36

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberGradeHistoryByMemberNoData

GET /api/bo/v1/member/memberMgmt/getMemberGradeHistoryByMemberNoData?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "mbrNo": 100000300,
    "mbrGradeCd": 20,
    "mbrGradeNm": "VVIP",
    "histStrDtm": "2022-08-17 17:39:36",
    "histEndDtm": "2023-08-17 17:39:36"
  }
]

Retrieve Member Grade History Count

get

Function Description

Retrieves the total count of the member grade history list.

Detailed Description

Retrieves the total count of member grade change history for the target member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberGradeHistoryByMemberNoCount

GET /api/bo/v1/member/memberMgmt/getMemberGradeHistoryByMemberNoCount?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Delivery Address (Unmasked)

get

Function Description

Retrieves the delivery address list.

Detailed Description

Retrieves the list of delivery addresses registered by the member.
The member's personal information is displayed regardless of the administrator's personal information viewing authorization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

memberDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Delivery Address Personal Information Unmasked Retrieval Response

mbrNostringOptional

Member No.

Example: 100001731

mbrDlvpSeqstringOptional

Member Delivery Address Sequence No.

Example: 1

dlvpNmstringOptional

Delivery Address Name

Example: 회사

rcvmnNmstringOptional

Recipient Name

Example: 플래티어

baseDlvpYnstringOptional

Default Delivery Address Status

Example: Y

nafrGbNmYnstringOptional

Domestic/Foreign Status

Example: Y

zipNoSeqinteger · int64Optional

Postal Code Sequence No.

Example: 0

zipNostringOptional

Postal Code

Example: 5836

zipAddrstringOptional

Postal Address

Example: 서울 송파구 문정동 법원로 9길 26

dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층 플래티어

emailAddrstringOptional

Email Address

Example: venus@plateer.com

telNostringOptional

Phone Number

Example: 02-123-1234

telRgnNostringOptional

Phone Area Code

Example: 02

telTxnoNostringOptional

Phone Exchange Code

Example: 123

telEndNostringOptional

Phone Last Digits

Example: 1234

cellNostringOptional

Mobile Phone Number

Example: 010-1234-1234

cellSctNostringOptional

Mobile Phone Prefix Code

Example: 010

cellTxnoNostringOptional

Mobile Phone Exchange Code

Example: 1234

cellEndNostringOptional

Mobile Phone Last Digits

Example: 1234

deliMsgCdstringOptional

Delivery Message Code (ME039)

Example: 10

deliMsgNmstringOptional

Delivery Message Code Name (ME039)

Example: 문 앞에 두고 가주세요.

deliMsgstringOptional

Delivery Message

Example: 부재 시 연락주세요

comnFrdrCogoMethodCdstringOptional

Common Entrance Access Method Code (ME040)

Example: 10

comnFrdrCogoMethodNmstringOptional

Common Entrance Access Method Code Name (ME040)

Example: 공통현관 출입번호

comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 경비실 호출 하세요

comnFrdrPwdstringOptional

Common Entrance Password

Example: 12345

useYnstringOptional

Usage Status

Example: Y

sysRegIdstringOptional

System Registrant ID

Example: 999999999

sysRedDtmstringOptional

System Registration Date/Time

Example: 2023-08-17 17:39:36

sysModIdstringOptional

System Modifier ID

Example: 999999999

sysModDtmstringOptional

System Modification Date/Time

Example: 2023-08-17 17:39:36

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberDeliveryNoMasking

GET /api/bo/v1/member/memberMgmt/getMemberDeliveryNoMasking?memberDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mbrNo": 100001731,
  "mbrDlvpSeq": 1,
  "dlvpNm": "회사",
  "rcvmnNm": "플래티어",
  "baseDlvpYn": "Y",
  "nafrGbNmYn": "Y",
  "zipNoSeq": 0,
  "zipNo": 5836,
  "zipAddr": "서울 송파구 문정동 법원로 9길 26",
  "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
  "emailAddr": "venus@plateer.com",
  "telNo": "02-123-1234",
  "telRgnNo": "02",
  "telTxnoNo": 123,
  "telEndNo": 1234,
  "cellNo": "010-1234-1234",
  "cellSctNo": "010",
  "cellTxnoNo": 1234,
  "cellEndNo": 1234,
  "deliMsgCd": 10,
  "deliMsgNm": "문 앞에 두고 가주세요.",
  "deliMsg": "부재 시 연락주세요",
  "comnFrdrCogoMethodCd": 10,
  "comnFrdrCogoMethodNm": "공통현관 출입번호",
  "comnFrdrEtcMethod": "경비실 호출 하세요",
  "comnFrdrPwd": 12345,
  "useYn": "Y",
  "sysRegId": 999999999,
  "sysRedDtm": "2023-08-17 17:39:36",
  "sysModId": 999999999,
  "sysModDtm": "2023-08-17 17:39:36"
}

Retrieve Delivery Address (Masked)

get

Function Description

Retrieves the delivery address list.

Detailed Description

Retrieves the list of delivery addresses registered by the member.
All of the member's personal information is displayed masked regardless of the administrator's personal information viewing authorization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberDeliveryMaskingList

GET /api/bo/v1/member/memberMgmt/getMemberDeliveryMaskingList?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "mbrNo": 100001731,
      "mbrDlvpSeq": 1,
      "dlvpNm": "회사",
      "rcvmnNm": "플래티어",
      "baseDlvpYn": "Y",
      "nafrGbNmYn": "Y",
      "zipNoSeq": 1,
      "zipNo": 5836,
      "zipAddr": "서울 송파구 문정동 법원로 9길 26",
      "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
      "emailAddr": "venus@plateer.com",
      "telNo": "02-123-1234",
      "telRgnNo": "02",
      "telTxnoNo": 123,
      "telEndNo": 1234,
      "cellNo": "010-1234-1234",
      "cellSctNo": "010",
      "cellTxnoNo": 1234,
      "cellEndNo": 1234,
      "deliMsgCd": 10,
      "deliMsgNm": "문 앞에 두고 가주세요.",
      "deliMsg": "부재 시 연락주세요",
      "comnFrdrCogoMethodCd": 10,
      "comnFrdrCogoMethodNm": "공통현관 출입번호",
      "comnFrdrEtcMethod": "경비실 호출 하세요",
      "comnFrdrPwd": 12345,
      "useYn": "Y",
      "sysRegId": 999999999,
      "sysRedDtm": "2023-08-17 17:39:36",
      "sysModId": 999999999,
      "sysModDtm": "2023-08-17 17:39:36"
    }
  ]
}

Retrieve Member Delivery Address - List

get

Function Description

Retrieves the delivery address list.

Detailed Description

Retrieves the list of delivery addresses registered by the member.
Personal information is displayed masked according to the administrator's personal information viewing authorization.
Personal information masking display conditions
- When the administrator does not have personal information viewing authorization
- When the administrator has personal information viewing authorization but does not have authorization for the corresponding item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Delivery Address Retrieval Response

mbrNostringOptional

Member No.

Example: 100001731

mbrDlvpSeqstringOptional

Member Delivery Address Sequence No.

Example: 1

dlvpNmstringOptional

Delivery Address Name

Example: 회사

rcvmnNmstringOptional

Recipient Name

Example: 플래티어

baseDlvpYnstringOptional

Default Delivery Address Status

Example: Y

nafrGbNmYnstringOptional

Domestic/Foreign Status

Example: Y

zipNoSeqinteger · int64Optional

Postal Code Sequence No.

zipNostringOptional

Postal Code

Example: 5836

zipAddrstringOptional

Postal Address

Example: 서울 송파구 문정동 법원로 9길 26

dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층 플래티어

emailAddrstringOptional

Email Address

Example: venus@plateer.com

telNostringOptional

Phone Number

Example: 02-123-1234

telRgnNostringOptional

Phone Area Code

Example: 02

telTxnoNostringOptional

Phone Exchange Code

Example: 123

telEndNostringOptional

Phone Last Digits

Example: 1234

cellNostringOptional

Mobile Phone Number

Example: 010-1234-1234

cellSctNostringOptional

Mobile Phone Prefix Code

Example: 010

cellTxnoNostringOptional

Mobile Phone Exchange Code

Example: 1234

cellEndNostringOptional

Mobile Phone Last Digits

Example: 1234

deliMsgCdstringOptional

Delivery Message Code (ME039)

Example: 10

deliMsgNmstringOptional

Delivery Message Code Name (ME039)

Example: 문 앞에 두고 가주세요.

deliMsgstringOptional

Delivery Message

Example: 부재 시 연락주세요

comnFrdrCogoMethodCdstringOptional

Common Entrance Access Method Code (ME040)

Example: 10

comnFrdrCogoMethodNmstringOptional

Common Entrance Access Method Code Name (ME040)

Example: 공통현관 출입번호

comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 경비실 호출 하세요

comnFrdrPwdstringOptional

Common Entrance Password

Example: 12345

useYnstringOptional

Usage Status

Example: Y

sysRegIdstringOptional

System Registrant ID

Example: 999999999

sysRedDtmstringOptional

System Registration Date/Time

Example: 2023-08-17 17:39:36

sysModIdstringOptional

System Modifier ID

Example: 999999999

sysModDtmstringOptional

System Modification Date/Time

Example: 2023-08-17 17:39:36

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberDeliveryList

GET /api/bo/v1/member/memberMgmt/getMemberDeliveryList?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "mbrNo": 100001731,
    "mbrDlvpSeq": 1,
    "dlvpNm": "회사",
    "rcvmnNm": "플래티어",
    "baseDlvpYn": "Y",
    "nafrGbNmYn": "Y",
    "zipNoSeq": 1,
    "zipNo": 5836,
    "zipAddr": "서울 송파구 문정동 법원로 9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층 플래티어",
    "emailAddr": "venus@plateer.com",
    "telNo": "02-123-1234",
    "telRgnNo": "02",
    "telTxnoNo": 123,
    "telEndNo": 1234,
    "cellNo": "010-1234-1234",
    "cellSctNo": "010",
    "cellTxnoNo": 1234,
    "cellEndNo": 1234,
    "deliMsgCd": 10,
    "deliMsgNm": "문 앞에 두고 가주세요.",
    "deliMsg": "부재 시 연락주세요",
    "comnFrdrCogoMethodCd": 10,
    "comnFrdrCogoMethodNm": "공통현관 출입번호",
    "comnFrdrEtcMethod": "경비실 호출 하세요",
    "comnFrdrPwd": 12345,
    "useYn": "Y",
    "sysRegId": 999999999,
    "sysRedDtm": "2023-08-17 17:39:36",
    "sysModId": 999999999,
    "sysModDtm": "2023-08-17 17:39:36"
  }
]

Retrieve Member Delivery Address Count

get

Function Description

Retrieves the count of the delivery address list.

Detailed Description

Retrieves the total count of the delivery address list registered by the member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberDeliveryListCount

GET /api/bo/v1/member/memberMgmt/getMemberDeliveryListCount?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Member Contact Information Change History List

get

Function Description

Retrieves the member's contact information history list.

Detailed Description

Retrieves the contact information change history among the member's personal information change history.
Personal information is displayed masked according to the administrator's personal information viewing authorization.
Personal information masking display conditions
- When the administrator does not have personal information viewing authorization
- When the administrator has personal information viewing authorization but does not have authorization for the corresponding item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Member Contact Information History Retrieval Response

chgTgtTypNmstringOptional

Change Target Type Code Name (ME004)

Example: 휴대폰번호

chgTgtTypCdstringOptional

Change Target Type Code (ME004)

Example: 12

chgCellNostringOptional

Mobile Phone No. Change Content

Example: 01012341234

chgTelNostringOptional

Phone Number Change Content

Example: 021231234

chgEmailstringOptional

Email Change Content

Example: venus@plateer.com

sysRegIdstringOptional

Registrant > Modifier

Example: 999999999

sysRegDtmstringOptional

Registration Date/Time > Modification Date/Time

Example: 2023-07-26 18:38:07

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberContactHistoryByMemberNoData

GET /api/bo/v1/member/memberMgmt/getMemberContactHistoryByMemberNoData?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "chgTgtTypNm": "휴대폰번호",
    "chgTgtTypCd": 12,
    "chgCellNo": "01012341234",
    "chgTelNo": "021231234",
    "chgEmail": "venus@plateer.com",
    "sysRegId": 999999999,
    "sysRegDtm": "2023-07-26 18:38:07"
  }
]

Retrieve Member Contact Information Change History Count

get

Function Description

Retrieves the total count of the member's contact information change history.

Detailed Description

Retrieves the total count of contact information change history among the member's personal information change history.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberContactHistoryByMemberNoCount

GET /api/bo/v1/member/memberMgmt/getMemberContactHistoryByMemberNoCount?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Business Contact Person Information Change History List

get

Function Description

Retrieves the business contact person information change history list.

Detailed Description

Retrieves the business contact person information change history list.
Personal information is displayed masked according to the administrator's personal information viewing authorization.
Personal information masking display conditions
- When the administrator does not have personal information viewing authorization
- When the administrator has personal information viewing authorization but does not have authorization for the corresponding item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberAempHistory

GET /api/bo/v1/member/memberMgmt/getMemberAempHistory?memberHistoryRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "aempNm": "홍길동",
      "aempCellNo": 1012345678,
      "sysRegId": 999999999,
      "sysRegDtm": "2023-07-26 18:38:07"
    }
  ]
}

Retrieve Address Change History List

get

Function Description

Retrieves the address change history list.

Detailed Description

Retrieves the address change history list among the member's personal information change history.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

Address Change History Retrieval Response

chgTgtTypNmstringOptional

Change Target Type Code Name (ME004)

Example: 주소

chgContstringOptional

Change Content

Example: 서울 송파구 법원로9길 26에이치비지니스파크 D동 6층

sysRegIdstringOptional

Registrant > Modifier

Example: 999999999

sysRegDtmstringOptional

Registration Date/Time > Modification Date/Time

Example: 2023-07-26 18:38:07

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberAddressHistoryByMemberNoData

GET /api/bo/v1/member/memberMgmt/getMemberAddressHistoryByMemberNoData?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "chgTgtTypNm": "주소",
    "chgCont": "서울 송파구 법원로9길 26에이치비지니스파크 D동 6층",
    "sysRegId": 999999999,
    "sysRegDtm": "2023-07-26 18:38:07"
  }
]

Retrieve Address Change History Count

get

Function Description

Retrieves the total count of the address change history.

Detailed Description

Retrieves the total count of the address change history list among the member's personal information change history.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMemberAddressHistoryByMemberNoCount

GET /api/bo/v1/member/memberMgmt/getMemberAddressHistoryByMemberNoCount?mbrDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Mileage

get

Function Description

Retrieves the member's mileage.

Detailed Description

Retrieves the member's available mileage.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

MemberDetailRequeststringRequired

MemberDetailRequest

Responses

200

Success

*/*

integer · int64Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMbrMilg

GET /api/bo/v1/member/memberMgmt/getMbrMilg?request=[object+Object]&MemberDetailRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieve Coupon Count

get

Function Description

Retrieves the member's coupon count.

Detailed Description

Retrieves the count of valid coupons currently usable by the member.
The free shipping coupon count, general coupon count, and compensation coupon count are retrieved.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrNostringRequired

Member No.

Responses

200

Success

*/*

Coupon Count Retrieval Response

freeCntstringOptional

Free Shipping Coupon Count

Example: 1

gnrCntstringOptional

General Coupon Count

Example: 1

cpstCntstringOptional

Compensation Coupon Count

Example: 1

900

Business processing error details

*/*

get/v1/member/memberMgmt/getMbrCpnCntList

GET /api/bo/v1/member/memberMgmt/getMbrCpnCntList?mbrNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "freeCnt": 1,
  "gnrCnt": 1,
  "cpstCnt": 1
}

Retrieve Customer Center 1:1 Inquiry List

get

Function Description

Retrieves the member's Customer Center 1:1 Inquiry list.

Detailed Description

Retrieves the list of 1:1 inquiries submitted by the member to Customer Center.
Retrieves the count of 1:1 inquiries submitted by the member to Customer Center.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

CustomerCenterRequeststringRequired

CustomerCenterRequest

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/member/memberMgmt/getCustomerCenter

GET /api/bo/v1/member/memberMgmt/getCustomerCenter?request=[object+Object]&CustomerCenterRequest=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ccnNo": 11111,
      "mbrNo": 1000001,
      "reqCtg": "1:1문의",
      "ccnPrgsStatCd": 20,
      "ccnPrgsStatNm": "처리중",
      "accpDtm": "2023-05-10 12:30:00",
      "ansDtm": "2023-05-10 12:30:00",
      "accpTitle": "문의",
      "hierarchyCustInqTypNm": "배송>배송확인"
    }
  ]
}

PreviousEmployee Discount Limit Management

NextMember Signup Approval Information Management

Last updated 2 months ago