프로모션 관리

쿠폰 상태 변경

post

기능설명

쿠폰별로 변경된 상태를 저장합니다.

상세설명

쿠폰관리 화면에서 쿠폰 별로 변경한 쿠폰상태를 저장합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · CouponRequest[]

searchDateTypestringRequired

검색기간 유형 코드(0 : 전시시작일자 , 1 : 사용시작일자, 2 : 등록일자)

startDatestring · dateRequired

기간 시작일자

endDatestring · dateRequired

기간 종료일자

userIdstringOptional

등록자ID

Example: admin

promoTypCdstringOptional

쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)

Example: 11

promoStatCdstringOptional

쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)

Example: 10

promoNostringOptional

쿠폰번호

Example: C1000001

promoNmstringOptional

쿠폰명

Example: 쿠폰 명

issuMethCdstringOptional

발급방식코드[MK007](01 : 대상자지정발급, 02 : 조건부자동발급, 03 : 고객다운로드발급, 04 : 할인쿠폰코드발급)

Example: 01

issuSubCdstringOptional

쿠폰발급주체코드[MK006](01 : 고정판촉쿠폰, 02 : 이벤트쿠폰, 04 : 제휴사, 05 : 고객보상쿠폰)

Example: 01

autoIssuTypCdstringOptional

자동발급유형코드[MK008]

Example: 2101

entiretyPeriodYnstringOptional

전체기간여부

Example: Y

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v2/marketing/couponMgmt/saveCouponState

POST /api/bo/v2/marketing/couponMgmt/saveCouponState HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

[
  {
    "searchDateType": "text",
    "startDate": "2026-01-01",
    "endDate": "2026-01-01",
    "userId": "admin",
    "promoTypCd": 11,
    "promoStatCd": 10,
    "promoNo": "C1000001",
    "promoNm": "쿠폰 명",
    "issuMethCd": "01",
    "issuSubCd": "01",
    "autoIssuTypCd": 2101,
    "entiretyPeriodYn": "Y"
  }
]

No content

할인/마일리지 등록 및 업데이트

post

기능설명

입력된 할인/마일리지 정보를 저장합니다.

상세설명

입력한 할인/마일리지의 상세 정보(기본정보, 할인/마일리지 혜택, 적용대상, 제외대상)를 저장합니다.
- 할인/마일리지번호가 있는 경우 : 할인/마일리지 등록
- 할인/마일리지번호가 없는 경우 : 할인/마일리지 수정
할인/마일리지의 경우 쿠폰과 다르게, 100% 당사 분담이고, 최소구매수량, 최소구매금액, 최대할인금액 제한이 없습니다.
선택한 할인/마일리지 유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

promoNostringRequired

프로모션번호

Example: C1000001

promoNmstringRequired

프로모션명

Example: 프로모션명

promoGbCdstring · enumRequired

쿠폰구분(MK001)

Example: 10Possible values:

promoTypCdstring · enumRequired

프로모션유형

Example: 11Possible values:

promoStatCdstring · enumRequired

프로모션상태

Example: 10Possible values:

promoStrDtmstring · date-timeRequired

전시 시작 일시

promoEndDtmstring · date-timeRequired

전시 종료 일시

promoDescstringRequired

프로모션설명

Example: 프로모션설명

comGbCdstring · enumOptional

회사구분코드(ME038)

Example: P00Possible values:

aplyPsbMediaCdstring[]Required

적용 매체 리스트

Example: 01

mbrGradeCdstring[]Required

적용 회원등급 리스트

Example: 10

fixamtFxrtGbCdstring · enumRequired

정액정률구분코드(MK005)

Example: 01Possible values:

dcRateAmtnumberRequired

할인율금액

Example: 10

aplySitesstring[]Optional

적용 조건 - 사이트

Example: P00

aplyGoodsstring[]Optional

적용 조건 - 상품

Example: 10151231

aplyStdGoodsstring[]Optional

적용 조건 - 표준카테고리

Example: 958

aplyCategorystring[]Optional

적용 조건 - 전시카테고리

Example: 100

aplyBrandstring[]Optional

적용 조건 - 브랜드

Example: BR01

aplyEntrstring[]Optional

적용 조건 - 협력사

Example: 10001

aplyChannelstring[]Optional

적용 조건 - 채널

Example: 1000

exceptStdGoodsstring[]Optional

제외 조건 - 표준카테고리

Example: 958

exceptBrandstring[]Optional

제외 조건 - 브랜드

Example: BR01

exceptEntrstring[]Optional

제외 조건 - 협력사

Example: 10001

exceptGoodsstring[]Optional

제외 조건 - 상품

Example: 10151231

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/promotionMgmt/registerPromotion

POST /api/bo/v1/marketing/promotionMgmt/registerPromotion HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 546

{
  "promoNo": "C1000001",
  "promoNm": "프로모션명",
  "promoGbCd": 10,
  "promoTypCd": 11,
  "promoStatCd": 10,
  "promoStrDtm": "2026-01-01T00:00:00.000Z",
  "promoEndDtm": "2026-01-01T00:00:00.000Z",
  "promoDesc": "프로모션설명",
  "comGbCd": "P00",
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrGradeCd": [
    10
  ],
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 10,
  "aplySites": [
    "P00"
  ],
  "aplyGoods": [
    10151231
  ],
  "aplyStdGoods": [
    958
  ],
  "aplyCategory": [
    100
  ],
  "aplyBrand": [
    "BR01"
  ],
  "aplyEntr": [
    10001
  ],
  "aplyChannel": [
    1000
  ],
  "exceptStdGoods": [
    958
  ],
  "exceptBrand": [
    "BR01"
  ],
  "exceptEntr": [
    10001
  ],
  "exceptGoods": [
    10151231
  ]
}

text

마일리지 기준정보 저장

post

기능설명

마일리지 기준정보 목록을 저장합니다.

상세설명

저장 시 기존 데이터 유무에 따라 처리가 달라집니다.
기존 데이터 정보는 적립구분코드로 조회 합니다.
기존 데이터 존재 안함 - 등록
- 기준 정보: insert
- 기준 정보 변경이력: insert
기존 데이터 존재함 - 수정
- 기준 정보: update
- 기준 정보 변경이력: update (기존에 저장된 정보 종료)
- 기준 정보 변경이력: insert (새로 저장된 정보)

수정번호

Release v1.03_231106: 마일리지 기준정보 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

rsrvGbCdstring · enumRequired

적립구분코드(CM016)

Example: 100Possible values:

rsrvTgtCdstring · enumRequired

적립대상코드(CM017)

Example: 111Possible values:

milgTypNmstringRequired

마일리지유형명

Example: 마일리지유형명

baseRsrvRatenumber · doubleOptional

기본적립율

Example: 10

addRsrvAmtnumberOptional

추가적립금액

Example: 100

rsrvStdAmtnumberOptional

적립기준금액

Example: 100

rsrvStdDdsinteger · int32Optional

적립기준일수

Example: 10

valiTermDdsinteger · int32Optional

유효기간일수

Example: 10

mmMaxRsrvAmtnumberOptional

월최대적립금액

Example: 3000

yyMaxRsrvAmtnumberOptional

년최대적립금액

Example: 36000

mmMaxRsrvUseYnstringOptional

월간한도 사용여부(Y=최대지정, N=무제한)

Example: N

yyMaxRsrvUseYnstringOptional

연간한도 사용여부(Y=최대지정, N=무제한)

Example: N

useYnstringOptional

적립기준 사용여부(Y=사용, N=미사용)

Example: Y

chgCausDescstringOptional

변경사유설명

Example: 최초 등록

rmkContstringOptional

비고내용

Example: 비고 내용

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/marketing/mileageMgmt/saveMilgStdDetail

POST /api/bo/v1/marketing/mileageMgmt/saveMilgStdDetail HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "rsrvGbCd": 100,
  "rsrvTgtCd": 111,
  "milgTypNm": "마일리지유형명",
  "baseRsrvRate": 10,
  "addRsrvAmt": 100,
  "rsrvStdAmt": 100,
  "rsrvStdDds": 10,
  "valiTermDds": 10,
  "mmMaxRsrvAmt": 3000,
  "yyMaxRsrvAmt": 36000,
  "mmMaxRsrvUseYn": "N",
  "yyMaxRsrvUseYn": "N",
  "useYn": "Y",
  "chgCausDesc": "최초 등록",
  "rmkCont": "비고 내용"
}

No content

쿠폰 회수

post

기능설명

사용자에게 발급된 쿠폰을 회수합니다.

상세설명

사용자에게 발급된 쿠폰을 회수합니다.
회수된 쿠폰은 사용자의 쿠폰함에서 미노출됩니다.
쿠폰이 사용된 경우에는 회수가 불가능합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

cpnIsuNoListstring[]Required

쿠폰발급번호

valiStrtDtmstring · date-timeOptional

쿠폰 기간변경 유효시작일시

