Promotion Discount

Look Up Order Form Delivery Fee Coupons

post

Function Description

Looks up delivery fee coupon information by delivery group.

Detailed Description

This is a member-only API; non-members cannot use it.
The same coupon can appear in more than one delivery group.
Under the current policy, only one delivery fee coupon can be applied per order.
Depending on the promotion type, free-shipping coupons and free-return coupons can be looked up.

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Shipping Fee Coupon Request

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstring · enumRequired

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

Example: 10Possible values:

promoTypCdstring · enumRequired

Promotion Type (Free Shipping Coupon, Free Return Shipping Coupon)

Example: 14Possible values:

baseDtmstring · date-timeRequired

Reference Date/Time

Responses

200

Success

*/*

usePsbDlvCpnCntinteger · int32Required

Number of Available Free Shipping Coupons

usePsbClmDlvCpnCntinteger · int32Required

Number of Available Free Return Coupons

900

Business processing error details

*/*

post/v1/marketing/orderDlvBenefitList

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

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "promoTypCd": "14",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "deliGrpInfoList": [
    {
      "deliNo": "100000001",
      "entrNo": "10000000"
    }
  ]
}

{
  "usePsbDlvCpnCnt": 1,
  "usePsbClmDlvCpnCnt": 1,
  "deliGrpInfo": [
    {
      "deliNo": "100000001",
      "entrNo": "10000000",
      "benefitList": [
        {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      ]
    }
  ]
}

Look Up Order Form Maximum Benefit Price

post

Function Description

Looks up the maximum-benefit / usable discount information based on conditions.

Detailed Description

This is a member-only API; non-members cannot use it.
When a coupon/discount is selected: looks up the maximum benefit.
When no coupon/discount is selected: checks whether the selected coupon/discount is usable.
Checks and calculates the usable benefit information for the given product.
Benefits that would cause a reverse margin on the product due to the discount are not returned.

Revision History

Release v1.03_231106: Added employee discount limit management
Release v2.00_240530: Made the maximum benefit calculation account for order quantity

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Coupon Benefit Request

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstring · enumRequired

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

Example: 10Possible values:

comGbCdstringRequired

Company Classification Code (ME038)

Example: P00

stafYnstringRequired

Employee Status

Example: Y

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:

ordTypeGbCdstring · enumRequired

Order Type 10 : Cart , 20 : Order , 30 : Claim

Example: 10Possible values:

baseDtmstring · date-timeRequired

Reference Date/Time

Responses

200

Success

*/*

Search Coupon Benefit Response

totalDcAmtinteger · int64Required

Total Discount Amount

Example: 10000

900

Business processing error details

*/*

post/v1/marketing/orderBenefitList

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

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "ordTypeGbCd": "10",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "bnfList": [
        {
          "promoNo": "C1000000",
          "cpnIsuNo": "100000000"
        }
      ]
    }
  ],
  "orderBnfList": [
    {
      "promoNo": "C1000000",
      "cpnIsuNo": "100000000"
    }
  ]
}

{
  "totalDcAmt": 10000,
  "goodsBenefitList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "dcAmt": 5000,
      "benefitList": [
        {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      ]
    }
  ],
  "orderBenefitList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "isMaxYn": "Y",
      "dcAmt": 5000,
      "cpnIsuNo": "100000",
      "goods": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "dcAmt": 5000
        }
      ]
    }
  ]
}

Look Up Product Detail Maximum Benefit Price

post

Function Description

Calculates the discount information with the largest discount amount among the benefits usable for the product.

Detailed Description

Calculates the discount information with the largest discount amount among the benefits usable for the product.
For members, downloadable coupons are also included in the maximum benefit calculation.
Discount information applied in the maximum benefit calculation
- Non-members
  - Promotion (discount): Product instant discount (applicable member grade: all selected, all unselected (considering data migration))
- Members
  - Promotion (discount): Employee discount, product instant discount
  - Held coupons: Product discount coupon
  - Downloadable coupons
    Promotion type: Product discount coupon
    Coupon issuer: Fixed promotional coupon
  - Coupon issuance method: Customer download issuance, discount coupon code issuance

