> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/delivery-bo-api/undefined-3.md).
# 이벤트 사은품 배송관리
## 이벤트 사은품 배송관리 저장
> \## 기능 설명\
> \* 이벤트 사은품 배송 처리를 진행합니다.\
> \---\
> \## 상세 내용\
> \* 이벤트 사은품 배송관리 화면에서 이벤트 사은품 배송 처리를 진행합니다.\
> \* 이벤트 사은품 출고완료, 배송완료 처리를 진행합니다.\
> \* 이벤트 사은품 배송관리 수정 대상 리스트는 필수값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EventEtcGiftDeliverySaveRequest":{"type":"object","description":"이벤트사은품배송관리 수정 요청 DTO","properties":{"eventEtcGiftDeliverySaveInfoList":{"type":"array","description":"이벤트 사은품 배송관리 수정 대상 리스트","items":{"$ref":"#/components/schemas/EventEtcGiftDeliverySaveInfo"},"minItems":1}},"required":["eventEtcGiftDeliverySaveInfoList"]},"EventEtcGiftDeliverySaveInfo":{"type":"object","description":"이벤트사은품정보 DTO","properties":{"etcGftDlvpNo":{"type":"string","description":"사은품배송번호","minLength":1},"etcGftStatCd":{"type":"string","description":"주문내역상태(LO013)","minLength":1},"invNo":{"type":"string","description":"송장번호"},"hdcCd":{"type":"string","description":"택배사코드(LO005)"}},"required":["etcGftDlvpNo","etcGftStatCd"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/eventEtcGiftDeliveryMgmt/saveEventEtcGiftDeliveryProcess":{"post":{"tags":["이벤트 사은품 배송관리"],"summary":"이벤트 사은품 배송관리 저장","description":"## 기능 설명\n* 이벤트 사은품 배송 처리를 진행합니다.\n---\n## 상세 내용\n* 이벤트 사은품 배송관리 화면에서 이벤트 사은품 배송 처리를 진행합니다.\n* 이벤트 사은품 출고완료, 배송완료 처리를 진행합니다.\n* 이벤트 사은품 배송관리 수정 대상 리스트는 필수값입니다.\n","operationId":"saveEventEtcGiftDeliveryProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventEtcGiftDeliverySaveRequest"}}},"required":true},"responses":{"200":{"description":"이벤트 사은품 배송관리 저장 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 이벤트 사은품 배송관리 조회
> \## 기능 설명\
> \* 이벤트 사은품 배송관리 목록을 조회 합니다.\
> \---\
> \## 상세 설명\
> \* 이벤트 사은품 배송 관리 화면의 이벤트 사은품 목록을 조회합니다.\
> \* 기타사은품상태코드(LO013)가 출고지시(20), 출고완료(30), 배송완료(40)인 건만 조회합니다.\
> \* 조회기간구분, 조회시작일, 조회종료일, 주문내역상태(기타사은품상태)는 필수값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EventEtcGiftDeliveryRequest":{"type":"object","description":"이벤트사은품배송관리 요청 DTO","properties":{"qryGbCd":{"type":"string","description":"조회구분(UR014)"},"indInfoQryCaus":{"type":"string","description":"개인정보조회사유"},"searchPeriodType":{"type":"string","description":"조회기간 구분","minLength":1},"startDate":{"type":"string","format":"date","description":"조회 시작일"},"endDate":{"type":"string","format":"date","description":"조회 종료일"},"eventInfoType":{"type":"string","description":"이벤트 정보 구분"},"eventInfo":{"type":"string","description":"이벤트 정보"},"etcGftStatCd":{"type":"string","description":"주문내역상태(LO013)"},"goodsNo":{"type":"string","description":"상품번호"}},"required":["endDate","etcGftStatCd","searchPeriodType","startDate"]},"RealGridListResponseEventEtcGiftDeliveryResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/EventEtcGiftDeliveryResponse"}}}},"EventEtcGiftDeliveryResponse":{"type":"object","description":"이벤트사은품배송조회 응답 DTO","properties":{"etcGftDlvpNo":{"type":"string","description":"사은품배송번호"},"etcGftIssuSubCd":{"type":"string","description":"사은품발급주체코드(MK022)"},"etcGftIssuSubNo":{"type":"string","description":"사은품발급주체번호"},"etcGftIssuSubDtlNo":{"type":"string","description":"사은품발급주체상세번호"},"etcGftStatCd":{"type":"string","description":"주문내역상태코드(LO013)"},"etcGftStatNm":{"type":"string","description":"주문내역상태명"},"mbrNo":{"type":"string","description":"회원번호"},"goodsNo":{"type":"string","description":"상품번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"cellSctNo":{"type":"string","description":"휴대폰구분번호"},"cellTxnoNo":{"type":"string","description":"휴대폰국번번호"},"cellEndNo":{"type":"string","description":"휴대폰끝번호"},"deliMsg":{"type":"string","description":"배송메시지"},"comnFrdrEtcMethod":{"type":"string","description":"공동현관기타방법"},"comnFrdrPwd":{"type":"string","description":"공동현관비밀번호"},"hdcCd":{"type":"string","description":"택배사코드"},"invNo":{"type":"string","description":"송장번호"},"evtNo":{"type":"string","description":"이벤트번호"},"evtNm":{"type":"string","description":"이벤트명"},"goodsNm":{"type":"string","description":"상품명"},"loginId":{"type":"string","description":"로그인ID"},"mbrNm":{"type":"string","description":"회원명"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"deliFnshDtm":{"type":"string","format":"date-time","description":"배송완료일시"},"fullAddr":{"type":"string","description":"주소"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryInfoList":{"get":{"tags":["이벤트 사은품 배송관리"],"summary":"이벤트 사은품 배송관리 조회","description":"## 기능 설명\n* 이벤트 사은품 배송관리 목록을 조회 합니다.\n---\n## 상세 설명\n* 이벤트 사은품 배송 관리 화면의 이벤트 사은품 목록을 조회합니다.\n* 기타사은품상태코드(LO013)가 출고지시(20), 출고완료(30), 배송완료(40)인 건만 조회합니다.\n* 조회기간구분, 조회시작일, 조회종료일, 주문내역상태(기타사은품상태)는 필수값입니다.\n","operationId":"getEventEtcGiftDeliveryInfoList","parameters":[{"name":"eventEtcGiftDeliveryRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EventEtcGiftDeliveryRequest"}},{"name":"searchPeriodType","in":"query","description":"조회기간 구분","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"조회 시작일","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"조회 종료일","required":true,"schema":{"type":"LocalDate"}},{"name":"eventInfoType","in":"query","description":"이벤트 정보 구분","schema":{"type":"String"}},{"name":"eventInfo","in":"query","description":"이벤트 정보","schema":{"type":"String"}},{"name":"etcGftStatCd","in":"query","description":"주문내역상태","required":true,"schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"상품번호","schema":{"type":"String"}},{"name":"qryGbCd","in":"query","description":"조회구분(UR014)","schema":{"type":"String"}},{"name":"indInfoQryCaus","in":"query","description":"개인정보조회사유","schema":{"type":"String"}}],"responses":{"200":{"description":"이벤트 사은품 배송관리 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseEventEtcGiftDeliveryResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 이벤트 사은품 배송관리 대량 데이터 엑셀 다운로드 조회
> \## 기능 설명\
> \* 대량 데이터 엑셀 다운로드 목록을 조회 합니다.\
> \---\
> \## 상세 내용\
> \* 이벤트 사은품 배송관리 화면에서 대량 데이터 엑셀로 다운로드합니다.\
> \* 조회기간구분, 조회시작일, 조회종료일, 주문내역상태(기타사은품상태)는 필수값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EventEtcGiftDeliveryRequest":{"type":"object","description":"이벤트사은품배송관리 요청 DTO","properties":{"qryGbCd":{"type":"string","description":"조회구분(UR014)"},"indInfoQryCaus":{"type":"string","description":"개인정보조회사유"},"searchPeriodType":{"type":"string","description":"조회기간 구분","minLength":1},"startDate":{"type":"string","format":"date","description":"조회 시작일"},"endDate":{"type":"string","format":"date","description":"조회 종료일"},"eventInfoType":{"type":"string","description":"이벤트 정보 구분"},"eventInfo":{"type":"string","description":"이벤트 정보"},"etcGftStatCd":{"type":"string","description":"주문내역상태(LO013)"},"goodsNo":{"type":"string","description":"상품번호"}},"required":["endDate","etcGftStatCd","searchPeriodType","startDate"]},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftDeliveryExcelData":{"get":{"tags":["이벤트 사은품 배송관리"],"summary":"이벤트 사은품 배송관리 대량 데이터 엑셀 다운로드 조회","description":"## 기능 설명\n* 대량 데이터 엑셀 다운로드 목록을 조회 합니다.\n---\n## 상세 내용\n* 이벤트 사은품 배송관리 화면에서 대량 데이터 엑셀로 다운로드합니다.\n* 조회기간구분, 조회시작일, 조회종료일, 주문내역상태(기타사은품상태)는 필수값입니다.\n","operationId":"getEventEtcGiftDeliveryExcelData","parameters":[{"name":"eventEtcGiftDeliveryRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EventEtcGiftDeliveryRequest"}},{"name":"searchPeriodType","in":"query","description":"조회기간 구분","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"조회 시작일","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"조회 종료일","required":true,"schema":{"type":"LocalDate"}},{"name":"eventInfoType","in":"query","description":"이벤트 정보 구분","schema":{"type":"String"}},{"name":"eventInfo","in":"query","description":"이벤트 정보","schema":{"type":"String"}},{"name":"etcGftStatCd","in":"query","description":"주문내역상태","required":true,"schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"상품번호","schema":{"type":"String"}},{"name":"qryGbCd","in":"query","description":"조회구분(UR014)","schema":{"type":"String"}},{"name":"indInfoQryCaus","in":"query","description":"개인정보조회사유","schema":{"type":"String"}}],"responses":{"200":{"description":"이벤트 사은품 배송관리 대량 데이터 엑셀 다운로드 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 사은품 출고완료 일괄등록 유효성 검사 대상 데이터 조회
> \## 기능 설명\
> \* 사은품 출고완료 일괄등록 유효성 검사 시 대상 데이터를 조회합니다.\
> \---\
> \## 상세 내용\
> \* 이벤트 사은품 배송 관리 >> 일괄등록 팝업 화면에서 엑셀 일괄 업로드시 유효성 검사를 위한 상세 목록을 조회합니다.\
> \* 사은품 배송번호 목록은 필수값입니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240829 : 기본주소 마스킹 추가
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EventEtcGiftBatchRegisterValidRequest":{"type":"object","description":"사은품출고완료일괄등록유효성검사 요청 DTO","properties":{"etcGftDlvpNoList":{"type":"array","description":"사은품 배송번호 리스트","items":{"type":"string"},"minItems":1}},"required":["etcGftDlvpNoList"]},"EventEtcGiftDeliveryResponse":{"type":"object","description":"이벤트사은품배송조회 응답 DTO","properties":{"etcGftDlvpNo":{"type":"string","description":"사은품배송번호"},"etcGftIssuSubCd":{"type":"string","description":"사은품발급주체코드(MK022)"},"etcGftIssuSubNo":{"type":"string","description":"사은품발급주체번호"},"etcGftIssuSubDtlNo":{"type":"string","description":"사은품발급주체상세번호"},"etcGftStatCd":{"type":"string","description":"주문내역상태코드(LO013)"},"etcGftStatNm":{"type":"string","description":"주문내역상태명"},"mbrNo":{"type":"string","description":"회원번호"},"goodsNo":{"type":"string","description":"상품번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"cellSctNo":{"type":"string","description":"휴대폰구분번호"},"cellTxnoNo":{"type":"string","description":"휴대폰국번번호"},"cellEndNo":{"type":"string","description":"휴대폰끝번호"},"deliMsg":{"type":"string","description":"배송메시지"},"comnFrdrEtcMethod":{"type":"string","description":"공동현관기타방법"},"comnFrdrPwd":{"type":"string","description":"공동현관비밀번호"},"hdcCd":{"type":"string","description":"택배사코드"},"invNo":{"type":"string","description":"송장번호"},"evtNo":{"type":"string","description":"이벤트번호"},"evtNm":{"type":"string","description":"이벤트명"},"goodsNm":{"type":"string","description":"상품명"},"loginId":{"type":"string","description":"로그인ID"},"mbrNm":{"type":"string","description":"회원명"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"deliFnshDtm":{"type":"string","format":"date-time","description":"배송완료일시"},"fullAddr":{"type":"string","description":"주소"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/eventEtcGiftDeliveryMgmt/getEventEtcGiftBatchRegisterValidList":{"get":{"tags":["이벤트 사은품 배송관리"],"summary":"사은품 출고완료 일괄등록 유효성 검사 대상 데이터 조회","description":"## 기능 설명\n* 사은품 출고완료 일괄등록 유효성 검사 시 대상 데이터를 조회합니다.\n---\n## 상세 내용\n* 이벤트 사은품 배송 관리 >> 일괄등록 팝업 화면에서 엑셀 일괄 업로드시 유효성 검사를 위한 상세 목록을 조회합니다.\n* 사은품 배송번호 목록은 필수값입니다.\n---\n## 수정번호\n* Release v2.00_240829 : 기본주소 마스킹 추가\n","operationId":"getEventEtcGiftBatchRegisterValidList","parameters":[{"name":"eventEtcGiftBatchRegisterValidRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EventEtcGiftBatchRegisterValidRequest"}},{"name":"etcGftDlvpNoList","in":"query","description":"사은품 배송번호 리스트","required":true,"schema":{"type":"List"}}],"responses":{"200":{"description":"사은품 출고완료 일괄등록 유효성 검사 대상 데이터 조회 성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventEtcGiftDeliveryResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```