valiEndDtmstring · date-timeOptional

쿠폰 기간변경 유효종료일시

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/withdrawCoupon

POST /api/bo/v1/marketing/couponMgmt/withdrawCoupon HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "cpnIsuNoList": [
    "text"
  ],
  "valiStrtDtm": "2026-01-01T00:00:00.000Z",
  "valiEndDtm": "2026-01-01T00:00:00.000Z"
}

text

쿠폰 등록/수정

post

기능설명

입력된 쿠폰 정보를 저장합니다.

상세설명

입력한 쿠폰의 상세 정보(기본정보, 쿠폰 혜택, 적용대상, 제외대상)를 저장합니다.
- 쿠폰번호가 있는 경우 : 쿠폰 등록
- 쿠폰번호가 없는 경우 : 쿠폰 수정
선택한 쿠폰 유형, 발급주체, 발급유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.

수정번호

Release v2.00_240509: 적용대상 - 기획전 정보 저장 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

쿠폰 저장 Request

promoNostringRequired

쿠폰번호

Example: C1000001

promoNmstringRequired

쿠폰명

Example: 쿠폰명

promoGbCdstring · enumRequired

쿠폰/프로모션 구분 코드

Example: 10Possible values:

promoTypCdstring · enumRequired

쿠폰유형코드

Example: 11Possible values:

promoStatCdstring · enumRequired

쿠폰상태코드

Example: 10Possible values:

promoStrDtmstring · date-timeRequired

행사시작일시

promoEndDtmstring · date-timeRequired

행사종료일시

ourChrgRateinteger · int32Required

자사 분담률

Example: 100

entrChrgRateinteger · int32Required

협력사 분담률

Example: 0

promoDescstringRequired

쿠폰 설명

Example: 쿠폰 설명

issuSubCdstring · enumRequired

쿠폰발급주체코드

Example: 01Possible values:

idIssuLmtYnstringRequired

회원당 발급 횟수 제한 여부

Example: Y

idIssuQtyinteger · int32Optional

회원당 발급 제한 횟수

Example: 5

totCpnIssuLmtYnstringRequired

총 발급 횟수 제한 여부

Example: Y

totCpnIssuQtyinteger · int32Optional

총 발급 제한 횟수

Example: 5

aplyPsbMediaCdstring[]Optional

적용가능매체코드

Example: 01

mbrGradeCdstring[]Optional

회원등급코드

Example: 10

issuMethCdstring · enumOptional

발급방식코드

Example: 01Possible values:

autoIssuTypCdstringOptional

발급유형코드(MK008)

Example: 2101

aplyTermGbCdstring · enumOptional

적용기간구분코드

Example: 10Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

발급일기준쿠폰사용일수

Example: 10

usePsbStrDtstringOptional

사용가능시작일자

Example: 2023-01-01

usePsbEndDtstringOptional

사용가능종료일자

Example: 2023-01-31

useWdayCdstring[]Optional

사용요일코드

Example: 1

tmCpnYnstringOptional

타임쿠폰여부

Example: N

usePsbStrTmstringOptional

타임쿠폰 시작시간

Example: 0000

usePsbEndTmstringOptional

타임쿠폰 종료시간

Example: 2359

fixamtFxrtGbCdstring · enumRequired

정액정율구코드

Example: 01Possible values:

dcRateAmtnumberOptional

할인율금액

Example: 5000

minBuyQtyinteger · int32Optional

최소구매수량

Example: 1

minBuyAmtnumberOptional

최소구매금액

Example: 10

maxDcAmtnumberOptional

최대할인금액

Example: 5000

dcCpnCdstringOptional

할인쿠폰코드

Example: 할인쿠폰코드

autoIssuPotmCdstring · enumOptional

자동발급시점코드

Example: 01Possible values:

anvyPreIsuDdsinteger · int32Optional

기념일선발행일수

Example: 2

cpbookDispYnstringOptional

쿠폰북전시여부

Example: N

dcCpbookCdstringOptional

할인쿠폰북코드(MK010)

Example: 01

autoIssuQtyinteger · int32Optional

자동발급수량

Example: 2

aplySitesstring[]Optional

적용 조건 - 사이트

Example: {'data':'플래티어닷컴',key:'1'}

aplyGoodsstring[]Optional

적용 조건 - 상품

Example: {'data':'10151231',key:'10151231'}

aplyStdGoodsstring[]Optional

적용 조건 - 표준카테고리

Example: {'data':'표준카테고리 명',key:'958'}

aplyCategorystring[]Optional

적용 조건 - 전시카테고리

Example: {'data':'전시카테고리 명',key:'100'}

aplyBrandstring[]Optional

적용 조건 - 브랜드

Example: {'data':'브랜드 명',key:'BR01'}

aplyEntrstring[]Optional

적용 조건 - 협력사

Example: {'data':'협력사 명',key:'10001'}

aplyChannelstring[]Optional

적용 조건 - 채널

Example: {'data':'채널 명',key:'1000'}

aplyMarketingDisplaystring[]Optional

적용 조건 - 기획전

Example: {'data':'기획전 명',key:'1000'}

exceptGoodsstring[]Optional

제외 조건 - 상품

Example: {'data':'10151231',key:'10151231'}

exceptStdGoodsstring[]Optional

제외 조건 - 표준카테고리

Example: {'data':'표준카테고리 명',key:'958'}

exceptBrandstring[]Optional

제외 조건 - 브랜드

Example: {'data':'브랜드 명',key:'BR01'}

exceptEntrstring[]Optional

제외 조건 - 협력사

Example: {'data':'협력사 명',key:'10001'}

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/registerCoupon

POST /api/bo/v1/marketing/couponMgmt/registerCoupon HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1456

{
  "promoNo": "C1000001",
  "promoNm": "쿠폰명",
  "promoGbCd": 10,
  "promoTypCd": 11,
  "promoStatCd": 10,
  "promoStrDtm": "2026-01-01T00:00:00.000Z",
  "promoEndDtm": "2026-01-01T00:00:00.000Z",
  "ourChrgRate": 100,
  "entrChrgRate": 0,
  "promoDesc": "쿠폰 설명",
  "issuSubCd": "01",
  "idIssuLmtYn": "Y",
  "idIssuQty": 5,
  "totCpnIssuLmtYn": "Y",
  "totCpnIssuQty": 5,
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrGradeCd": [
    10
  ],
  "issuMethCd": "01",
  "autoIssuTypCd": 2101,
  "aplyTermGbCd": 10,
  "issuDdStdCpnUseDds": 10,
  "usePsbStrDt": "2023-01-01",
  "usePsbEndDt": "2023-01-31",
  "useWdayCd": [
    1
  ],
  "tmCpnYn": "N",
  "usePsbStrTm": "0000",
  "usePsbEndTm": 2359,
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 5000,
  "minBuyQty": 1,
  "minBuyAmt": 10,
  "maxDcAmt": 5000,
  "dcCpnCd": "할인쿠폰코드",
  "autoIssuPotmCd": "01",
  "anvyPreIsuDds": 2,
  "cpbookDispYn": "N",
  "dcCpbookCd": "01",
  "autoIssuQty": 2,
  "aplySites": [
    "{'data':'플래티어닷컴',key:'1'}"
  ],
  "aplyGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "aplyStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "aplyCategory": [
    "{'data':'전시카테고리 명',key:'100'}"
  ],
  "aplyBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "aplyEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ],
  "aplyChannel": [
    "{'data':'채널 명',key:'1000'}"
  ],
  "aplyMarketingDisplay": [
    "{'data':'기획전 명',key:'1000'}"
  ],
  "exceptGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "exceptStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "exceptBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "exceptEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ]
}

text

회원 쿠폰 발급

post

기능설명

입력된 회원 중 유효한 회원에게 쿠폰을 발급합니다.

상세설명

입력된 회원 중 입력된 쿠폰의 조건에 부합하는 회원에게 쿠폰을 발급합니다.
쿠폰 조건
- 기본정보
- 행사기간
- 발급횟수 제한

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · CcCpnIsuMbr[]

회원 쿠폰 발급 Request

cpnIsuNostringRequired

쿠폰발급번호

Example: C1004061

mbrNostringRequired

회원번호

Example: 1000001

cpnNostringRequired

쿠폰번호

Example: C1004061

cpnIsuDtmstring · date-timeRequired

쿠폰발급일시

valiStrtDtmstring · date-timeRequired

유효시작일시

valiEndDtmstring · date-timeRequired

유효종료일시

orgCpnIsuNostringRequired

원쿠폰발급번호

Example: C1004061

useGbCdstringRequired

사용구분코드(ME014)

Example: N

useYnstringRequired

사용여부

Example: N

useDtmstring · date-timeRequired

사용일시

payNostringRequired

결제번호

Example: 1000001

mbrNtcYnstringRequired

회원알림여부

Example: N

csCpnPayCausCdstringRequired

