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

Promotion Gift Event

Check Whether Gift Event Is Applicable

post

Function Description

  • Checks whether the selected gift event is actually usable.


Detailed Description

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

  • Checks whether the selected gift event actually meets its application conditions.

  • Checks whether the amount after applying benefits to the currently purchased products meets the amount condition of the selected gift event.


Notes

Related API List

  • Item detail lookup: /api/goods/v1/detail/goods


Revision History

  • Release v1.06_231218 : Fixed duplicate gift event lookup

Header parameters
AuthorizationanyOptional

Access Token

Body

Select Gift Event 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:
baseDtmstring · date-timeOptional

Reference Date/Time

Responses
200

Success

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

{
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "salePrc": 7000,
      "cnt": 1,
      "aeNo": "C1000000",
      "aeGoodsNo": "10000001",
      "aeGoodsItmNo": "001"
    }
  ]
}
{
  "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"
        }
      ]
    }
  ]
}

Order Form Gift Promotion Retrieval

post

Function Description

  • Looks up the gift events selectable for the current order.


Detailed Description

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

  • If the same gift event is applicable to multiple products, it is applied to only one product.

  • The criteria for selecting the product are as follows.

    • Sale price: descending

    • Product No.: ascending

    • Item No.: ascending

Header parameters
AuthorizationanyOptional

Access Token

Body

Select Gift Event 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:
baseDtmstring · date-timeOptional

Reference Date/Time

Responses
200

Success

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

{
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "salePrc": 7000,
      "cnt": 1,
      "aeNo": "C1000000",
      "aeGoodsNo": "10000001",
      "aeGoodsItmNo": "001"
    }
  ]
}
{
  "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"
        }
      ]
    }
  ]
}

Look Up Gift Events for Product Detail

post

Function Description

  • Looks up the list of gift events usable in the product detail page.


Detailed Description

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

  • Looks up gift event information selectable for the product.

  • Among selectable gift events, only those whose gift meets the following conditions are looked up.

    • Stock: exists

    • Gift status: for sale

    • Delivery type: combined shipping

Header parameters
AuthorizationanyOptional

Access Token

Body

Select Gift Event 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:
baseDtmstring · date-timeOptional

Reference Date/Time

Responses
200

Success

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

{
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "salePrc": 7000,
      "cnt": 1,
      "aeNo": "C1000000",
      "aeGoodsNo": "10000001",
      "aeGoodsItmNo": "001"
    }
  ]
}
{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "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"
        }
      ]
    }
  ]
}

Last updated