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

Event Gift Delivery Management

Save Event Gift Delivery Management

post

Function Description

  • Processes event gift delivery.


Detailed Content

  • Processes event gift delivery on the Event Gift Delivery Management screen.

  • Processes shipment completion and delivery completion for event gifts.

  • The event gift delivery management edit target list is required.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Event Gift Delivery Management Modification Request DTO

Responses
200

Event Gift Delivery Management Save Successful

No content

post/v1/delivery/eventEtcGiftDeliveryMgmt/saveEventEtcGiftDeliveryProcess
POST /api/bo/v1/delivery/eventEtcGiftDeliveryMgmt/saveEventEtcGiftDeliveryProcess HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "eventEtcGiftDeliverySaveInfoList": [
    {
      "etcGftDlvpNo": 11,
      "etcGftStatCd": 10,
      "invNo": 123456789,
      "hdcCd": 10
    }
  ]
}

No content

Retrieve Event Gift Delivery Management

get

Function Description

  • Retrieves the event gift delivery management list.


Detailed Description

  • Retrieves the list of event gifts on the Event Gift Delivery Management screen.

  • Only retrieves records whose Other Gift Status Code (LO013) is Shipment Instructed (20), Shipment Completed (30), or Delivery Completed (40).

  • Inquiry Period Type, Inquiry Start Date, Inquiry End Date, and Order History Status (Other Gift Status) are required.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchPeriodTypeStringRequired

Search Period Type

startDateLocalDateRequired

Search Start Date

endDateLocalDateRequired

Search End Date

eventInfoTypeStringOptional

Event Information Type

eventInfoStringOptional

Event Information

etcGftStatCdStringRequired

Order History Status

goodsNoStringOptional

Product No.

qryGbCdStringOptional

Search Type (UR014)

indInfoQryCausStringOptional

Personal Information Access Reason

Responses
200

Event Gift Delivery Management Inquiry Successful

*/*
totalCountinteger · int32Optional
get/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryInfoList
GET /api/bo/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryInfoList?eventEtcGiftDeliveryRequest=[object+Object]&searchPeriodType=null&startDate=null&endDate=null&etcGftStatCd=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "etcGftDlvpNo": 11,
      "etcGftIssuSubCd": 10,
      "etcGftIssuSubNo": 1,
      "etcGftIssuSubDtlNo": 1,
      "etcGftStatCd": 10,
      "etcGftStatNm": "출고지시",
      "mbrNo": 100001311,
      "goodsNo": 10002042,
      "rcvmnNm": "홍길동",
      "zipNo": 5836,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "101동",
      "cellSctNo": "010",
      "cellTxnoNo": 1234,
      "cellEndNo": 5678,
      "deliMsg": "부재시 문앞에 두고 가주세요",
      "comnFrdrEtcMethod": "자유 출입 가능",
      "comnFrdrPwd": 123456,
      "hdcCd": 10,
      "invNo": 123456789,
      "evtNo": 15132,
      "evtNm": "출석체크 이벤트",
      "goodsNm": "상품명",
      "loginId": "login",
      "mbrNm": "홍길동",
      "shipFnshDtm": "yyyy-MM-dd HH:mm:ss",
      "deliFnshDtm": "yyyy-MM-dd HH:mm:ss",
      "fullAddr": "서울 송파구 동남로 99 1층",
      "shipIndiDtm": "yyyy-MM-dd HH:mm:ss"
    }
  ]
}

Retrieve Event Gift Delivery Management Bulk Excel Download

get

Function Description

  • Retrieves the bulk data Excel download list.


Detailed Content

  • Downloads bulk data as Excel from the Event Gift Delivery Management screen.

  • Inquiry Period Type, Inquiry Start Date, Inquiry End Date, and Order History Status (Other Gift Status) are required.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchPeriodTypeStringRequired

Search Period Type

startDateLocalDateRequired

Search Start Date

endDateLocalDateRequired

Search End Date

eventInfoTypeStringOptional

Event Information Type

eventInfoStringOptional

Event Information

etcGftStatCdStringRequired

Order History Status

goodsNoStringOptional

Product No.

qryGbCdStringOptional

Search Type (UR014)

indInfoQryCausStringOptional

Personal Information Access Reason

Responses
200

Event Gift Delivery Management Bulk Data Excel Download Inquiry Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

get/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryExcelData
GET /api/bo/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryExcelData?eventEtcGiftDeliveryRequest=[object+Object]&searchPeriodType=null&startDate=null&endDate=null&etcGftStatCd=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Target Data for Gift Shipment Completion Bulk Registration Validation

get

Function Description

  • Retrieves the target data for validating gift shipment completion bulk registration.


Detailed Content

  • Retrieves the detailed list for validation during bulk Excel upload on the Event Gift Delivery Management >> Bulk Registration popup screen.

  • The gift delivery number list is required.


Revision History

  • Release v2.00_240829 : Added default address masking

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
etcGftDlvpNoListListRequired

Gift Delivery No. List

Responses
200

Gift Shipment Completion Bulk Registration Validation Target Data Inquiry Successful

*/*