CS쿠폰지급사유코드(MK021)

Example: N

mgrMemostringRequired

관리메모

Example: N

ordNostringRequired

주문번호

Example: 1000001

ordSeqinteger · int32Required

주문순번

Example: 1

ordProcSeqinteger · int32Required

주문처리순번

Example: 1

autoIssuOdrstringRequired

자동발급차수

Example: 1

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/registCouponIssuedMember

POST /api/bo/v1/marketing/couponMgmt/registCouponIssuedMember HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 391

[
  {
    "cpnIsuNo": "C1004061",
    "mbrNo": 1000001,
    "cpnNo": "C1004061",
    "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
    "valiStrtDtm": "2026-01-01T00:00:00.000Z",
    "valiEndDtm": "2026-01-01T00:00:00.000Z",
    "orgCpnIsuNo": "C1004061",
    "useGbCd": "N",
    "useYn": "N",
    "useDtm": "2026-01-01T00:00:00.000Z",
    "payNo": 1000001,
    "mbrNtcYn": "N",
    "csCpnPayCausCd": "N",
    "mgrMemo": "N",
    "ordNo": 1000001,
    "ordSeq": 1,
    "ordProcSeq": 1,
    "autoIssuOdr": 1
  }
]

text

쿠폰 기간 변경

post

기능설명

사용자에게 발급된 쿠폰의 유효기간을 변경합니다.

상세설명

사용자에게 발급된 쿠폰의 유효기간을 변경합니다.
쿠폰이 사용된 경우에는 기간변경이 불가능합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

cpnIsuNoListstring[]Required

쿠폰발급번호

valiStrtDtmstring · date-timeOptional

쿠폰 기간변경 유효시작일시

valiEndDtmstring · date-timeOptional

쿠폰 기간변경 유효종료일시

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/modifyCouponValiDtm

POST /api/bo/v1/marketing/couponMgmt/modifyCouponValiDtm HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "cpnIsuNoList": [
    "text"
  ],
  "valiStrtDtm": "2026-01-01T00:00:00.000Z",
  "valiEndDtm": "2026-01-01T00:00:00.000Z"
}

text

동일 발급 유형 쿠폰 목록 조회

post

기능설명

발급 유형이 동일한 쿠폰 정보를 조회합니다.

상세설명

발급 유형이 동일하고, 행사기간이 현재일 이후인 쿠폰 정보를 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

쿠폰 저장 Request

promoNostringRequired

쿠폰번호

Example: C1000001

promoNmstringRequired

쿠폰명

Example: 쿠폰명

promoGbCdstring · enumRequired

쿠폰/프로모션 구분 코드

Example: 10Possible values:

promoTypCdstring · enumRequired

쿠폰유형코드

Example: 11Possible values:

promoStatCdstring · enumRequired

쿠폰상태코드

Example: 10Possible values:

promoStrDtmstring · date-timeRequired

행사시작일시

promoEndDtmstring · date-timeRequired

행사종료일시

ourChrgRateinteger · int32Required

자사 분담률

Example: 100

entrChrgRateinteger · int32Required

협력사 분담률

Example: 0

promoDescstringRequired

쿠폰 설명

Example: 쿠폰 설명

issuSubCdstring · enumRequired

쿠폰발급주체코드

Example: 01Possible values:

idIssuLmtYnstringRequired

회원당 발급 횟수 제한 여부

Example: Y

idIssuQtyinteger · int32Optional

회원당 발급 제한 횟수

Example: 5

totCpnIssuLmtYnstringRequired

총 발급 횟수 제한 여부

Example: Y

totCpnIssuQtyinteger · int32Optional

총 발급 제한 횟수

Example: 5

aplyPsbMediaCdstring[]Optional

적용가능매체코드

Example: 01

mbrGradeCdstring[]Optional

회원등급코드

Example: 10

issuMethCdstring · enumOptional

발급방식코드

Example: 01Possible values:

autoIssuTypCdstringOptional

발급유형코드(MK008)

Example: 2101

aplyTermGbCdstring · enumOptional

적용기간구분코드

Example: 10Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

발급일기준쿠폰사용일수

Example: 10

usePsbStrDtstringOptional

사용가능시작일자

Example: 2023-01-01

usePsbEndDtstringOptional

사용가능종료일자

Example: 2023-01-31

useWdayCdstring[]Optional

사용요일코드

Example: 1

tmCpnYnstringOptional

타임쿠폰여부

Example: N

usePsbStrTmstringOptional

타임쿠폰 시작시간

Example: 0000

usePsbEndTmstringOptional

타임쿠폰 종료시간

Example: 2359

fixamtFxrtGbCdstring · enumRequired

정액정율구코드

Example: 01Possible values:

dcRateAmtnumberOptional

할인율금액

Example: 5000

minBuyQtyinteger · int32Optional

최소구매수량

Example: 1

minBuyAmtnumberOptional

최소구매금액

Example: 10

maxDcAmtnumberOptional

최대할인금액

Example: 5000

dcCpnCdstringOptional

할인쿠폰코드

Example: 할인쿠폰코드

autoIssuPotmCdstring · enumOptional

자동발급시점코드

Example: 01Possible values:

anvyPreIsuDdsinteger · int32Optional

기념일선발행일수

Example: 2

cpbookDispYnstringOptional

쿠폰북전시여부

Example: N

dcCpbookCdstringOptional

할인쿠폰북코드(MK010)

Example: 01

autoIssuQtyinteger · int32Optional

자동발급수량

Example: 2

aplySitesstring[]Optional

적용 조건 - 사이트

Example: {'data':'플래티어닷컴',key:'1'}

aplyGoodsstring[]Optional

적용 조건 - 상품

Example: {'data':'10151231',key:'10151231'}

aplyStdGoodsstring[]Optional

적용 조건 - 표준카테고리

Example: {'data':'표준카테고리 명',key:'958'}

aplyCategorystring[]Optional

적용 조건 - 전시카테고리

Example: {'data':'전시카테고리 명',key:'100'}

aplyBrandstring[]Optional

적용 조건 - 브랜드

Example: {'data':'브랜드 명',key:'BR01'}

aplyEntrstring[]Optional

적용 조건 - 협력사

Example: {'data':'협력사 명',key:'10001'}

aplyChannelstring[]Optional

적용 조건 - 채널

Example: {'data':'채널 명',key:'1000'}

aplyMarketingDisplaystring[]Optional

적용 조건 - 기획전

Example: {'data':'기획전 명',key:'1000'}

exceptGoodsstring[]Optional

제외 조건 - 상품

Example: {'data':'10151231',key:'10151231'}

exceptStdGoodsstring[]Optional

제외 조건 - 표준카테고리

Example: {'data':'표준카테고리 명',key:'958'}

exceptBrandstring[]Optional

제외 조건 - 브랜드

Example: {'data':'브랜드 명',key:'BR01'}

exceptEntrstring[]Optional

제외 조건 - 협력사

Example: {'data':'협력사 명',key:'10001'}

Responses

200

성공

