쿠폰 발급

상품상세 다운로드가능 쿠폰 조회

post

기능설명

상품에 다운로드가능/사용가능한 쿠폰을 조회합니다

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
상품에 다운로드가능/사용가능한 쿠폰을 조회합니다.
사용가능 쿠폰 조회(쿠폰타입 = 10)
- 조회 조건
  - 프로모션유형: 상품할인쿠폰, 장바구니쿠폰, 중복할인쿠폰, 무료배송쿠폰, 무료반품쿠폰
  - 쿠폰발급주체: 전부
  - 쿠폰발급방식: 전부
다운로드가능 쿠폰 조회(쿠폰타입 = 20)
- 조회 조건
  - 프로모션유형: 상품할인쿠폰, 장바구니쿠폰, 중복할인쿠폰, 무료배송쿠폰, 무료반품쿠폰
  - 쿠폰발급주체: 고정판촉쿠폰
  - 쿠폰발급방식: 고객다운로드발급, 할인쿠폰코드발급

수정번호

Release v2.00_240425: 최소 구매금액, 최대할인금액 데이터 추가
Release v2.00_240509: 적용대상 - 기획전 정보 조회 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

cpnTypestring · enumRequired

상품상세쿠폰조회조건 10 : 사용가능쿠폰 , 20 : 다운로드가능쿠폰

Example: 10Possible values:

sortGbstring · enumRequired

쿠폰정렬순서 10 : 최근등록순 , 20 : 마감임박순

Example: 10Possible values:

rowsPerPageinteger · int32Required

화면당노출수량

Example: 10

pageIdxinteger · int32Required

페이지번호

Example: 1

Responses

200

성공

*/*

promoCntinteger · int32Required

쿠폰발급수량

Example: 1

rowsPerPageinteger · int32Required

화면당노출수량

Example: 10

pageIdxinteger · int32Required

페이지번호

Example: 1

900

업무처리 오류 내용

*/*

post/v1/marketing/goodsDetailCpnList

POST /api/order/v1/marketing/goodsDetailCpnList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 360

{
  "ordMediaCd": "20",
  "cpnType": "10",
  "sortGb": "10",
  "rowsPerPage": 10,
  "pageIdx": 1,
  "goodsList": [
    {
      "goodsNo": "10002031",
      "itmNo": "001",
      "supPcost": 8000,
      "norPrc": 10000,
      "salePrc": 9000,
      "cnt": 1,
      "stdCtgNo": "HT01020000",
      "dispCtgNo": "213",
      "brandNo": "100002",
      "entrNo": "1000002",
      "chlNo": "1000001",
      "infDispCtgNoGbCd": "01",
      "infDispCtgNo": "1000001",
      "marketingDisplayNo": "1000001"
    }
  ]
}

{
  "promoCnt": 1,
  "rowsPerPage": 10,
  "pageIdx": 1,
  "cpnIssuList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션명",
      "promoTypCd": "11",
      "promoDesc": "프로모션설명",
      "cpnIsuNo": "0000001",
      "valiStrtDtm": "2026-01-01T00:00:00.000Z",
      "valiEndDtm": "2026-01-01T00:00:00.000Z",
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 1000,
      "dcCpnCd": "dcCpnCd",
      "minBuyAmt": 1,
      "maxDcAmt": 1
    }
  ]
}

쿠폰 다운로드(FO)

post

기능설명

FO에서 쿠폰을 다운로드할 때 사용하는 API입니다.

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
프로모션 번호
- 발급방식코드가 03(고객다운로드발급) 인 쿠폰만 다운로드 가능합니다.
- 같은 쿠폰을 여러장 받으려면, 프로모션 번호를 원하는 개수 만큼 넣어야합니다.
할인쿠폰코드
- 발급방식코드가 04(할인쿠폰코드발급) 인 쿠폰만 다운로드 가능합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

promoNoListstring[]Optional

프로모션번호(cpnNo)

Example: ["C1000000, C1000001"]

dcCpnCdstringOptional

할인쿠폰코드

Example: dcCpnCd

downloadByPromoNobooleanOptional

Responses

200

성공

*/*

900

업무처리 오류 내용

*/*

post/v1/marketing/cpnDown

POST /api/order/v1/marketing/cpnDown HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "promoNoList": [
    "C1000000, C1000001"
  ],
  "dcCpnCd": "dcCpnCd",
  "downloadByPromoNo": true
}

{
  "cpnIssuList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션명",
      "cpnIsuNo": "0000001"
    }
  ]
}

쿠폰 다운로드(BO)

post

기능설명

배치, BO에서 쿠폰 다운로드를 할 때 사용하는 API입니다.

상세설명

발급방식코드가 조건부자동발급쿠폰인 경우 자동발급수량만큼 발급됩니다.
시스템사용자번호
- 배치: BATCH
- BO: 시스템 사용자의 ID

Header parameters

AuthorizationanyOptional

Access Token

Body

promoNoListstring[]Required

프로모션번호(cpnNo)

Example: ["C1000000, C1000001"]

mbrNostringRequired

회원번호

Example: 100000000

csCpnPayCausCdstring · enumOptional

