Coupon Issuance

Look Up Downloadable Coupons for Product Detail

post

Function Description

Looks up coupons downloadable/usable for a product

Detailed Description

This is a member-only API; non-members cannot use it.
Looks up coupons downloadable/usable for the product.
Usable coupon lookup (coupon type = 10)
- Lookup conditions
  - Promotion type: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon
  - Coupon issuer: All
  - Coupon issuance method: All
Downloadable coupon lookup (coupon type = 20)
- Lookup conditions
  - Promotion type: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon
  - Coupon issuer: Fixed promotional coupon
  - Coupon issuance method: Customer download issuance, discount coupon code issuance

Revision History

Release v2.00_240425: Added minimum purchase amount and maximum discount amount data
Release v2.00_240509: Added lookup of applicable target - special exhibition information

Header parameters

AuthorizationanyOptional

Access Token

Body

ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

cpnTypestring · enumRequired

Product Detail Coupon Search Condition 10 : Usable Coupons , 20 : Downloadable Coupons

Example: 10Possible values:

sortGbstring · enumRequired

Coupon Sort Order 10 : Most Recently Registered , 20 : Expiring Soon

Example: 10Possible values:

rowsPerPageinteger · int32Required

Display Quantity per Screen

Example: 10

pageIdxinteger · int32Required

Page No.

Example: 1

Responses

200

Success

*/*

promoCntinteger · int32Required

Coupon Issuance Quantity

Example: 1

rowsPerPageinteger · int32Required

Display Quantity per Screen

Example: 10

pageIdxinteger · int32Required

Page No.

Example: 1

900

Business processing error details

*/*

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
    }
  ]
}

Download Coupon (FO)

post

Function Description

An API used to download a coupon on FO.

Detailed Description

This is a member-only API; non-members cannot use it.
Promotion number
- Only coupons with issuance method code 03 (customer download issuance) can be downloaded.
- To receive multiple copies of the same coupon, enter the promotion number the desired number of times.
Discount coupon code
- Only coupons with issuance method code 04 (discount coupon code issuance) can be downloaded.

Header parameters

AuthorizationanyOptional

Access Token

Body

promoNoListstring[]Optional

Promotion No. (cpnNo)

Example: ["C1000000, C1000001"]

dcCpnCdstringOptional

Discount Coupon Code

Example: dcCpnCd

downloadByPromoNobooleanOptional

Responses

200

Success

*/*

900

Business processing error details

*/*

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"
    }
  ]
}

Download Coupon (BO)

post

Function Description

An API used for coupon download from the batch or BO.

Detailed Description

If the issuance method code is a conditional auto-issue coupon, it is issued according to the auto-issue quantity.
System user number
- Batch: BATCH
- BO: the system user's ID

Header parameters

AuthorizationanyOptional

Access Token

Body

promoNoListstring[]Required

Promotion No. (cpnNo)

Example: ["C1000000, C1000001"]

mbrNostringRequired

Member No.

Example: 100000000

csCpnPayCausCdstring · enumOptional

Coupon Issuance Reason Code (MK021) 01 : Product Defect , 02 : Delivery Delay , 03 : Incorrect Product Shipped , 04 : Product Out of Stock , 05 : Out-of-Stock Cancellation , 06 : Missing Product , 07 : Event Complaint , 08 : Site Error , 09 : Coupon Reissuance Due to Reorder , 10 : Coupon Reissuance Due to Exchange , 11 : Difficult Customer Claim , 12 : Other

Example: 01Possible values:

systemUserNostringRequired

System User No.

Example: 100000000

autoIssuOdrstringRequired

Auto-Issuance Batch No.

Example: 20230101

downloadByPromoNobooleanOptional

dcCpnCdstringOptional

Responses

200

Success

*/*

900

Business processing error details

*/*

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"
    }
  ]
}

Search Coupons by Auto-Issue Type

get

Function Description

Retrieves coupon information matching the auto-issue type code.

Detailed Description

Can be used when a batch or program wants to issue coupons matching the same auto-issue type.
For example, to issue a birthday congratulation coupon, add the corresponding code to MK008,
then select that code as the auto-issue type on the coupon registration screen when registering.
Afterward, if the request of this API is set with the added code, it returns the list of coupons registered with that code.

Query parameters

autoIssuTypCdstringRequired

Auto-Issue Type Code (MK008)

Example: 2101

gradeCdstring · enumOptional

Member Grade Code (ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Promotion Info

promoNostringOptional

promoNmstringOptional

promoTypCdstringOptional

ourChrgRateinteger · int32Optional

entrChrgRateinteger · int32Optional

fixAmtFxrtGbCdstringOptional

dcRateAmtinteger · int64Optional

minBuyAmtinteger · int64Optional

maxDcAmtinteger · int64Optional

autoIssuPotmCdstringOptional

anvyPreIsuDdsinteger · int32Optional

900

Business processing error details

*/*

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
  }
]

Search Coupons by Member

get

Function Description

Retrieves the coupon information held by the user in My Page's Coupon Box.

Detailed Description

This is a member-only API; non-members cannot use it.
Retrieves the coupon information held by the user.
However, coupons withdrawn by the administrator are not shown.

Revision History

Release v2.00_240401: Added minimum purchase quantity, minimum purchase amount, maximum applicable amount, and applicable media to My Page coupon information
Release v2.00_240425: Added site search condition

Query parameters

sortGbstring · enumRequired

Coupon Sort Order 10 : Most Recently Registered , 20 : Expiring Soon

Example: 10Possible values:

rowsPerPageintegerRequired

Display Quantity per Screen

Example: 10

pageIdxintegerRequired

Page No.

Example: 1

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

promoCntinteger · int32Required

Total Usable Coupon Quantity

Example: 1

totPromoCntinteger · int32Required

Total Issued Coupon Quantity

Example: 1

rowsPerPageinteger · int32Optional

Display Quantity per Screen

Example: 10

pageIdxinteger · int32Optional

Page No.

Example: 1

900

Business processing error details

*/*

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"
    }
  ]
}

PreviousPromotion Gift Event

NextEvent Provision

Last updated 1 month ago