*/*

쿠폰 관리 조회 Response

promoNostringRequired

쿠폰번호

Example: C1000001

promoNmstringRequired

쿠폰명

Example: 쿠폰명

promoTypCdstring · enumRequired

쿠폰유형코드

Example: 11Possible values:

promoTypNmstringRequired

쿠폰유형명

Example: 상품할인쿠폰

promoStatCdstring · enumRequired

쿠폰상태코드

Example: 10Possible values:

promoStatNmstringRequired

쿠폰상태명

Example: 정상

fixamtFxrtGbCdstring · enumRequired

정액정율구코드

Example: 01Possible values:

fixamtFxrtGbNmstringRequired

정액정율구분명

Example: 정액

dcRateAmtnumberRequired

할인액(율)

Example: 5000

promoStrDtmstring · date-timeRequired

행사시작일시

promoEndDtmstring · date-timeRequired

행사종료일시

usePsbStrDtstringOptional

사용시작일자

Example: 2023-01-01

usePsbEndDtstringOptional

사용종료일자

Example: 2023-12-31

issuMethCdstring · enumOptional

발급방식코드

Example: 01Possible values:

issuMethCdNmstringOptional

발급방식코드명

Example: 조건부 자동발급

issuSubCdstring · enumOptional

쿠폰발급주체코드

Example: 01Possible values:

issuSubCdNmstringOptional

쿠폰발급주체코드명

Example: 고정판촉쿠폰

autoIssuTypCdstringOptional

발급유형코드(MK008)

Example: 2101

autoIssuTypNmstringOptional

발급유형명

Example: 신규회원 가입 쿠폰

autoIssuPotmCdstring · enumOptional

자동발급시점코드

Example: 01Possible values:

autoIssuPotmNmstringOptional

자동발급시점명

Example: 당일발급

anvyPreIsuDdsstringOptional

기념일선발행일수

Example: 2

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/getValidCouponListForSameAutoIssueType

POST /api/bo/v1/marketing/couponMgmt/getValidCouponListForSameAutoIssueType HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1456

{
  "promoNo": "C1000001",
  "promoNm": "쿠폰명",
  "promoGbCd": 10,
  "promoTypCd": 11,
  "promoStatCd": 10,
  "promoStrDtm": "2026-01-01T00:00:00.000Z",
  "promoEndDtm": "2026-01-01T00:00:00.000Z",
  "ourChrgRate": 100,
  "entrChrgRate": 0,
  "promoDesc": "쿠폰 설명",
  "issuSubCd": "01",
  "idIssuLmtYn": "Y",
  "idIssuQty": 5,
  "totCpnIssuLmtYn": "Y",
  "totCpnIssuQty": 5,
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrGradeCd": [
    10
  ],
  "issuMethCd": "01",
  "autoIssuTypCd": 2101,
  "aplyTermGbCd": 10,
  "issuDdStdCpnUseDds": 10,
  "usePsbStrDt": "2023-01-01",
  "usePsbEndDt": "2023-01-31",
  "useWdayCd": [
    1
  ],
  "tmCpnYn": "N",
  "usePsbStrTm": "0000",
  "usePsbEndTm": 2359,
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 5000,
  "minBuyQty": 1,
  "minBuyAmt": 10,
  "maxDcAmt": 5000,
  "dcCpnCd": "할인쿠폰코드",
  "autoIssuPotmCd": "01",
  "anvyPreIsuDds": 2,
  "cpbookDispYn": "N",
  "dcCpbookCd": "01",
  "autoIssuQty": 2,
  "aplySites": [
    "{'data':'플래티어닷컴',key:'1'}"
  ],
  "aplyGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "aplyStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "aplyCategory": [
    "{'data':'전시카테고리 명',key:'100'}"
  ],
  "aplyBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "aplyEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ],
  "aplyChannel": [
    "{'data':'채널 명',key:'1000'}"
  ],
  "aplyMarketingDisplay": [
    "{'data':'기획전 명',key:'1000'}"
  ],
  "exceptGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "exceptStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "exceptBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "exceptEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ]
}

[
  {
    "promoNo": "C1000001",
    "promoNm": "쿠폰명",
    "promoTypCd": 11,
    "promoTypNm": "상품할인쿠폰",
    "promoStatCd": 10,
    "promoStatNm": "정상",
    "fixamtFxrtGbCd": "01",
    "fixamtFxrtGbNm": "정액",
    "dcRateAmt": 5000,
    "promoStrDtm": "2026-01-01T00:00:00.000Z",
    "promoEndDtm": "2026-01-01T00:00:00.000Z",
    "usePsbStrDt": "2023-01-01",
    "usePsbEndDt": "2023-12-31",
    "issuMethCd": "01",
    "issuMethCdNm": "조건부 자동발급",
    "issuSubCd": "01",
    "issuSubCdNm": "고정판촉쿠폰",
    "autoIssuTypCd": 2101,
    "autoIssuTypNm": "신규회원 가입 쿠폰",
    "autoIssuPotmCd": "01",
    "autoIssuPotmNm": "당일발급",
    "anvyPreIsuDds": 2
  }
]

혜택 등록 시 역마진 상품 체크

post

기능설명

적용 조건 중 역마진 상품이 있는지 체크합니다.

상세설명

적용 - 상품 리스트 중에 역마진이 있는 상품을 체크합니다.
역마진이 발생하는 경우는 아래와 같습니다.
- 공급가 > 판매가 - 할인금액
다른 적용 조건과 제외 대상은 역마진 체크를 진행하지 않습니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

goodsListstring[]Required

상품번호

fixamtFxrtGbCdstring · enumRequired

현재 쿠폰의 정액/정률 구분 코드

Example: 01Possible values:

dcRateAmtinteger · int64Required

현재 쿠폰의 할인금액/률

Example: 5000

Responses

200

성공

*/*

string[]Optional

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/getOverMrgnGoods

POST /api/bo/v1/marketing/couponMgmt/getOverMrgnGoods HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "goodsList": [
    "text"
  ],
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 5000
}

[
  "text"
]

회원 쿠폰 일괄발급 조회

post

기능설명

첨부한 양식에 있는 회원 정보를 불러오는 API입니다.

상세설명

첨부한 양식에 입력된 회원 정보 중 유효한 정보에 해당하는 회원정보를 조회하여 그리드에 표시합니다.
양식에서 사용할 수 있는 등록 방법은 아래와 같습니다.
- 등록구분
  - 10 : 회원번호
  - 20 : 로그인ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

회원 쿠폰 일괄발급 조회 Request

promoNostringRequired

쿠폰번호

Example: C1004061

Responses

200

성공

*/*

cpnIsuNostringRequired

쿠폰발급번호

Example: 1000001

orgCpnIsuNostringRequired

원쿠폰발급번호

Example: 1000001

mbrNostringRequired

회원번호

Example: 1000001

mbrNmstringRequired

회원명

Example: 관*자

loginIdstringRequired

회원ID

Example: ad***

mbrGradeCdstringRequired

회원등급코드

Example: 10

mbrGradeNmstringRequired

회원등급코드명

Example: GREEN

cpnNostringRequired

쿠폰번호

Example: C1004061

cpnIsuDtmstring · date-timeRequired

쿠폰발급일시

valiStrtDtmstring · date-timeRequired

유효시작일시

valiEndDtmstring · date-timeRequired

유효종료일시

useYnstringRequired

사용여부

Example: Y

mgrMemostringRequired

쿠폰관리메모

Example: 관리자 메모

dataTypestringRequired

일괄등록 시 키값 유형 코드(CouponUploadMbrType. 10 : 회원번호, 20 : 로그인ID, 30 : 기간계회원번호)

Example: 10

900

업무처리 오류 내용

*/*

post/v1/marketing/couponMgmt/couponIssuedMbrLoadByExcel

POST /api/bo/v1/marketing/couponMgmt/couponIssuedMbrLoadByExcel HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "promoNo": "C1004061",
  "couponIssuedMemberResponse": [
    {
      "cpnIsuNo": 1000001,
      "orgCpnIsuNo": 1000001,
      "mbrNo": 1000001,
      "mbrNm": "관*자",
      "loginId": "ad***",
      "mbrGradeCd": 10,
      "mbrGradeNm": "GREEN",
      "cpnNo": "C1004061",
      "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
      "valiStrtDtm": "2026-01-01T00:00:00.000Z",
      "valiEndDtm": "2026-01-01T00:00:00.000Z",
      "useYn": "Y",
      "mgrMemo": "관리자 메모",
      "dataType": 10
    }
  ]
}

[
  {
    "cpnIsuNo": 1000001,
    "orgCpnIsuNo": 1000001,
    "mbrNo": 1000001,
    "mbrNm": "관*자",
    "loginId": "ad***",
    "mbrGradeCd": 10,
    "mbrGradeNm": "GREEN",
    "cpnNo": "C1004061",
    "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
    "valiStrtDtm": "2026-01-01T00:00:00.000Z",
    "valiEndDtm": "2026-01-01T00:00:00.000Z",
    "useYn": "Y",
    "mgrMemo": "관리자 메모",
    "dataType": 10
  }
]

사은행사 등록/수정

post

기능설명

입력된 사은행사 정보를 저장합니다.

상세설명

입력한 사은행사의 상세 정보(기본정보, 지급 설정, 적용대상)를 저장합니다.
- 사은행사 번호가 있는 경우 : 기존 사은행사 정보를 수정합니다.
- 사은행사 번호가 없는 경우 : 신규 사은행사 정보를 등록합니다.

수정번호

Release v1.06_231218 : 프로모션 사은행사 등록 시 사은품 코드 중복등록 체크 기능 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

사은행사 등록 Request

aeNostringOptional

사은행사 번호

Example: 1000001

aeNmstringRequired

사은행사 명

Example: 사은행사 명

addEvtTypCdstring · enumRequired

사은행사 유형 코드

Example: 10Possible values:

aePrgsStatCdstring · enumRequired

사은행사 상태 코드

Example: 10Possible values:

aeDescstringRequired

사은행사 설명

Example: 사은행사 설명

entrNostringRequired

진행협력사번호

Example: 100001

aeStrDtmstring · date-timeRequired

사은행사 시작일시

aeEndDtmstring · date-timeRequired

사은행사 종료일시

payStrDtstringOptional

사은행사 지급 시작날짜

Example: 20230101

payEndDtstringOptional

사은행사 지급 종료날짜

Example: 20231231

aplyPsbMediaCdstring[]Required

적용 매체 리스트

Example: 01

mbrTypCdstring · enumRequired

사은행사 적용대상

Example: 01Possible values:

mbrGradeCdstring[]Required

적용 회원등급 리스트

Example: 10

tmEvtYnstringOptional

타임행사 여부

Example: N

aplyStrTmstringOptional