쿠폰발급사유코드(MK021) 01 : 상품불량 , 02 : 배송지연 , 03 : 상품 오배송 , 04 : 상품품절 , 05 : 결품취소 , 06 : 상품누락 , 07 : 이벤트 불만 , 08 : 사이트 오류 , 09 : 재주문으로 인한 쿠폰 재발급 , 10 : 교환으로 인한 쿠폰 재발급 , 11 : 강성고객 클레임 , 12 : 기타

Example: 01Possible values:

systemUserNostringRequired

시스템사용자번호

Example: 100000000

autoIssuOdrstringRequired

자동발급차수

Example: 20230101

downloadByPromoNobooleanOptional

dcCpnCdstringOptional

Responses

200

성공

*/*

900

업무처리 오류 내용

*/*

post/v1/marketing/cpnDownBo

POST /api/order/v1/marketing/cpnDownBo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "promoNoList": [
    "C1000000, C1000001"
  ],
  "mbrNo": "100000000",
  "csCpnPayCausCd": "01",
  "systemUserNo": "100000000",
  "autoIssuOdr": "20230101",
  "downloadByPromoNo": true,
  "dcCpnCd": "text"
}

{
  "cpnIssuList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션명",
      "cpnIsuNo": "0000001"
    }
  ]
}

자동발급유형별 쿠폰 조회

get

기능설명

자동발급유형코드에 맞는 쿠폰정보를 조회합니다.

상세설명

배치 또는 프로그램에서 동일한 자동발급유형에 맞는 쿠폰을 발급시키고자 하는 경우에 사용 가능합니다.
예를 들어, 생일축하 쿠폰을 발급하고자 하면 MK008에 해당 코드를 추가하고,
쿠폰 등록 화면에서 자동발급유형을 해당 코드로 선택하여 등록합니다.
이후 현재 API의 request를 추가한 코드로 설정하면, 해당 코드로 등록된 쿠폰 리스트를 반환합니다.

Query parameters

autoIssuTypCdstringRequired

자동발급유형코드(MK008)

Example: 2101

gradeCdstring · enumOptional

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

프로모션 정보

promoNostringOptional

promoNmstringOptional

promoTypCdstringOptional

ourChrgRateinteger · int32Optional

entrChrgRateinteger · int32Optional

fixAmtFxrtGbCdstringOptional

dcRateAmtinteger · int64Optional

minBuyAmtinteger · int64Optional

maxDcAmtinteger · int64Optional

autoIssuPotmCdstringOptional

anvyPreIsuDdsinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v1/marketing/getCouponListByAutoIssuTypCd

GET /api/order/v1/marketing/getCouponListByAutoIssuTypCd?autoIssuTypCd=2101 HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

[
  {
    "promoNo": "text",
    "promoNm": "text",
    "promoTypCd": "text",
    "ourChrgRate": 1,
    "entrChrgRate": 1,
    "fixAmtFxrtGbCd": "text",
    "dcRateAmt": 1,
    "minBuyAmt": 1,
    "maxDcAmt": 1,
    "autoIssuPotmCd": "text",
    "anvyPreIsuDds": 1
  }
]

회원별 쿠폰 조회

get

기능설명

마이페이지 쿠폰함에서 사용자가 보유한 쿠폰 정보를 조회합니다.

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
사용자가 보유한 쿠폰 정보들을 조회합니다.
단, 관리자가 회수한 쿠폰은 노출되지 않습니다.

수정번호

Release v2.00_240401: 마이페이지 쿠폰정보 최소구매수량, 최소구매금액, 최대적용금액, 적용가능매체 추가
Release v2.00_240425: 사이트 검색조건 추가

Query parameters

sortGbstring · enumRequired

쿠폰정렬순서 10 : 최근등록순 , 20 : 마감임박순

Example: 10Possible values:

rowsPerPageintegerRequired

화면당노출수량

Example: 10

pageIdxintegerRequired

페이지번호

Example: 1

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

promoCntinteger · int32Required

사용가능한 전체 쿠폰수량

Example: 1

totPromoCntinteger · int32Required

발급된 전체 쿠폰수량

Example: 1

rowsPerPageinteger · int32Optional

화면당노출수량

Example: 10

pageIdxinteger · int32Optional

페이지번호

Example: 1

900

업무처리 오류 내용

*/*

get/v1/marketing/cpnIssuList

GET /api/order/v1/marketing/cpnIssuList?sortGb=10&rowsPerPage=10&pageIdx=1 HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "promoCnt": 1,
  "totPromoCnt": 1,
  "rowsPerPage": 10,
  "pageIdx": 1,
  "cpnIssuList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션명",
      "promoTypCd": "11",
      "promoDesc": "프로모션설명",
      "cpnIsuNo": "0000001",
      "valiStrtDtm": "2026-01-01T00:00:00.000Z",
      "valiEndDtm": "2026-01-01T00:00:00.000Z",
      "remainingDay": "1",
      "promoStat": "10",
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 1000,
      "dcCpnCd": "dcCpnCd",
      "minBuyQty": 1,
      "minBuyAmt": 10,
      "maxDcAmt": 1000,
      "mediaCdNmArray": "Pc, Mobile, App"
    }
  ]
}

이전프로모션 사은행사

다음이벤트 제공

마지막 업데이트 4개월 전