For the complete documentation index, see llms.txt. This page is also available as Markdown.

Interested Customer Information Management

Unregister Interested Customer

post

Function Description

  • Unregisters the specified member from interested customers.


Detailed Description

  • Processes a list of member numbers.

Authorizations
Body

Interested Member Unregistration Request

instMbrSeqListstring[]Optional

Interested Member Sequence No. List

Responses
200

Success

No content

post/v1/member/instCusMgmt/rvcInstCus
POST /api/bo/v1/member/instCusMgmt/rvcInstCus HTTP/1.1
Host: api-bo.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "instMbrSeqList": [
    "text"
  ]
}

No content

Register Interested Customer

post

Function Description

  • Registers the specified member as an interested customer.


Detailed Description

  • Required value list

    • Member No.

    • Management Type Code

    • Management Category Code

    • Registration Reason

Authorizations
Body

Interested Member Information Entity

instMbrSeqstringOptional

Watched Member Sequence No.

Example: 1
mbrNostringOptional

Member No.

Example: 10000001
mgrGbCdstringOptional

Management Type Code (ME019)

Example: 30
mgrTypCdstringOptional

Management Type Code (ME009)

Example: 301
ordNostringOptional

Order No.

Example: 20230914O58297
regCausContstringOptional

Registration Reason

Example: Text
mgrMbrRegIdstringOptional

Managed Member Registration ID

Example: x2bee12
mgrMbrRegDtmstring · date-timeOptional

Managed Member Registration Date and Time

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

Managed Member Release ID

Example: x2bee12
mgrMbrRvcDtmstring · date-timeOptional

Managed Member Unregistration Date and Time

Example: 2023-01-01 12:00:00
Responses
200

Success

No content

post/v1/member/instCusMgmt/regInstCus
POST /api/bo/v1/member/instCusMgmt/regInstCus HTTP/1.1
Host: api-bo.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "instMbrSeq": 1,
  "mbrNo": 10000001,
  "mgrGbCd": 30,
  "mgrTypCd": 301,
  "ordNo": "20230914O58297",
  "regCausCont": "Text",
  "mgrMbrRegId": "x2bee12",
  "mgrMbrRegDtm": "2023-01-01 12:00:00",
  "mgrMbrRvcId": "x2bee12",
  "mgrMbrRvcDtm": "2023-01-01 12:00:00"
}

No content

Check Existing Interested Customer Registration

post

Function Description

  • Checks whether the specified member is registered as an interested customer.


Detailed Description

  • Required value list

    • Member No.

    • Management Type Code

Authorizations
Body

Interested Member Information Entity

instMbrSeqstringOptional

Watched Member Sequence No.

Example: 1
mbrNostringOptional

Member No.

Example: 10000001
mgrGbCdstringOptional

Management Type Code (ME019)

Example: 30
mgrTypCdstringOptional

Management Type Code (ME009)

Example: 301
ordNostringOptional

Order No.

Example: 20230914O58297
regCausContstringOptional

Registration Reason

Example: Text
mgrMbrRegIdstringOptional

Managed Member Registration ID

Example: x2bee12
mgrMbrRegDtmstring · date-timeOptional

Managed Member Registration Date and Time

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

Managed Member Release ID

Example: x2bee12
mgrMbrRvcDtmstring · date-timeOptional

Managed Member Unregistration Date and Time

Example: 2023-01-01 12:00:00
Responses
200

Success

*/*
integer · int32Optional
post/v1/member/instCusMgmt/getInstCusExist
POST /api/bo/v1/member/instCusMgmt/getInstCusExist HTTP/1.1
Host: api-bo.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "instMbrSeq": 1,
  "mbrNo": 10000001,
  "mgrGbCd": 30,
  "mgrTypCd": 301,
  "ordNo": "20230914O58297",
  "regCausCont": "Text",
  "mgrMbrRegId": "x2bee12",
  "mgrMbrRegDtm": "2023-01-01 12:00:00",
  "mgrMbrRvcId": "x2bee12",
  "mgrMbrRvcDtm": "2023-01-01 12:00:00"
}
1

Retrieve Interested Customer Information List

get

Function Description

  • Retrieves the interested customer information list according to the conditions selected on screen.


Detailed Description

  • Retrieves the interested customer information list according to the conditions selected on screen.

  • The retrieved information is masked.

  • Masking list

    • Member Name

    • Mobile Phone No.

    • Member ID


Revision History

  • Release v2.00_240613: Improved period search condition

Authorizations
Query parameters
mbrOptstringOptional

Request Type (NAME, ID, mbrNo)

mbrValuestringOptional

Member Name, ID, or No.

dateSelectstringOptional

Search Full Period Search Status

regStrDtstringOptional

Registration Start Date

regEndDtstringOptional

Registration End Date

instMbrYnstringOptional

Interested Customer Status

mgrGbCdstringOptional

Management Classification

mgrTypCdstringOptional

Management Type

ordLmtYnstringOptional

Purchase Restriction Status

cellSctNostringOptional

Mobile Phone Exchange Code

cellTxnoNostringOptional

Mobile Phone Middle Number

cellEndNostringOptional

Mobile Phone Last Digits

Responses
200

Success

*/*
totalCountinteger · int32Optional
get/v2/member/instCusMgmt/getInstCusList
GET /api/bo/v2/member/instCusMgmt/getInstCusList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "instMbrSeq": 100000451,
      "mbrNo": 10000001,
      "mbrNm": "홍길동",
      "cellNo": "010-1234-1234",
      "loginId": "x2bee12",
      "instMbrYn": "Y",
      "mgrGbNm": "VIP",
      "mgrTypNm": "VIP회원",
      "ordLmtYn": "N",
      "regCausCont": "Text",
      "ordNo": "20230914O58297",
      "mgrMbrRegDt": "2023-01-01",
      "mgrMbrRegId": "x2bee12",
      "mgrMbrRvcDt": "2023-01-01",
      "mgrMbrRvcId": "x2bee12",
      "siteNm": "x2bee"
    }
  ]
}

Last updated