타임행사 시작 시간

Example: 0000

aplyEndTmstringOptional

타임행사 종료 시간

Example: 2359

aplySitesstring[]Required

적용 조건 - 사이트

Example: 1

aplyGoodsstring[]Required

적용 조건 - 상품

Example: 10182131

aplyStdGoodsstring[]Optional

적용 조건 - 표준카테고리

Example: 100001

aplyCategorystring[]Optional

적용 조건 - 전시카테고리

Example: 987

aplyBrandstring[]Optional

적용 조건 - 브랜드

Example: BR01

aplyEntrstring[]Optional

적용 조건 - 협력사

Example: 100001

aplyChannelstring[]Optional

적용 조건 - 채널

Example: NAVER

exceptGoodsstring[]Optional

제외 조건 - 상품

Example: 10182131

exceptStdGoodsstring[]Optional

제외 조건 - 표준카테고리

Example: 100001

exceptBrandstring[]Optional

제외 조건 - 브랜드

Example: BR01

exceptEntrstring[]Optional

제외 조건 - 협력사

Example: 100001

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/marketing/appreciationEventMgmt/registAppreciation

POST /api/bo/v1/marketing/appreciationEventMgmt/registAppreciation HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 644

{
  "aeNo": 1000001,
  "aeNm": "사은행사 명",
  "addEvtTypCd": 10,
  "aePrgsStatCd": 10,
  "aeDesc": "사은행사 설명",
  "entrNo": 100001,
  "aeStrDtm": "2026-01-01T00:00:00.000Z",
  "aeEndDtm": "2026-01-01T00:00:00.000Z",
  "payStrDt": 20230101,
  "payEndDt": 20231231,
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrTypCd": "01",
  "mbrGradeCd": [
    10
  ],
  "tmEvtYn": "N",
  "aplyStrTm": "0000",
  "aplyEndTm": 2359,
  "aeFvrInfo": [
    "{goodsNo: '10182131', minAmt: 500}"
  ],
  "aplySites": [
    1
  ],
  "aplyGoods": [
    10182131
  ],
  "aplyStdGoods": [
    100001
  ],
  "aplyCategory": [
    987
  ],
  "aplyBrand": [
    "BR01"
  ],
  "aplyEntr": [
    100001
  ],
  "aplyChannel": [
    "NAVER"
  ],
  "exceptGoods": [
    10182131
  ],
  "exceptStdGoods": [
    100001
  ],
  "exceptBrand": [
    "BR01"
  ],
  "exceptEntr": [
    100001
  ]
}

text

할인/마일리지 목록 조회

get

기능설명

등록된 할인/마일리지 정보를 조회합니다.

상세설명

검색조건에 맞는 할인/마일리지를 조회합니다. 검색조건은 아래와 같습니다.
- 할인/마일리지 기간
- 할인/마일리지 유형
- 할인/마일리지 상태
- 할인/마일리지 번호/명
- 등록자

수정번호

Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypestringRequired

검색기간 유형 코드(0 : 적용시작일 , 1 : 등록일)

startDatestring · dateRequired

시작일자

endDatestring · dateRequired

종료일자

userIdstringOptional

등록ID

Example: 100000001

promoTypCdstringOptional

프로모션유형 코드[MK002](20 : 임직원할인, 21 : 상품즉시할인, 40 : 상품마일리지)

Example: 20

promoStatCdstringOptional

쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)

Example: 10

promoNostringOptional

프로모션번호

Example: C1000001

promoNmstringOptional

프로모션명

Example: 프로모션명

entiretyPeriodYnstringOptional

전체기간여부

Example: Y

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/promotionMgmt/getPromotionManagingList

GET /api/bo/v2/marketing/promotionMgmt/getPromotionManagingList?searchDateType=text&startDate=2026-01-01&endDate=2026-01-01 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "promoNo": "C1000001",
      "promoTypNm": "프로모션명",
      "promoTypCd": "상품할인쿠폰",
      "promoNm": 11,
      "promoStatNm": "진행",
      "promoStatCd": 10,
      "fixamtFxrtGbNm": "정액",
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 10,
      "promoStrDtm": "2026-01-01T00:00:00.000Z",
      "promoEndDtm": "2026-01-01T00:00:00.000Z"
    }
  ]
}

마일리지 기준정보 목록/건수 조회

get

기능설명

마일리지 기준정보 목록을 조회합니다.

상세설명

선택한 적립구분코드에 맞는 마일리지 기준정보 목록을 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

rsrvGbCdstring · enumRequired

적립구분코드(CM016)

Example: 100Possible values:

useYnstringRequired

사용여부

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/mileageMgmt/milgStdList

GET /api/bo/v2/marketing/mileageMgmt/milgStdList?pageIdx=text&rowsPerPage=text&rsrvGbCd=100&useYn=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "milgStdInfoSeq": "text",
      "rsrvGbCd": "text",
      "rsrvTgtCd": "text",
      "milgTypNm": "text",
      "baseRsrvRate": 1,
      "addRsrvAmt": 1,
      "mbrGradeCd": "text",
      "rsrvStdAmt": 1,
      "rsrvStdDds": 1,
      "valiTermDds": 1,
      "mmMaxRsrvAmt": 1,
      "yyMaxRsrvAmt": 1,
      "mmMaxRsrvUseYn": "text",
      "yyMaxRsrvUseYn": "text",
      "useYn": "text",
      "chgCausDesc": "text",
      "rmkCont": "text"
    }
  ]
}

마일리지 기준정보 변경이력 목록/건수 조회

get

기능설명

마일리지 기준정보 변경이력 목록을 조회합니다.

상세설명

조건에 맞는 마일리지 기준정보 변경이력 목록을 조회합니다.
- 마일리지 기준정보 순번
- 적립구분코드
- 적립대상코드

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

milgStdInfoSeqstringRequired

마일리지 기준정보 순번

Example: 10000

rsrvGbCdstring · enumRequired

적립구분코드(CM016)

Example: 100Possible values:

rsrvTgtCdstring · enumRequired

적립대상코드(CM017)

Example: 111Possible values:

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/mileageMgmt/getMilgStdChgHistList

GET /api/bo/v2/marketing/mileageMgmt/getMilgStdChgHistList?pageIdx=text&rowsPerPage=text&milgStdInfoSeq=10000&rsrvGbCd=100&rsrvTgtCd=111 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "milgStdInfoSeq": "text",
      "histStrDtm": "2026-01-01T00:00:00.000Z",
      "histEndDtm": "2026-01-01T00:00:00.000Z",
      "rsrvGbCd": "text",
      "rsrvTgtCd": "text",
      "milgTypNm": "text",
      "baseRsrvRate": 1,
      "addRsrvAmt": 1,
      "mbrGradeCd": "text",
      "rsrvStdAmt": 1,
      "rsrvStdDds": 1,
      "valiTermDds": 1,
      "mmMaxRsrvAmt": 1,
      "yyMaxRsrvAmt": 1,
      "mmMaxRsrvUseYn": "text",
      "yyMaxRsrvUseYn": "text",
      "useYn": "text",
      "chgCausDesc": "text",
      "rmkCont": "text"
    }
  ]
}

쿠폰관리 목록/건수 조회

get

기능설명

등록된 쿠폰 정보 및 건수를 조회합니다.

상세설명

검색조건에 맞는 쿠폰 정보를 조회합니다. 검색조건은 아래와 같습니다.
- 기간(행사기간, 사용가능기간, 등록기간)
- 쿠폰유형
- 쿠폰상태
- 등록자
- 쿠폰번호/명
- 발급방식

수정번호

Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypestringRequired

검색기간 유형 코드(0 : 전시시작일자 , 1 : 사용시작일자, 2 : 등록일자)

startDatestring · dateRequired

기간 시작일자

endDatestring · dateRequired

기간 종료일자

userIdstringOptional

등록자ID

Example: admin

promoTypCdstringOptional

쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)

Example: 11

promoStatCdstringOptional

쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)

Example: 10

promoNostringOptional

쿠폰번호

Example: C1000001

promoNmstringOptional

쿠폰명

Example: 쿠폰 명

issuMethCdstringOptional

발급방식코드[MK007](01 : 대상자지정발급, 02 : 조건부자동발급, 03 : 고객다운로드발급, 04 : 할인쿠폰코드발급)

Example: 01

issuSubCdstringOptional

쿠폰발급주체코드[MK006](01 : 고정판촉쿠폰, 02 : 이벤트쿠폰, 04 : 제휴사, 05 : 고객보상쿠폰)

Example: 01

autoIssuTypCdstringOptional

자동발급유형코드[MK008]

Example: 2101

entiretyPeriodYnstringOptional

전체기간여부

Example: Y

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/couponMgmt/getCouponList

