For the complete documentation index, see llms.txt. This page is also available as Markdown.

Promotion Accumulation

Look Up Promotion Accrual Information

post

Function Description

  • Looks up the member's accrual information at order time.


Detailed Description

  • This is a member-only API; non-members cannot use it.

  • 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.


Revision History

  • Release v1.03_231106: Checks whether mileage is applicable per product

  • Release v1.06_231218: Added basic accrual filter for claims

  • Release v1.06_231218: Sets claim status data for claim accrual

Header parameters
AuthorizationanyOptional

Access Token

Body

Retrieve Accrual 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:
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:
baseDtmstring · date-timeRequired

Reference Date/Time

Responses
200

Success

*/*

Accrual Information

totalAccmAmtinteger · int64Required

Total Accrual Amount

Example: 3000
post/v1/marketing/promotionAccumulation
POST /api/order/v1/marketing/promotionAccumulation HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 3041

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "purchaseAmt": 6000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "promoNo": "C1000000'"
    }
  ],
  "ordAccmList": [
    {
      "accmGbCd": "21",
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "rsrvStdAmt": 5000,
      "accmRate": 10
    }
  ],
  "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
      }
    ]
  }
}
{
  "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
        }
      ]
    }
  ]
}

Last updated