Revision History

Release v1.03_231106: Added employee discount limit management

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Product Detail Maximum Benefit Price Request

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:

Responses

200

Success

*/*

goodsNostringRequired

Product No.

Example: 10000001

itmNostringRequired

Item No.

Example: 001

salePrcinteger · int64Required

Selling Price

Example: 9000

maxBenefitAmtinteger · int64Required

Maximum Discount Benefit Amount (Maximum Benefit Price)

Example: 8500

900

Business processing error details

*/*

post/v1/marketing/maxDcAmt

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

{
  "ordMediaCd": "20",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 8000,
      "salePrc": 9000,
      "cnt": 1,
      "stdCtgNo": "HT01020000",
      "dispCtgNo": "213",
      "brandNo": "100002",
      "entrNo": "1000002",
      "chlNo": "1000001",
      "marketingDisplayNo": "1000001"
    }
  ]
}

[
  {
    "goodsNo": "10000001",
    "itmNo": "001",
    "salePrc": 9000,
    "maxBenefitAmt": 8500,
    "promoList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션명",
        "promoTypCd": "11",
        "dcAmt": 500
      }
    ]
  }
]

Look Up Product Instant Discount Price

post

Function Description

Looks up the usable product instant discount per product.

Detailed Description

An API that looks up the product instant discount with the largest discount rate for each given product.

Header parameters

AuthorizationanyOptional

Access Token

Body

baseDtmstring · date-timeRequired

Reference Date/Time

Responses

200

Success

*/*

goodsNostringRequired

Product No.

itmNostringRequired

Item No.

salePrcinteger · int64Required

Selling Price

promoNostringRequired

Promotion No.

promoNmstringRequired

Promotion Name

fixamtFxrtGbCdstring · enumRequired

Fixed Amount/Rate Type Code (MK005) 01: Fixed Amount , 02: Fixed Rate

Example: 01Possible values:

dcRateAmtinteger · int64Required

Discount Rate/Amount

dcAmtinteger · int64Required

Discount Amount

900

Business processing error details

*/*

post/v1/marketing/goodsDirectDiscountList

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

{
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000
    }
  ]
}

[
  {
    "goodsNo": "text",
    "itmNo": "text",
    "salePrc": 1,
    "promoNo": "text",
    "promoNm": "text",
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 1,
    "dcAmt": 1
  }
]

Look Up Maximum Delivery Fee Benefit

post

Function Description

An API that looks up only the delivery fee coupon information from the order form coupon list lookup API.

Detailed Description

Delivery fee coupon information: Looks up the usable delivery fee coupon information by delivery group, and sets the delivery fee coupon on one delivery group according to the sort order below.
- Delivery fee Desc -> Additional delivery fee Desc -> Delivery group number Asc

Header parameters

AuthorizationanyOptional

Access Token

Body

Coupon Selection Popup Request

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstring · enumRequired

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

Example: 10Possible values:

comGbCdstringRequired

Company Classification Code (ME038)

Example: P00

stafYnstringRequired

Employee Status

Example: Y

ordMediaCdstring · enumOptional

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:

baseDtmstring · date-timeRequired

Reference Date/Time

cpnPopupGbCdstring · enumOptional

Coupon Popup Type Code 10 : Order Form , 20 : Coupon Selection Popup

Example: 10Possible values:

Responses

200

Success

*/*

dlvCpnCntinteger · int64Required

Number of Available Delivery Fee Coupons

900

Business processing error details

*/*

post/v1/marketing/getMaxBenefitDeliveryCoupon

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

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "dlvCpnCnt": 1,
  "dlvGrpInfo": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ]
}

Look Up Order Form Coupon List

post

Function Description

An API used in the order form coupon selection pop-up.

Detailed Description