GET /api/bo/v2/marketing/couponMgmt/getCouponList?searchDateType=text&startDate=2026-01-01&endDate=2026-01-01 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "promoNo": "C1000001",
      "promoNm": "쿠폰명",
      "promoTypCd": 11,
      "promoTypNm": "상품할인쿠폰",
      "promoStatCd": 10,
      "promoStatNm": "정상",
      "fixamtFxrtGbCd": "01",
      "fixamtFxrtGbNm": "정액",
      "dcRateAmt": 5000,
      "promoStrDtm": "2026-01-01T00:00:00.000Z",
      "promoEndDtm": "2026-01-01T00:00:00.000Z",
      "usePsbStrDt": "2023-01-01",
      "usePsbEndDt": "2023-12-31",
      "issuMethCd": "01",
      "issuMethCdNm": "조건부 자동발급",
      "issuSubCd": "01",
      "issuSubCdNm": "고정판촉쿠폰",
      "autoIssuTypCd": 2101,
      "autoIssuTypNm": "신규회원 가입 쿠폰",
      "autoIssuPotmCd": "01",
      "autoIssuPotmNm": "당일발급",
      "anvyPreIsuDds": 2
    }
  ]
}

쿠폰 발급회원 조회

get

기능설명

     * 해당 쿠폰을 발급받은 회원 정보를 조회합니다.
     ---
     ## 상세설명
     * 해당 쿠폰을 발급받은 회원 정보를 조회합니다.
     * 아래 내용들은 **마스킹**되어 노출되어집니다.
       * 회원ID
       * 회원명
     ---

수정번호

Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cpnNostringRequired

쿠폰번호

Example: C1000001

mbrNostringOptional

회원번호

Example: 1000000001

useYnstringOptional

사용여부

Example: Y

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/couponMgmt/getCouponIssuedMemberList

GET /api/bo/v2/marketing/couponMgmt/getCouponIssuedMemberList?cpnNo=C1000001 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cpnIsuNo": 1000001,
      "orgCpnIsuNo": 1000001,
      "mbrNo": 1000001,
      "mbrNm": "관*자",
      "loginId": "ad***",
      "mbrGradeCd": 10,
      "mbrGradeNm": "GREEN",
      "cpnNo": "C1004061",
      "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
      "valiStrtDtm": "2026-01-01T00:00:00.000Z",
      "valiEndDtm": "2026-01-01T00:00:00.000Z",
      "useYn": "Y",
      "mgrMemo": "관리자 메모",
      "dataType": 10
    }
  ]
}

쿠폰 비용 관리 목록 및 건수 조회

get

기능설명

쿠폰별로 발급, 사용에 관련된 정보를 조회합니다.

상세설명

쿠폰별로 해당 일자의 발급건수, 사용건수 등을 조회합니다.
검색조건은 아래와 같습니다.
- 발급기간
- 쿠폰유형
- 쿠폰상태
- 쿠폰번호/명
- 등록자

수정번호

Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypestringRequired

검색기간 유형 코드(0 : 발급시작일 , 1 : 등록일)

startDatestring · dateRequired

기간 시작 일자

endDatestring · dateRequired

기간 시작 일자

promoTypCdstringOptional

쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)

Example: 11

promoStatCdstringOptional

쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)

Example: 10

fixamtFxrtGbCdstringOptional

할인 유형 코드[MK005]

Example: 01

promoNostringOptional

쿠폰번호

Example: C1000001

promoNmstringOptional

쿠폰명

Example: 쿠폰 명

userIdstringOptional

등록자ID

Example: admin

isEntiretyPeriodbooleanOptional

전체기간여부

Example: true

dateSelectstringOptional

조회기간 선택

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/couponCostMgmt/getCouponCostList

GET /api/bo/v2/marketing/couponCostMgmt/getCouponCostList?searchDateType=text&startDate=2026-01-01&endDate=2026-01-01 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cpnNo": "C1000001",
      "promoTypCd": 11,
      "promoTypCdNm": "상품할인쿠폰",
      "promoStatCd": 10,
      "promoStatCdNm": "정상",
      "promoNm": "쿠폰명",
      "isuCnt": 1000,
      "useCnt": 250,
      "notUseCnt": 750,
      "productAmt": 25000000,
      "cpnAmt": 1520000,
      "useRate": 25,
      "fixamtFxrtGbCd": "01",
      "fixamtFxrtGbCdNm": "정액",
      "dcRateAmt": 20,
      "totalCount": 1
    }
  ]
}

사은행사 관리 목록 조회

get

기능설명

등록된 사은행사 정보를 조회하는 API 입니다.

상세설명

검색조건에 맞는 사은행사 정보를 조회합니다. 검색조건은 아래와 같습니다.
- 사은행사 기간
- 사은행사 유형
- 사은행사 상태
- 등록자
- 사은행사 번호/명

수정번호

Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypestringRequired

검색기간 유형 코드(0 : 행사시작일 , 1 : 지급일)

startDatestring · dateRequired

사은행사기간 시작일자

endDatestring · dateRequired

사은행사기간 종료일자

userIdstringOptional

등록자ID

Example: admin

addEvtTypCdstringOptional

사은행사 유형 코드[MK012](10 : 구매금액사은행사, 20 : 상품사은행사

Example: 20

aePrgsStatCdstringOptional

사은행사 상태 코드[MK003](10 : 정상, 20 : 중단)

Example: 10

aeNostringOptional

사은행사 번호

Example: 1000001

aeNmstringOptional

사은행사 명

Example: 사은행사

mbrTypCdstringOptional

적용대상

Example: 01

entiretyPeriodYnstringOptional

전체기간여부

Example: Y

entrNostringOptional

진행 협력사 코드

Example: 0000000

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/appreciationEventMgmt/getAppreciationEventList

GET /api/bo/v2/marketing/appreciationEventMgmt/getAppreciationEventList?searchDateType=text&startDate=2026-01-01&endDate=2026-01-01 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "aeGubun": 10,
      "aeNo": 1000001,
      "aeNm": "사은행사 명",
      "addEvtTypCd": 10,
      "addEvtTypNm": "상품사은품",
      "aePrgsStatCd": 10,
      "aePrgsStatNm": "정상",
      "aeDesc": "사은행사 설명",
      "entrNo": 100001,
      "entrNm": "협력사명",
      "aeStrDtm": "2026-01-01T00:00:00.000Z",
      "aeEndDtm": "2026-01-01T00:00:00.000Z",
      "payStrDt": 20230101,
      "payEndDt": 20231231,
      "mbrTypCd": "01",
      "mbrTypCdNm": "임직원",
      "tmEvtYn": "N",
      "aplyStrTm": "0000",
      "aplyEndTm": 2359
    }
  ]
}

사은품 지급 고객 정보 조회

get

기능설명

사은품을 선택한 주문 목록을 조회합니다.

상세설명

사은품을 선택한 주문 중 검색조건에 맞는 주문 정보를 조회합니다. 검색조건은 아래와 같습니다.
- 사은행사 기간
- 사은행사 유형
- 사은행사 상태
- 등록자
- 사은행사 번호/명
Response 중 아래 내용들은 마스킹되어 노출되어집니다.
- 회원ID
- 회원명
- 휴대폰번호
- 주문배송지

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · dateRequired

주문 접수 시작 일자

endDatestring · dateRequired

주문 접수 종료 일자

ordNostringOptional

주문번호

Example: 20230101O000001

mbrNostringOptional

회원번호

Example: 100000001

aeNostringOptional

사은행사 번호

Example: 1000001

aeNmstringOptional

사은행사 명

Example: 사은행사 명

goodsNostringOptional

사은품 번호

dateSelectstringOptional

조회기간 선택

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/marketing/appreciationEventMgmt/getAeOrderList

GET /api/bo/v2/marketing/appreciationEventMgmt/getAeOrderList?startDate=2026-01-01&endDate=2026-01-01 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230101O000001",
      "loginId": "ad***",
      "mbrGbCdNm": "정회원",
      "mbrNm": "관*자",
      "mbrNo": 100000001,
      "mbrGradeCdNm": "GREEN",
      "mbrJoinDtm": "2026-01-01T00:00:00.000Z",
      "tellNo": "010-****-1234",
      "ordAccpDtm": "2026-01-01T00:00:00.000Z",
      "zipNo": "06123",
      "zipAddr": "서울 송파구 *********",
      "dtlAddr": "서울 송파구 *********",
      "aeNm": "사은행사 명",
      "aeNo": 1000001,
      "aeGoodsNo": 10000001,
      "aeGoodsNm": "사은품명",
      "realAmt": 66000,
      "ordCnt": 1,
      "aeStrDtm": "2026-01-01T00:00:00.000Z",
      "aeEndDtm": "2026-01-01T00:00:00.000Z"
    }
  ]
}

할인/마일리지 상세 화면 호출

get

기능설명

선택한 할인/마일리지의 상세 정보를 조회합니다.

상세설명

선택한 할인/마일리지의 상세 정보를 조회합니다.
조회내용
- 기본정보
- 할인/마일리지 혜택
- 적용대상, 제외대상

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

