고객 알림 관리

고객알림 수정

put

기능설명

고객알림 정보를 수정합니다.

상세설명

등록한 알림의 알림화면 대분류, 중분류에 맞는 FO 화면에서 등록된 고객알림을 볼 수 있습니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

고객알림 등록, 수정 요청 DTO

scrnCustNotiSeqstringOptional

화면고객알림순번

Example: 1

ntcRegIdstringOptional

등록자ID

Example: x2bee

bbStrStartDtstring · dateOptional

게시시작기간 시작일자

Example: 2023-01-01

bbStrEndDtstring · dateOptional

게시시작기간 종료일자

Example: 2023-01-31

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10

scrnLgrpCdstringOptional

알림화면대분류(CM026)

Example: 100

scrnMgrpCdstringOptional

알림화면중분류(CM027)

Example: 101

ntcContsstringRequired

알림내용

Example: 주문서 결제수단 신용카드 알림내용

ntcMlContsstringOptional

다국어알림내용

Example: 주문서 결제수단 신용카드 알림내용

dataLangCdstringOptional

다국어 언어코드

Example: en

scrnCustNotiSeqsstringOptional

화면고객알림순번

Example: 1

bbStrStartDtmstring · date-timeOptional

게시시작기간 시작일시

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

bbStrEndDtmstring · date-timeOptional

게시시작기간 종료일시

Example: 2023-01-01 23:59:59

searchDateTypestringOptional

조회기간조건

Example: regDt

dateSelectstringOptional

선택한 기간

Example: all_day

dispMediaCdListstring[]Optional

scrnCustNotiSeqListstring[]Optional

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

put/v2/system/customerAlimMgmt/modifyCustomerAlimInfo

PUT /api/bo/v2/system/customerAlimMgmt/modifyCustomerAlimInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 490

{
  "scrnCustNotiSeq": 1,
  "ntcRegId": "x2bee",
  "bbStrStartDt": "2023-01-01",
  "bbStrEndDt": "2023-01-31",
  "dispMediaCd": 10,
  "scrnLgrpCd": 100,
  "scrnMgrpCd": 101,
  "ntcConts": "주문서 결제수단 신용카드 알림내용",
  "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
  "dataLangCd": "en",
  "scrnCustNotiSeqs": 1,
  "bbStrStartDtm": "2023-01-01 00:00:00",
  "bbStrEndDtm": "2023-01-01 23:59:59",
  "searchDateType": "regDt",
  "dateSelect": "all_day",
  "dispMediaCdList": [
    "text"
  ],
  "scrnCustNotiSeqList": [
    "text"
  ]
}

text

고객알림 다국어 정보 등록, 수정

post

기능설명

고객알림 다국어 정보를 등록, 수정합니다.

상세설명

넘어온 langCd의 다국어 정보를 등록, 수정합니다.
등록 시 langCd, ntcMlConts는 필수입니다.
수정 시 langCd, scrnCustNotiSeq, ntcMlConts는 필수입니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

고객알림 등록, 수정 요청 DTO

scrnCustNotiSeqstringOptional

화면고객알림순번

Example: 1

ntcRegIdstringOptional

등록자ID

Example: x2bee

bbStrStartDtstring · dateOptional

게시시작기간 시작일자

Example: 2023-01-01

bbStrEndDtstring · dateOptional

게시시작기간 종료일자

Example: 2023-01-31

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10

scrnLgrpCdstringOptional

알림화면대분류(CM026)

Example: 100

scrnMgrpCdstringOptional

알림화면중분류(CM027)

Example: 101

ntcContsstringRequired

알림내용

Example: 주문서 결제수단 신용카드 알림내용

ntcMlContsstringOptional

다국어알림내용

Example: 주문서 결제수단 신용카드 알림내용

dataLangCdstringOptional

다국어 언어코드

Example: en

scrnCustNotiSeqsstringOptional

화면고객알림순번

Example: 1

bbStrStartDtmstring · date-timeOptional

게시시작기간 시작일시

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

bbStrEndDtmstring · date-timeOptional

게시시작기간 종료일시

Example: 2023-01-01 23:59:59

searchDateTypestringOptional

조회기간조건

Example: regDt

dateSelectstringOptional

선택한 기간

Example: all_day

dispMediaCdListstring[]Optional

scrnCustNotiSeqListstring[]Optional

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v2/system/customerAlimMgmt/registCustomerAlimMultiLang

POST /api/bo/v2/system/customerAlimMgmt/registCustomerAlimMultiLang HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 490

{
  "scrnCustNotiSeq": 1,
  "ntcRegId": "x2bee",
  "bbStrStartDt": "2023-01-01",
  "bbStrEndDt": "2023-01-31",
  "dispMediaCd": 10,
  "scrnLgrpCd": 100,
  "scrnMgrpCd": 101,
  "ntcConts": "주문서 결제수단 신용카드 알림내용",
  "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
  "dataLangCd": "en",
  "scrnCustNotiSeqs": 1,
  "bbStrStartDtm": "2023-01-01 00:00:00",
  "bbStrEndDtm": "2023-01-01 23:59:59",
  "searchDateType": "regDt",
  "dateSelect": "all_day",
  "dispMediaCdList": [
    "text"
  ],
  "scrnCustNotiSeqList": [
    "text"
  ]
}