Event Gift Delivery Inquiry Response DTO

etcGftDlvpNostringOptional

Gift Delivery No.

Example: 11
etcGftIssuSubCdstringOptional

Gift Issuing Entity Code (MK022)

Example: 10
etcGftIssuSubNostringOptional

Gift Issuing Entity No.

Example: 1
etcGftIssuSubDtlNostringOptional

Gift Issuing Entity Detail No.

Example: 1
etcGftStatCdstringOptional

Order History Status Code (LO013)

Example: 10
etcGftStatNmstringOptional

Order Detail Status Name

Example: 출고지시
mbrNostringOptional

Member No.

Example: 100001311
goodsNostringOptional

Product No.

Example: 10002042
rcvmnNmstringOptional

Recipient Name

Example: 홍길동
zipNostringOptional

Postal Code

Example: 5836
zipAddrstringOptional

Postal Address

Example: 서울 송파구 법원로9길 26
dtlAddrstringOptional

Detailed Address

Example: 101동
cellSctNostringOptional

Mobile Phone Prefix Code

Example: 010
cellTxnoNostringOptional

Mobile Phone Exchange Code

Example: 1234
cellEndNostringOptional

Mobile Phone Last Digits

Example: 5678
deliMsgstringOptional

Delivery Message

Example: 부재시 문앞에 두고 가주세요
comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 자유 출입 가능
comnFrdrPwdstringOptional

Common Entrance Password

Example: 123456
hdcCdstringOptional

Courier Company Code

Example: 10
invNostringOptional

Invoice No.

Example: 123456789
evtNostringOptional

Event No.

Example: 15132
evtNmstringOptional

Event Name

Example: 출석체크 이벤트
goodsNmstringOptional

Product Name

Example: 상품명
loginIdstringOptional

Login ID

Example: login
mbrNmstringOptional

Member Name

Example: 홍길동
shipFnshDtmstring · date-timeOptional

Shipment Completion Date/Time

Example: yyyy-MM-dd HH:mm:ss
deliFnshDtmstring · date-timeOptional

Delivery Completion Date/Time

Example: yyyy-MM-dd HH:mm:ss
fullAddrstringOptional

Address

Example: 서울 송파구 동남로 99 1층
shipIndiDtmstring · date-timeOptional

Shipment Instruction Date/Time

Example: yyyy-MM-dd HH:mm:ss
get/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftBatchRegisterValidList
GET /api/bo/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftBatchRegisterValidList?eventEtcGiftBatchRegisterValidRequest=[object+Object]&etcGftDlvpNoList=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "etcGftDlvpNo": 11,
    "etcGftIssuSubCd": 10,
    "etcGftIssuSubNo": 1,
    "etcGftIssuSubDtlNo": 1,
    "etcGftStatCd": 10,
    "etcGftStatNm": "출고지시",
    "mbrNo": 100001311,
    "goodsNo": 10002042,
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "101동",
    "cellSctNo": "010",
    "cellTxnoNo": 1234,
    "cellEndNo": 5678,
    "deliMsg": "부재시 문앞에 두고 가주세요",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": 123456,
    "hdcCd": 10,
    "invNo": 123456789,
    "evtNo": 15132,
    "evtNm": "출석체크 이벤트",
    "goodsNm": "상품명",
    "loginId": "login",
    "mbrNm": "홍길동",
    "shipFnshDtm": "yyyy-MM-dd HH:mm:ss",
    "deliFnshDtm": "yyyy-MM-dd HH:mm:ss",
    "fullAddr": "서울 송파구 동남로 99 1층",
    "shipIndiDtm": "yyyy-MM-dd HH:mm:ss"
  }
]

Last updated