promoNostringRequired

프로모션번호

Example: 100000000

Responses

200

성공

*/*

쿠폰 상세 정보 조회 Response

promoNostringRequired

쿠폰번호

Example: C1000001

promoGbCdstring · enumRequired

쿠폰/프로모션 구분 코드

Example: 10Possible values:

comGbCdstringRequired

회사구분 코드(ME038)

Example: P00

promoNmstringRequired

쿠폰명

Example: 쿠폰명

promoTypCdstring · enumRequired

쿠폰유형코드

Example: 11Possible values:

promoStatCdstring · enumRequired

쿠폰상태코드

Example: 10Possible values:

promoStrDtmstring · date-timeRequired

행사시작일시

promoEndDtmstring · date-timeRequired

행사종료일시

ourChrgRateinteger · int32Required

자사 분담률

Example: 100

entrChrgRateinteger · int32Required

협력사 분담률

Example: 0

promoDescstringRequired

쿠폰 설명

Example: 쿠폰 설명

possibleUpdateYnstringRequired

수정가능여부

Example: Y

issuSubCdstring · enumRequired

쿠폰발급주체코드

Example: 01Possible values:

idIssuLmtYnstringRequired

회원당 발급 횟수 제한 여부

Example: Y

idIssuQtyinteger · int32Optional

회원당 발급 제한 횟수

Example: 5

totCpnIssuLmtYnstringRequired

총 발급 횟수 제한 여부

Example: Y

totCpnIssuQtyinteger · int32Optional

총 발급 제한 횟수

Example: 5

aplyPsbMediaCdstring[]Optional

적용가능매체코드

Example: 01

mbrGradeCdstring[]Optional

회원등급코드

Example: 10

issuMethCdstring · enumOptional

발급방식코드

Example: 01Possible values:

autoIssuTypCdstringOptional

발급유형코드(MK008)

Example: 2101

aplyTermGbCdstring · enumOptional

적용기간구분코드

Example: 10Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

발급일기준쿠폰사용일수

Example: 10

usePsbStrDtstringOptional

사용가능시작일자

Example: 2023-01-01

usePsbEndDtstringOptional

사용가능종료일자

Example: 2023-01-31

useWdayCdstring[]Optional

사용요일코드

Example: 1

tmCpnYnstringOptional

타임쿠폰여부

Example: N

usePsbStrTmstringOptional

타임쿠폰 시작시간

Example: 0000

usePsbEndTmstringOptional

타임쿠폰 종료시간

Example: 2359

fixamtFxrtGbCdstring · enumRequired

정액정율구코드

Example: 01Possible values:

dcRateAmtnumberOptional

할인율금액

Example: 5000

minBuyQtyinteger · int32Optional

최소구매수량

Example: 1

minBuyAmtnumberOptional

최소구매금액

Example: 10

maxDcAmtnumberOptional

최대할인금액

Example: 5000

dcCpnCdstringOptional

할인쿠폰코드

Example: 할인쿠폰코드

autoIssuPotmCdstring · enumOptional

자동발급시점코드

Example: 01Possible values:

anvyPreIsuDdsinteger · int32Optional

기념일선발행일수

Example: 2

cpbookDispYnstringOptional

쿠폰북전시여부

Example: N

dcCpbookCdstringOptional

할인쿠폰북코드(MK010)

Example: 01

autoIssuQtyinteger · int32Optional

자동발급수량

Example: 2

900

업무처리 오류 내용

*/*

get/v1/marketing/promotionMgmt/getPromotion

GET /api/bo/v1/marketing/promotionMgmt/getPromotion?promoNo=100000000 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "promoNo": "C1000001",
  "promoGbCd": 10,
  "comGbCd": "P00",
  "promoNm": "쿠폰명",
  "promoTypCd": 11,
  "promoStatCd": 10,
  "promoStrDtm": "2026-01-01T00:00:00.000Z",
  "promoEndDtm": "2026-01-01T00:00:00.000Z",
  "ourChrgRate": 100,
  "entrChrgRate": 0,
  "promoDesc": "쿠폰 설명",
  "possibleUpdateYn": "Y",
  "issuSubCd": "01",
  "idIssuLmtYn": "Y",
  "idIssuQty": 5,
  "totCpnIssuLmtYn": "Y",
  "totCpnIssuQty": 5,
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrGradeCd": [
    10
  ],
  "issuMethCd": "01",
  "autoIssuTypCd": 2101,
  "aplyTermGbCd": 10,
  "issuDdStdCpnUseDds": 10,
  "usePsbStrDt": "2023-01-01",
  "usePsbEndDt": "2023-01-31",
  "useWdayCd": [
    1
  ],
  "tmCpnYn": "N",
  "usePsbStrTm": "0000",
  "usePsbEndTm": 2359,
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 5000,
  "minBuyQty": 1,
  "minBuyAmt": 10,
  "maxDcAmt": 5000,
  "dcCpnCd": "할인쿠폰코드",
  "autoIssuPotmCd": "01",
  "anvyPreIsuDds": 2,
  "cpbookDispYn": "N",
  "dcCpbookCd": "01",
  "autoIssuQty": 2,
  "aplySites": [
    "{'data':'플래티어닷컴',key:'1'}"
  ],
  "aplyGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "aplyStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "aplyCategory": [
    "{'data':'전시카테고리 명',key:'100'}"
  ],
  "aplyBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "aplyEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ],
  "aplyChannel": [
    "{'data':'채널 명',key:'1000'}"
  ],
  "aplyMarketingDisplay": [
    "{'data':'기획전 명',key:'1000'}"
  ],
  "exceptGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "exceptStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "exceptBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "exceptEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ]
}

마일리지 기준정보 조회

get

기능설명

마일리지 기준정보를 조회합니다.

상세설명

선택한 적립대상코드에 맞는 마일리지 기준정보를 조회합니다.

수정번호

Release v1.03_231106: 마일리지 기준정보 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

rsrvTgtCdstring · enumRequired

적립대상코드(CM017)

Example: 111Possible values:

Responses

200

성공

*/*

milgStdInfoSeqstringOptional

마일리지기준정보순번

rsrvGbCdstringOptional

적립구분코드(CM016)

rsrvTgtCdstringOptional

적립대상코드(CM017)

milgTypNmstringOptional

마일리지유형명

baseRsrvRatenumber · doubleOptional

기본적립율

addRsrvAmtnumberOptional

추가적립금액

mbrGradeCdstringOptional

회원등급코드(ME008)

rsrvStdAmtnumberOptional

적립기준금액

rsrvStdDdsinteger · int32Optional

적립기준일수

valiTermDdsinteger · int32Optional

유효기간일수

mmMaxRsrvAmtnumberOptional

월최대적립금액

yyMaxRsrvAmtnumberOptional

년최대적립금액

mmMaxRsrvUseYnstringOptional

월간한도 사용여부(Y=최대지정, N=무제한)

yyMaxRsrvUseYnstringOptional

연간한도 사용여부(Y=최대지정, N=무제한)

useYnstringOptional

적립기준 사용여부(Y=사용, N=미사용)

chgCausDescstringOptional

변경사유설명

rmkContstringOptional

비고내용

900

업무처리 오류 내용

*/*

get/v1/marketing/mileageMgmt/milgStdDetail

GET /api/bo/v1/marketing/mileageMgmt/milgStdDetail?rsrvTgtCd=111 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "milgStdInfoSeq": "text",
  "rsrvGbCd": "text",
  "rsrvTgtCd": "text",
  "milgTypNm": "text",
  "baseRsrvRate": 1,
  "addRsrvAmt": 1,
  "mbrGradeCd": "text",
  "rsrvStdAmt": 1,
  "rsrvStdDds": 1,
  "valiTermDds": 1,
  "mmMaxRsrvAmt": 1,
  "yyMaxRsrvAmt": 1,
  "mmMaxRsrvUseYn": "text",
  "yyMaxRsrvUseYn": "text",
  "useYn": "text",
  "chgCausDesc": "text",
  "rmkCont": "text"
}

마일리지 기준정보 등록을 위한 기본 정보 조회

get

기능설명

마일리지 기준정보 등록을 위한 기본 정보 조회합니다.

상세설명

마일리지 기준 정보 등록 시 참고를 위한 데이터를 조회 합니다.
조회하는 데이터의 우선 순위는 아래와 같습니다.
- 적립 대상 코드
- 적립 구분 코드(적립 구분코드, 적립 대상코드가 가장 큰 값)

수정번호

Release v1.03_231106: 마일리지 기준정보 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

rsrvGbCdstring · enumRequired

적립구분코드(CM016)

Example: 100Possible values:

rsrvTgtCdstring · enumRequired

적립대상코드(CM017)

Example: 111Possible values:

Responses

200

성공