text

고객알림 등록

post

기능설명

고객알림 정보를 등록합니다.

상세설명

등록한 알림의 알림화면 대분류, 중분류에 맞는 FO 화면에서 등록된 고객알림을 볼 수 있습니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

고객알림 등록, 수정 요청 DTO

scrnCustNotiSeqstringOptional

화면고객알림순번

Example: 1

ntcRegIdstringOptional

등록자ID

Example: x2bee

bbStrStartDtstring · dateOptional

게시시작기간 시작일자

Example: 2023-01-01

bbStrEndDtstring · dateOptional

게시시작기간 종료일자

Example: 2023-01-31

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10

scrnLgrpCdstringOptional

알림화면대분류(CM026)

Example: 100

scrnMgrpCdstringOptional

알림화면중분류(CM027)

Example: 101

ntcContsstringRequired

알림내용

Example: 주문서 결제수단 신용카드 알림내용

ntcMlContsstringOptional

다국어알림내용

Example: 주문서 결제수단 신용카드 알림내용

dataLangCdstringOptional

다국어 언어코드

Example: en

scrnCustNotiSeqsstringOptional

화면고객알림순번

Example: 1

bbStrStartDtmstring · date-timeOptional

게시시작기간 시작일시

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

bbStrEndDtmstring · date-timeOptional

게시시작기간 종료일시

Example: 2023-01-01 23:59:59

searchDateTypestringOptional

조회기간조건

Example: regDt

dateSelectstringOptional

선택한 기간

Example: all_day

dispMediaCdListstring[]Optional

scrnCustNotiSeqListstring[]Optional

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v2/system/customerAlimMgmt/registCustomerAlimInfo

POST /api/bo/v2/system/customerAlimMgmt/registCustomerAlimInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 490

{
  "scrnCustNotiSeq": 1,
  "ntcRegId": "x2bee",
  "bbStrStartDt": "2023-01-01",
  "bbStrEndDt": "2023-01-31",
  "dispMediaCd": 10,
  "scrnLgrpCd": 100,
  "scrnMgrpCd": 101,
  "ntcConts": "주문서 결제수단 신용카드 알림내용",
  "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
  "dataLangCd": "en",
  "scrnCustNotiSeqs": 1,
  "bbStrStartDtm": "2023-01-01 00:00:00",
  "bbStrEndDtm": "2023-01-01 23:59:59",
  "searchDateType": "regDt",
  "dateSelect": "all_day",
  "dispMediaCdList": [
    "text"
  ],
  "scrnCustNotiSeqList": [
    "text"
  ]
}

text

고객알림 게시종료 처리

post

기능설명

고객알림 게시종료 처리

상세설명

게시 종료 일자를 현재일자로 변경합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v2/system/customerAlimMgmt/customerAlimPostingEndProcess

POST /api/bo/v2/system/customerAlimMgmt/customerAlimPostingEndProcess HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "postingEndSaveInfoList": [
    {
      "scrnCustNotiSeq": "text"
    }
  ]
}

No content

고객알림 다국어 정보 조회

get

기능설명

고객알림공지번호에 맞는 고객알림 다국어 정보를 조회합니다.

상세설명

dataLangCd 가 넘어오면 넘어온 언어코드에 대한 다국어정보를 조회합니다.
넘어오지 않으면 현재 기본 언어코드를 제외한 첫번째 언어코드에 대한 다국어의 정보를 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

scrnCustNotiSeqstringRequired

고객알림공지번호

dataLangCdstringOptional

다국어국가코드

Responses

200

성공

*/*

고객알림 조회 응답 DTO

scrnCustNotiSeqstringOptional

화면고객알림순번

Example: 1

bbStrStartDtmstring · date-timeOptional

게시시작기간 시작일시

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

bbStrEndDtmstring · date-timeOptional

게시시작기간 종료일시

Example: 2023-01-31 23:59:59

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10

scrnLgrpCdstringOptional

알림화면대분류(CM026)

Example: 100

scrnMgrpCdstringOptional

알림화면중분류(CM027)

Example: 101

ntcContsstringRequired

알림내용

Example: 주문서 결제수단 신용카드 알림내용

ntcMlContsstringOptional

다국어알림내용

Example: 주문서 결제수단 신용카드 알림내용

bbStrStartDtstringOptional

게시시작기간 시작일

Example: 2023-01-01

bbStrEndDtstringOptional

게시시작기간 종료일

Example: 2023-01-31

siteNmstringOptional

사이트명

Example: 플래티어

900

업무처리 오류 내용

*/*

get/v2/system/customerAlimMgmt/getCustomerAlimMultiLang