Looks up usable benefit information upon entering the coupon selection pop-up; the lookup content is as follows.
- Employee discount: Automatically calculates and returns the single largest benefit among the employee discounts usable per product.
- Product instant discount: Automatically calculates and returns the single largest benefit among the product instant discounts usable per product.
- Product-level benefit information: Returns coupon information usable per product. Based on this information, the script calculates and displays actual usability.
- Cart-level benefit information: Returns coupon information usable at the order-form level. Based on this information, the script calculates and displays actual usability.
- Member-held coupon information: Contains information on coupons (excluding delivery fee coupons) held by the member. Based on this information, the script calculates and displays actual usability.
- Delivery fee coupon information: Looks up the usable delivery fee coupon information by delivery group, and sets the delivery fee coupon on one delivery group according to the sort order below.
  - Delivery fee Desc -> Additional delivery fee Desc -> Delivery group number Asc
- Maximum benefit information: Contains the discount information that is the maximum benefit among the usable benefit information.

Revision History

Release v1.03_231106: Added employee discount limit management
Release v2.00_240509: Added lookup of applicable target - special exhibition information
Release v2.00_241205: Fixed an issue where the minimum purchase quantity/minimum purchase amount set on a coupon was always checked based on a single unit regardless of the number of ordered products

Header parameters

AuthorizationanyOptional

Access Token

Body

Coupon Selection Popup Request

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstring · enumRequired

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

Example: 10Possible values:

comGbCdstringRequired

Company Classification Code (ME038)

Example: P00

stafYnstringRequired

Employee Status

Example: Y

ordMediaCdstring · enumOptional

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:

baseDtmstring · date-timeRequired

Reference Date/Time

cpnPopupGbCdstring · enumOptional

Coupon Popup Type Code 10 : Order Form , 20 : Coupon Selection Popup

Example: 10Possible values:

Responses

200

Success

*/*

Coupon Selection Popup Response

900

Business processing error details

*/*

post/v1/marketing/getCouponPopupData

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

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "executivesDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsDirectDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsBenefitInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "promoNoList": [
        "C1000000"
      ]
    }
  ],
  "basketCouponBenefitinfo": [
    {
      "promoNo": "C1000000",
      "goodsList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001"
        }
      ]
    }
  ],
  "promoList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "couponIssuedInfo": [
        {
          "cpnIsuNo": "100000000",
          "mbrNo": "100000000",
          "cpnNo": "C1000000",
          "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
          "valiStrtDtm": "2026-01-01T00:00:00.000Z",
          "valiEndDtm": "2026-01-01T00:00:00.000Z",
          "useYn": "N"
        }
      ],
      "goodsNo": "10000001",
      "itmNo": "001",
      "baseAmt": 1
    }
  ],
  "dlvCouponInfo": {
    "dlvCpnCnt": 1,
    "dlvGrpInfo": [
      {
        "deliNo": "100000001",
        "entrNo": "1000000",
        "benefitInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      }
    ]
  },
  "maxBenefitInfo": {
    "totalDcAmt": 10000,
    "goodsBenefitList": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      }
    ],
    "orderBenefitList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "fixamtFxrtGbCd": "01",
        "dcRateAmt": 5000,
        "minBuyAmt": 1000,
        "maxDcAmt": 5000,
        "isMaxYn": "Y",
        "dcAmt": 5000,
        "cpnIsuNo": "100000",
        "goods": [
          {
            "goodsNo": "10000001",
            "itmNo": "001",
            "dcAmt": 5000
          }
        ]
      }
    ]
  }
}

Look Up Promotion List for Agent Order Form

post

Function Description

An API that looks up promotions selectable for an order entered by an agent.

Detailed Description

Looks up promotions selectable during a BO agent's order process.

Notes

Identical logic to the getCouponPopupData (promotion discount) API.
The difference is that the order is created using the member number (mbrNo) in the parameter, and the member number is a required parameter.

Header parameters

AuthorizationanyOptional

Access Token

Body

Coupon Selection Popup Request

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstring · enumRequired

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

Example: 10Possible values:

comGbCdstringRequired

Company Classification Code (ME038)

Example: P00

stafYnstringRequired

Employee Status

Example: Y

ordMediaCdstring · enumOptional

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:

baseDtmstring · date-timeRequired

Reference Date/Time

cpnPopupGbCdstring · enumOptional

Coupon Popup Type Code 10 : Order Form , 20 : Coupon Selection Popup

Example: 10Possible values:

Responses

200

