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

Event Provision

Save Gift Delivery Address

post

Function Description

  • Registers or modifies the delivery address for event gift delivery.


Detailed Description

  • If the miscellaneous gift delivery address number is absent, registers a delivery address

  • If the miscellaneous gift delivery address number is present, modifies the delivery address

  • Only delivery address information can be changed during modification.

    • (recipient, recipient phone number, delivery address, detailed delivery address, etc.)

  • The miscellaneous gift delivery address number is required when completing registration or modification.

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject · EtcGftDlvpRequest[]

Register/Modify Gift Delivery Address Request

etcGftDlvpNostring · enum · nullableOptional

Other Gift Delivery Address No.

Example: 등록 시 null, 수정 시 기타사은품배송지번호Possible values:
etcGftIssuSubCdstring · enum · nullableOptional

Other Free Gift Issuer Code (MK022) (Required upon Registration)

Example: 10Possible values:
etcGftIssuSubNostring · nullableOptional

Other Gift Issuer No.

Example: 1
etcGftIssuSubDtlNostring · nullableOptional

Other Gift Issuer Detail No.

Example: 1
etcGftNmstring · nullableOptional

Free Gift Name

Example: 10
mbrNostring · nullableOptional

Customer No.

Example: 100000631
mbrNmstring · nullableOptional

Customer Name

Example: 홍길동
loginIdstring · nullableOptional

Member ID

Example: honggildong
goodsNostring · nullableOptional

Product No.

Example: 100000001
goodsNmstring · nullableOptional

Product Name

Example: 상품명
rcvmnNmstringOptional

Recipient Name

Example: 홍길동
zipNostringOptional

Postal Code

Example: 55221
zipAddrstringOptional

Postal Address

Example: 서울특별시 송파구 법원로10길 H비지니스파크
dtlAddrstringOptional

Detailed Address

Example: 6층
cellSctNostringOptional

Mobile Phone Prefix Code

Example: 010
cellTxnoNostringOptional

Mobile Phone Exchange Code

Example: 1111
cellEndNostringOptional

Mobile Phone Last Digits

Example: 2222
deliMsgstring · nullableOptional

Delivery Message

Example: 10
comnFrdrEtcMethodstring · nullableOptional

Other Common Entrance Access Method

Example: 기타 방법입니다.
comnFrdrPwdstring · nullableOptional

Common Entrance Password

Example: 1234
sysRegIdstringOptional

Registrant ID

Example: admin
winRnkinteger · int32 · nullableOptional

Winner Rank

Example: 1
comnFrdrCogoMethodCdstring · enum · nullableOptional

Common Entrance Access Method Code (ME040)

Example: 10Possible values:
Responses
200

Success

*/*

Register/Modify Gift Delivery Address Request

etcGftDlvpNostringOptional

Other Gift Delivery Address No.

Example: 1
etcGftIssuSubNostring · nullableOptional

Other Gift Issuer No.

Example: 1
etcGftIssuSubDtlNostring · nullableOptional

Other Gift Issuer Detail No.

Example: 1
winRnkinteger · int32 · nullableOptional

Winner Rank

Example: 1
post/v1/event/registModifyEtcGftDlvp
POST /api/order/v1/event/registModifyEtcGftDlvp HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 598

[
  {
    "etcGftDlvpNo": "등록 시 null, 수정 시 기타사은품배송지번호",
    "etcGftIssuSubCd": "10",
    "etcGftIssuSubNo": "1",
    "etcGftIssuSubDtlNo": "1",
    "etcGftNm": "10",
    "mbrNo": "100000631",
    "mbrNm": "홍길동",
    "loginId": "honggildong",
    "goodsNo": "100000001",
    "goodsNm": "상품명",
    "rcvmnNm": "홍길동",
    "zipNo": "55221",
    "zipAddr": "서울특별시 송파구 법원로10길 H비지니스파크",
    "dtlAddr": "6층",
    "cellSctNo": "010",
    "cellTxnoNo": "1111",
    "cellEndNo": "2222",
    "deliMsg": "10",
    "comnFrdrEtcMethod": "기타 방법입니다.",
    "comnFrdrPwd": "1234",
    "sysRegId": "admin",
    "winRnk": 1,
    "comnFrdrCogoMethodCd": "10"
  }
]
[
  {
    "etcGftDlvpNo": "1",
    "etcGftIssuSubNo": "1",
    "etcGftIssuSubDtlNo": "1",
    "winRnk": 1
  }
]

Look Up Event Target Amount

post

Function Description

  • Looks up a list of order amounts meeting the requested criteria within the member's requested period.


Detailed Description

  • Order amounts that were cancelled or returned are deducted or excluded.

  • Field criteria within the request are queried with AND conditions, and information within a field criterion (values within a list) is queried with OR conditions.

Header parameters
AuthorizationanyOptional

Access Token

Body

Search Event Target Amount Request

mbrNostringRequired

Customer No.

Example: 100000001
buyStrDtmstring · date-timeRequired

Purchase Period Start Date/Time

buyEndDtmstring · date-timeRequired

Purchase Period End Date/Time

siteListstring[]Optional

Site List (Application Target)

Example: ["1"]
categoryListstring[]Optional

Category List (Application Target)

Example: ["10000002"]
exCategoryListstring[]Optional

Category List (Exclusion Target)

Example: ["10000003"]
mkDisplayListstring[]Optional

Special Promotion List (Application Target)

Example: ["19865"]
brandListstring[]Optional

Brand List (Application Target)

Example: ["100003"]
goodsListstring[]Optional

Product List (Application Target)

Example: ["10002632"]
exGoodsListstring[]Optional

Product List (Exclusion Target)

Example: ["10002634"]
channelListstring[]Optional

Channel List (Application Target)

Example: ["1"]
Responses
200

Success

*/*

Search Event Target Amount Response

totOrdAmtinteger · int64Optional

Total Order Amount in Order History

Example: 3110
post/v1/event/evtOrdList
POST /api/order/v1/event/evtOrdList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "mbrNo": "100000001",
  "buyStrDtm": "2026-01-01T00:00:00.000Z",
  "buyEndDtm": "2026-01-01T00:00:00.000Z",
  "siteList": [
    "1"
  ],
  "categoryList": [
    "10000002"
  ],
  "exCategoryList": [
    "10000003"
  ],
  "mkDisplayList": [
    "19865"
  ],
  "brandList": [
    "100003"
  ],
  "goodsList": [
    "10002632"
  ],
  "exGoodsList": [
    "10002634"
  ],
  "channelList": [
    "1"
  ]
}
{
  "orderList": [
    {
      "ordNo": "20230809O007055",
      "ordDtm": "2026-01-01T00:00:00.000Z",
      "ordAmt": 3110
    }
  ],
  "totOrdAmt": 3110
}

Last updated