GET /api/bo/v2/system/customerAlimMgmt/getCustomerAlimMultiLang?request=[object+Object]&scrnCustNotiSeq=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "scrnCustNotiSeq": 1,
  "bbStrStartDtm": "2023-01-01 00:00:00",
  "bbStrEndDtm": "2023-01-31 23:59:59",
  "dispMediaCd": 10,
  "scrnLgrpCd": 100,
  "scrnMgrpCd": 101,
  "ntcConts": "주문서 결제수단 신용카드 알림내용",
  "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
  "bbStrStartDt": "2023-01-01",
  "bbStrEndDt": "2023-01-31",
  "siteNm": "플래티어"
}

고객알림 목록 조회

get

기능설명

화면에서 선택한 조건에 맞는 고객 알림 목록을 조회합니다.

상세설명

화면에서 선택한 조건에 맞는 고객 알림 목록을 조회합니다.
쿠키 값에 등록된 dataLangCd 기준으로 목록이 조회됩니다.

수정번호

Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가
Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

bbStrStartDtLocalDateRequired

게시시작일시

bbStrEndDtLocalDateRequired

게시종료일시

ntcRegIdstringOptional

등록자ID

siteNostringOptional

사이트번호

dispMediaCdstringOptional

전시매체코드

scrnLgrpCdstringOptional

알림화면대분류

scrnMgrpCdstringOptional

알림화면중분류

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

dateSelectstringRequired

선택한 기간

Example: all_day

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/system/customerAlimMgmt/getCustomerAlimList

GET /api/bo/v2/system/customerAlimMgmt/getCustomerAlimList?request=[object+Object]&bbStrStartDt=null&bbStrEndDt=null&pageIdx=text&rowsPerPage=text&dateSelect=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "scrnCustNotiSeq": 1,
      "bbStrStartDtm": "2023-01-01 00:00:00",
      "bbStrEndDtm": "2023-01-31 23:59:59",
      "dispMediaCd": 10,
      "scrnLgrpCd": 100,
      "scrnMgrpCd": 101,
      "ntcConts": "주문서 결제수단 신용카드 알림내용",
      "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
      "bbStrStartDt": "2023-01-01",
      "bbStrEndDt": "2023-01-31",
      "siteNm": "플래티어"
    }
  ]
}

고객알림 정보 조회

get

기능설명

고객알림공지번호에 맞는 고객알림 정보를 조회합니다.

상세설명

고객알림공지번호(scrnCustNotiSeq)는 필수입니다.
쿠키값의 dataLangCd 기준으로 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

scrnCustNotiSeqstringRequired

고객알림공지번호

Responses

200

성공

*/*

고객알림 조회 응답 DTO

scrnCustNotiSeqstringOptional

화면고객알림순번

Example: 1

bbStrStartDtmstring · date-timeOptional

게시시작기간 시작일시

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

bbStrEndDtmstring · date-timeOptional

게시시작기간 종료일시

Example: 2023-01-31 23:59:59

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10

scrnLgrpCdstringOptional

알림화면대분류(CM026)

Example: 100

scrnMgrpCdstringOptional

알림화면중분류(CM027)

Example: 101

ntcContsstringRequired

알림내용

Example: 주문서 결제수단 신용카드 알림내용

ntcMlContsstringOptional

다국어알림내용

Example: 주문서 결제수단 신용카드 알림내용

bbStrStartDtstringOptional

게시시작기간 시작일

Example: 2023-01-01

bbStrEndDtstringOptional

게시시작기간 종료일

Example: 2023-01-31

siteNmstringOptional

사이트명

Example: 플래티어

900

업무처리 오류 내용

*/*

get/v2/system/customerAlimMgmt/getCustomerAlimInfo

GET /api/bo/v2/system/customerAlimMgmt/getCustomerAlimInfo?scrnCustNotiSeq=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "scrnCustNotiSeq": 1,
  "bbStrStartDtm": "2023-01-01 00:00:00",
  "bbStrEndDtm": "2023-01-31 23:59:59",
  "dispMediaCd": 10,
  "scrnLgrpCd": 100,
  "scrnMgrpCd": 101,
  "ntcConts": "주문서 결제수단 신용카드 알림내용",
  "ntcMlConts": "주문서 결제수단 신용카드 알림내용",
  "bbStrStartDt": "2023-01-01",
  "bbStrEndDt": "2023-01-31",
  "siteNm": "플래티어"
}

고객알림 등록/수정 유효기간 체크

get

기능설명

고객알림 등록/수정 유효기간 체크

상세설명

알림매체, 알림 대분류 , 중분류 별 중복 기간 존재 체크
존재하는 알림번호 리턴

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

scrnCustNotiSeqstringOptional

게시시작일시

bbStrStartDtstringRequired

게시시작일시

bbStrEndDtstringRequired

게시종료일시

dispMediaCdstringOptional

전시매체코드

scrnLgrpCdstringOptional

알림화면대분류

scrnMgrpCdstringOptional

알림화면중분류

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

get/v2/system/customerAlimMgmt/getCheckPostingPeriodScrnCustNotiSeq

GET /api/bo/v2/system/customerAlimMgmt/getCheckPostingPeriodScrnCustNotiSeq?request=[object+Object]&bbStrStartDt=text&bbStrEndDt=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

이전FAQ 관리

다음시스템 공지 관리

마지막 업데이트 5일 전