Success

*/*

Coupon Selection Popup Response

900

Business processing error details

*/*

post/v1/marketing/getCounselorOrderCouponPopupData

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

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "executivesDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsDirectDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsBenefitInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "promoNoList": [
        "C1000000"
      ]
    }
  ],
  "basketCouponBenefitinfo": [
    {
      "promoNo": "C1000000",
      "goodsList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001"
        }
      ]
    }
  ],
  "promoList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "couponIssuedInfo": [
        {
          "cpnIsuNo": "100000000",
          "mbrNo": "100000000",
          "cpnNo": "C1000000",
          "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
          "valiStrtDtm": "2026-01-01T00:00:00.000Z",
          "valiEndDtm": "2026-01-01T00:00:00.000Z",
          "useYn": "N"
        }
      ],
      "goodsNo": "10000001",
      "itmNo": "001",
      "baseAmt": 1
    }
  ],
  "dlvCouponInfo": {
    "dlvCpnCnt": 1,
    "dlvGrpInfo": [
      {
        "deliNo": "100000001",
        "entrNo": "1000000",
        "benefitInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      }
    ]
  },
  "maxBenefitInfo": {
    "totalDcAmt": 10000,
    "goodsBenefitList": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      }
    ],
    "orderBenefitList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "fixamtFxrtGbCd": "01",
        "dcRateAmt": 5000,
        "minBuyAmt": 1000,
        "maxDcAmt": 5000,
        "isMaxYn": "Y",
        "dcAmt": 5000,
        "cpnIsuNo": "100000",
        "goods": [
          {
            "goodsNo": "10000001",
            "itmNo": "001",
            "dcAmt": 5000
          }
        ]
      }
    ]
  }
}

Look Up Agent Order Accrual Information

post

Function Description

Looks up the member's accrual information for an agent order.

Detailed Description

At order time, there are three types: basic accrual, member-grade additional accrual, and promotion accrual.
- Basic accrual: Accrued at the set accrual rate at order time, with no special conditions.
- Member-grade additional accrual: Additional accrual at the rate matching the member's grade if the order exceeds the threshold amount.
- Promotion accrual: Additional accrual at the accrual rate of the applicable product mileage per product. However, only one promotion accrual is possible per product.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO Order Accrual Retrieval Request DTO

ordMediaCdstring · enumOptional

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:

mbrNostringRequired

Member No.

Example: 100000000

mbrGradeCdstringRequired

Member Grade Code

Responses

200

Success

*/*

Accrual Information

totalAccmAmtinteger · int64Required

Total Accrual Amount

Example: 3000

900

Business processing error details

*/*

post/v1/marketing/getCounselorOrderAccumulationInfo

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