*/*

milgStdInfoSeqstringOptional

마일리지기준정보순번

rsrvGbCdstringOptional

적립구분코드(CM016)

rsrvTgtCdstringOptional

적립대상코드(CM017)

milgTypNmstringOptional

마일리지유형명

baseRsrvRatenumber · doubleOptional

기본적립율

addRsrvAmtnumberOptional

추가적립금액

mbrGradeCdstringOptional

회원등급코드(ME008)

rsrvStdAmtnumberOptional

적립기준금액

rsrvStdDdsinteger · int32Optional

적립기준일수

valiTermDdsinteger · int32Optional

유효기간일수

mmMaxRsrvAmtnumberOptional

월최대적립금액

yyMaxRsrvAmtnumberOptional

년최대적립금액

mmMaxRsrvUseYnstringOptional

월간한도 사용여부(Y=최대지정, N=무제한)

yyMaxRsrvUseYnstringOptional

연간한도 사용여부(Y=최대지정, N=무제한)

useYnstringOptional

적립기준 사용여부(Y=사용, N=미사용)

chgCausDescstringOptional

변경사유설명

rmkContstringOptional

비고내용

900

업무처리 오류 내용

*/*

get/v1/marketing/mileageMgmt/getSaveBasedMilgStdDetail

GET /api/bo/v1/marketing/mileageMgmt/getSaveBasedMilgStdDetail?rsrvGbCd=100&rsrvTgtCd=111 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "milgStdInfoSeq": "text",
  "rsrvGbCd": "text",
  "rsrvTgtCd": "text",
  "milgTypNm": "text",
  "baseRsrvRate": 1,
  "addRsrvAmt": 1,
  "mbrGradeCd": "text",
  "rsrvStdAmt": 1,
  "rsrvStdDds": 1,
  "valiTermDds": 1,
  "mmMaxRsrvAmt": 1,
  "yyMaxRsrvAmt": 1,
  "mmMaxRsrvUseYn": "text",
  "yyMaxRsrvUseYn": "text",
  "useYn": "text",
  "chgCausDesc": "text",
  "rmkCont": "text"
}

쿠폰 상세 정보 조회

get

기능설명

선택한 쿠폰의 상세 정보를 조회합니다.

상세설명

선택한 쿠폰의 상세 정보를 조회합니다.
조회내용
- 기본정보
- 쿠폰혜택
- 적용대상

수정번호

Release v2.00_240509: 적용대상 - 기획전 정보 조회 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

promoNostringRequired

쿠폰번호

Example: C1000001

Responses

200

성공

*/*

쿠폰 상세 정보 조회 Response

promoNostringRequired

쿠폰번호

Example: C1000001

promoGbCdstring · enumRequired

쿠폰/프로모션 구분 코드

Example: 10Possible values:

comGbCdstringRequired

회사구분 코드(ME038)

Example: P00

promoNmstringRequired

쿠폰명

Example: 쿠폰명

promoTypCdstring · enumRequired

쿠폰유형코드

Example: 11Possible values:

promoStatCdstring · enumRequired

쿠폰상태코드

Example: 10Possible values:

promoStrDtmstring · date-timeRequired

행사시작일시

promoEndDtmstring · date-timeRequired

행사종료일시

ourChrgRateinteger · int32Required

자사 분담률

Example: 100

entrChrgRateinteger · int32Required

협력사 분담률

Example: 0

promoDescstringRequired

쿠폰 설명

Example: 쿠폰 설명

possibleUpdateYnstringRequired

수정가능여부

Example: Y

issuSubCdstring · enumRequired

쿠폰발급주체코드

Example: 01Possible values:

idIssuLmtYnstringRequired

회원당 발급 횟수 제한 여부

Example: Y

idIssuQtyinteger · int32Optional

회원당 발급 제한 횟수

Example: 5

totCpnIssuLmtYnstringRequired

총 발급 횟수 제한 여부

Example: Y

totCpnIssuQtyinteger · int32Optional

총 발급 제한 횟수

Example: 5

aplyPsbMediaCdstring[]Optional

적용가능매체코드

Example: 01

mbrGradeCdstring[]Optional

회원등급코드

Example: 10

issuMethCdstring · enumOptional

발급방식코드

Example: 01Possible values:

autoIssuTypCdstringOptional

발급유형코드(MK008)

Example: 2101

aplyTermGbCdstring · enumOptional

적용기간구분코드

Example: 10Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

발급일기준쿠폰사용일수

Example: 10

usePsbStrDtstringOptional

사용가능시작일자

Example: 2023-01-01

usePsbEndDtstringOptional

사용가능종료일자

Example: 2023-01-31

useWdayCdstring[]Optional

사용요일코드

Example: 1

tmCpnYnstringOptional

타임쿠폰여부

Example: N

usePsbStrTmstringOptional

타임쿠폰 시작시간

Example: 0000

usePsbEndTmstringOptional

타임쿠폰 종료시간

Example: 2359

fixamtFxrtGbCdstring · enumRequired

정액정율구코드

Example: 01Possible values:

dcRateAmtnumberOptional

할인율금액

Example: 5000

minBuyQtyinteger · int32Optional

최소구매수량

Example: 1

minBuyAmtnumberOptional

최소구매금액

Example: 10

maxDcAmtnumberOptional

최대할인금액

Example: 5000

dcCpnCdstringOptional

할인쿠폰코드

Example: 할인쿠폰코드

autoIssuPotmCdstring · enumOptional

자동발급시점코드

Example: 01Possible values:

anvyPreIsuDdsinteger · int32Optional

기념일선발행일수

Example: 2

cpbookDispYnstringOptional

쿠폰북전시여부

Example: N

dcCpbookCdstringOptional

할인쿠폰북코드(MK010)

Example: 01

autoIssuQtyinteger · int32Optional

자동발급수량

Example: 2

900

업무처리 오류 내용

*/*

get/v1/marketing/couponMgmt/getCouponData

GET /api/bo/v1/marketing/couponMgmt/getCouponData?promoNo=C1000001 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "promoNo": "C1000001",
  "promoGbCd": 10,
  "comGbCd": "P00",
  "promoNm": "쿠폰명",
  "promoTypCd": 11,
  "promoStatCd": 10,
  "promoStrDtm": "2026-01-01T00:00:00.000Z",
  "promoEndDtm": "2026-01-01T00:00:00.000Z",
  "ourChrgRate": 100,
  "entrChrgRate": 0,
  "promoDesc": "쿠폰 설명",
  "possibleUpdateYn": "Y",
  "issuSubCd": "01",
  "idIssuLmtYn": "Y",
  "idIssuQty": 5,
  "totCpnIssuLmtYn": "Y",
  "totCpnIssuQty": 5,
  "aplyPsbMediaCd": [
    "01"
  ],
  "mbrGradeCd": [
    10
  ],
  "issuMethCd": "01",
  "autoIssuTypCd": 2101,
  "aplyTermGbCd": 10,
  "issuDdStdCpnUseDds": 10,
  "usePsbStrDt": "2023-01-01",
  "usePsbEndDt": "2023-01-31",
  "useWdayCd": [
    1
  ],
  "tmCpnYn": "N",
  "usePsbStrTm": "0000",
  "usePsbEndTm": 2359,
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 5000,
  "minBuyQty": 1,
  "minBuyAmt": 10,
  "maxDcAmt": 5000,
  "dcCpnCd": "할인쿠폰코드",
  "autoIssuPotmCd": "01",
  "anvyPreIsuDds": 2,
  "cpbookDispYn": "N",
  "dcCpbookCd": "01",
  "autoIssuQty": 2,
  "aplySites": [
    "{'data':'플래티어닷컴',key:'1'}"
  ],
  "aplyGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "aplyStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "aplyCategory": [
    "{'data':'전시카테고리 명',key:'100'}"
  ],
  "aplyBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "aplyEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ],
  "aplyChannel": [
    "{'data':'채널 명',key:'1000'}"
  ],
  "aplyMarketingDisplay": [
    "{'data':'기획전 명',key:'1000'}"
  ],
  "exceptGoods": [
    "{'data':'10151231',key:'10151231'}"
  ],
  "exceptStdGoods": [
    "{'data':'표준카테고리 명',key:'958'}"
  ],
  "exceptBrand": [
    "{'data':'브랜드 명',key:'BR01'}"
  ],
  "exceptEntr": [
    "{'data':'협력사 명',key:'10001'}"
  ]
}

진행중 사은행사 개수 조회

get

기능설명

해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.

상세설명

해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

goodsNostringRequired

사은품번호

Example: 10000001

Responses

200

성공

*/*

integer · int32Optional

900

업무처리 오류 내용

*/*

get/v1/marketing/appreciationEventMgmt/getProgressAeEvtCount

GET /api/bo/v1/marketing/appreciationEventMgmt/getProgressAeEvtCount?goodsNo=10000001 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

이전이벤트 정보 관리

다음세그먼트 관리

마지막 업데이트 2일 전