{
  "ordGoodsInfoList": [
    {
      "basketGoods": {
        "goodsNo": "100000001",
        "deliProcTypCd": "10",
        "deliPolcNo": "1",
        "deliNo": "100000021",
        "entrNo": "1000001",
        "ordQty": 1,
        "salePrc": 15000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "itmNo": "001",
        "bsketNo": 100000001,
        "chlNo": "1",
        "chlDtlNo": "1",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": "1",
        "repDispCtgNo": "1",
        "conrNo": "1",
        "bsketQty": 1,
        "goodsNm": "상품명",
        "stdCtgNo": "1",
        "goodsCompCd": "10",
        "goodsTypCd": "10",
        "saleMethCd": "10",
        "brandNo": "1",
        "brandNm": "브랜드명",
        "buyrAgeLmtCd": "0",
        "dispYn": "Y",
        "saleStatCd": "10",
        "saleStrDtm": "2026-01-01T00:00:00.000Z",
        "saleEndDtm": "2026-01-01T00:00:00.000Z",
        "buyTypCd": "10",
        "taxGbCd": "10",
        "stkMgrYn": "Y",
        "buyQtyLmtYn": "Y",
        "minLmtQty": 1,
        "maxLmtQty": 10,
        "safeStkNotiYn": "Y",
        "deliGoodsGbCd": "01",
        "deliWayCd": "01",
        "deliPsbRgnCd": "01",
        "deliDday": 1,
        "bpckPsbYn": "Y",
        "rtnPsbYn": "Y",
        "exchPsbYn": "Y",
        "supPcost": 10000,
        "norPrc": 20000,
        "preSalePrc": 20000,
        "mrgnRate": 4,
        "payMeanInfo": "11,12,32",
        "itmNm": "아이템명1>아이템명2>아이템명3",
        "stkQty": 999,
        "prestNm": "증정품명",
        "rsvStrtDtm": "2026-01-01T00:00:00.000Z",
        "rsvEndDtm": "2026-01-01T00:00:00.000Z",
        "fwdidcPrarDy": "2026-01-01",
        "hsCd": "1",
        "wishYn": "Y",
        "maxDcAmt": 1000,
        "goodsImg": "files/goods/2023/07/04/img",
        "itmSaleStatCd": "10",
        "gvgfPsbYn": "Y",
        "rglrDeliGoodsYn": "Y",
        "sngGoodsYn": "Y",
        "marketingDisplayNo": "1",
        "entrGoodsNo": "100042110583831",
        "entrItmNo": "100042110583831001",
        "ordCnclPsbYn": "N",
        "wthdYn": "N",
        "frgnDirPurGoodsYn": "text"
      },
      "aplyGoodsBnfInfo": {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      },
      "aeEvtList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "aeNo": "C1000000",
          "addEvtTypCd": "20",
          "aeStrDtm": "2026-01-01T00:00:00.000Z",
          "aeEndDtm": "2026-01-01T00:00:00.000Z",
          "payStrDt": "20231201",
          "payEndDt": "20231231",
          "tmEvtYn": "N",
          "aplyStrTm": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "benefitOrderPromotionInfo": {
    "promoNo": "C1000000",
    "promoNm": "프로모션 명",
    "promoTypCd": "11",
    "ourChrgRate": 100,
    "entrChrgRate": 0,
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 5000,
    "minBuyAmt": 1000,
    "maxDcAmt": 5000,
    "isMaxYn": "Y",
    "dcAmt": 5000,
    "cpnIsuNo": "100000",
    "goods": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000
      }
    ]
  },
  "ordMediaCd": "20",
  "mbrNo": "100000000",
  "mbrGradeCd": "text"
}

{
  "totalAccmAmt": 3000,
  "accmList": [
    {
      "accmGbCd": "21",
      "accmRate": 10,
      "accmAmt": 3000,
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "40",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "rsrvStdAmt": 5000,
      "goodsAccmList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "accmAmt": 3000
        }
      ]
    }
  ]
}

Process Order Form Coupon Use

post

Function Description

Marks the coupons selected in the order as used.

Detailed Description

This is a member-only API; non-members cannot use it.
Marks the coupons selected in the order as used.
Only coupons meeting the following conditions can be used.
- Coupon period: valid
- Usage status: unused

Header parameters

AuthorizationanyOptional

Access Token

Body

Used Coupon Info Request DTO

mbrNostringRequired

Member No.

Example: 100000000

ordNostringRequired

Order No.

Example: 20230101O000001

cpnIsuNoListstring[]Optional

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/marketing/cpnUse

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

{
  "mbrNo": "100000000",
  "ordNo": "20230101O000001",
  "cpnInfo": [
    {
      "cpnIsuNo": "0000001"
    }
  ],
  "cpnIsuNoList": [
    "text"
  ]
}

No content

Cancel/Restore Coupon

post

Function Description

Cancels/restores a coupon.

Detailed Description

Order form
- When restoration classification code is 10
- Removes the usage-related information from the existing coupon issuance information.
Claim/other
- When restoration classification code is 20 (claim) or 99 (other)
- Issues a new coupon using the existing issuance information.
  - Coupon number, original coupon issuance number, member notification status, member number
- If the validity period of the issued coupon has expired, reissues a coupon valid for the coupon-restoration validity days of ST001 from the current date.

Header parameters

AuthorizationanyOptional

Access Token

Body

Restored Coupon Info Request DTO

mbrNostringRequired

Member No.

Example: 100000000

ordNostringRequired

Order No.

Example: 20230101O000001

restoreGbCdstring · enumRequired

Coupon Restoration Type 10 : Order Form , 20 : Claim , 99 : Other

Example: 10Possible values:

cpnIsuNoListstring[]Optional

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/marketing/cpnCancel

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

{
  "mbrNo": "100000000",
  "ordNo": "20230101O000001",
  "restoreGbCd": "10",
  "cpnInfo": [
    {
      "cpnIsuNo": "0000001"
    }
  ],
  "cpnIsuNoList": [
    "text"
  ]
}

No content

Search Coupon Count by Member

get

Function Description

Retrieves the count of the member's coupons and delivery-related coupons via the BO API.

Detailed Description

Retrieves the count of unused, currently valid coupons held by the member.

Query parameters

mbrNostringRequired

Member No.

Example: 100000000

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Coupon Quantity Held by Member

dlvCntinteger · int32Optional

Free Shipping Coupon Quantity

cpnCntinteger · int32Optional

General Coupon Quantity

900

Business processing error details

*/*

get/v1/marketing/mbrCpnCnt

GET /api/order/v1/marketing/mbrCpnCnt?mbrNo=100000000 HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "dlvCnt": 1,
  "cpnCnt": 1
}

Search Basic Coupon Info

get

Function Description

Retrieves the basic information of the given promotion number.

Detailed Description

Retrieves the basic information of the currently running promotions for the given promotion numbers.

Revision History

Release v2.00_240401: Added applicable media to event coupon lookup

Query parameters

promoNoListstring[]Optional

Promotion Number List

Example: C1000000

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

promoNostringRequired

Promotion No.

Example: C1000000

promoNmstringOptional

Promotion Name

Example: 프로모션명

promoTypCdstring · enumRequired

Promotion Type Code (MK002) 11 : Product Discount Coupon , 12 : Cart Coupon , 13 : Stackable Discount Coupon , 14 : Free Shipping Coupon , 15 : Free Return Coupon , 20 : Employee Discount , 21 : Instant Product Discount , 40 : Product Mileage

Example: 11Possible values:

promoStatCdstring · enumRequired

Promotion Status Code (MK003) 10 : In Progress , 20 : Suspended

Example: 10Possible values:

promoDescstringOptional

Promotion Description

Example: 프로모션 설명

aplyTermGbCdstring · enumRequired

Applicable Period Type Code (MK015) 01 : Period-Based , 02 : Issuance-Date-Based

Example: 01Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

Coupon Usage Days from Issuance Date

valiStrtDtmstring · date-timeRequired

Validity Start Date/Time

valiEndDtmstring · date-timeRequired

Validity End Date/Time

fixamtFxrtGbCdstring · enumRequired

Fixed Amount/Rate Type Code (MK005) 01: Fixed Amount , 02: Fixed Rate

Example: 01Possible values:

dcRateAmtinteger · int64Required

Discount Rate/Amount

appOnlybooleanRequired

App-Only Status

minBuyQtyinteger · int32Required

Minimum Purchase Quantity

minBuyAmtinteger · int64Required

Minimum Purchase Amount

maxDcAmtinteger · int64Required

Maximum Discount Amount

mediaCdNmArraystringOptional

Applicable Media

Example: Pc, Mobile, App

900

Business processing error details

*/*

get/v1/marketing/cpnInfoList

GET /api/order/v1/marketing/cpnInfoList HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

[
  {
    "promoNo": "C1000000",
    "promoNm": "프로모션명",
    "promoTypCd": "11",
    "promoStatCd": "10",
    "promoDesc": "프로모션 설명",
    "aplyTermGbCd": "01",
    "issuDdStdCpnUseDds": 1,
    "valiStrtDtm": "2026-01-01T00:00:00.000Z",
    "valiEndDtm": "2026-01-01T00:00:00.000Z",
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 1,
    "appOnly": true,
    "minBuyQty": 1,
    "minBuyAmt": 1,
    "maxDcAmt": 1,
    "mediaCdNmArray": "Pc, Mobile, App"
  }
]

PreviousPromotion Accumulation

NextPromotion Gift Event

Last updated 1 month ago