> 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/models.md). # Models ## The PendingShipmentMgmtRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"PendingShipmentMgmtRequest":{"type":"object","description":"미발송현황 요청 DTO","properties":{"searchType":{"type":"string","description":"조회기준","enum":["E","G","O"]},"entrNo":{"type":"string","description":"협력사번호"},"deliIndiStrDt":{"type":"string","format":"date","description":"배송지시시작일"},"deliIndiEndDt":{"type":"string","format":"date","description":"배송지시종료일"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"deliMethodCd":{"type":"string","description":"배송방법코드(LO010)"}}}}}} ``` ## The PendingShipmentMgmtResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"PendingShipmentMgmtResponse":{"type":"object","description":"미발송 현황 응답 DTO","properties":{"entrNo":{"type":"string","description":"협력사번호"},"entrNm":{"type":"string","description":"협력사명"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"stkQty":{"type":"integer","format":"int32","description":"재고수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"ordNo":{"type":"string","description":"주문번호"},"deliNo":{"type":"string","description":"배송번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"deliKindCdNm":{"type":"string","description":"배송종류코드명"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"ordSaleTypCdNm":{"type":"string","description":"주문판매유형코드명"},"ordQty":{"type":"integer","format":"int32","description":"주문수량"},"loginId":{"type":"string","description":"로그인ID"},"ordManNm":{"type":"string","description":"주문자"},"ordManCellNo":{"type":"string","description":"주문자 휴대폰 번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인 휴대폰 번호"},"deliAddr":{"type":"string","description":"배송지"},"deliMsg":{"type":"string","description":"배송 요청사항"},"totalCount":{"type":"integer","format":"int32","description":"건수"},"d0Count":{"type":"integer","format":"int32","description":"D"},"d1Count":{"type":"integer","format":"int32","description":"D + 1"},"d2Count":{"type":"integer","format":"int32","description":"D + 2"},"d3Count":{"type":"integer","format":"int32","description":"D + 3"},"d4Count":{"type":"integer","format":"int32","description":"D + 4"},"d5Count":{"type":"integer","format":"int32","description":"D + 5"},"d6Count":{"type":"integer","format":"int32","description":"D + 6"},"overCount":{"type":"integer","format":"int32","description":"D + 7 이상"}}}}}} ``` ## The RealGridListResponsePendingShipmentMgmtResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponsePendingShipmentMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PendingShipmentMgmtResponse"}}}},"PendingShipmentMgmtResponse":{"type":"object","description":"미발송 현황 응답 DTO","properties":{"entrNo":{"type":"string","description":"협력사번호"},"entrNm":{"type":"string","description":"협력사명"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"stkQty":{"type":"integer","format":"int32","description":"재고수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"ordNo":{"type":"string","description":"주문번호"},"deliNo":{"type":"string","description":"배송번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"deliKindCdNm":{"type":"string","description":"배송종류코드명"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"ordSaleTypCdNm":{"type":"string","description":"주문판매유형코드명"},"ordQty":{"type":"integer","format":"int32","description":"주문수량"},"loginId":{"type":"string","description":"로그인ID"},"ordManNm":{"type":"string","description":"주문자"},"ordManCellNo":{"type":"string","description":"주문자 휴대폰 번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인 휴대폰 번호"},"deliAddr":{"type":"string","description":"배송지"},"deliMsg":{"type":"string","description":"배송 요청사항"},"totalCount":{"type":"integer","format":"int32","description":"건수"},"d0Count":{"type":"integer","format":"int32","description":"D"},"d1Count":{"type":"integer","format":"int32","description":"D + 1"},"d2Count":{"type":"integer","format":"int32","description":"D + 2"},"d3Count":{"type":"integer","format":"int32","description":"D + 3"},"d4Count":{"type":"integer","format":"int32","description":"D + 4"},"d5Count":{"type":"integer","format":"int32","description":"D + 5"},"d6Count":{"type":"integer","format":"int32","description":"D + 6"},"overCount":{"type":"integer","format":"int32","description":"D + 7 이상"}}}}}} ``` ## The Response object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The ValidationError object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}}} ``` ## The WithdrawStatUpdateSaveInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawStatUpdateSaveInfo":{"type":"object","description":"회수상태업데이트 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드"},"invNo":{"type":"string","description":"송장번호"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"wthdYn":{"type":"string","description":"회수여부"}},"required":["deliNo","hdcCd","invNo","ordNo"]}}}} ``` ## The WithdrawStatUpdateSaveRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawStatUpdateSaveRequest":{"type":"object","description":"회수상태업데이트 요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"현재 주문진행상태(OM005)","minLength":1},"updateTargetOrdDtlStatCd":{"type":"string","description":"업데이트할 주문진행상태(OM005)","minLength":1},"withdrawStatUpdateSaveInfoList":{"type":"array","description":"회수 진행상태 업데이트 대상 리스트","items":{"$ref":"#/components/schemas/WithdrawStatUpdateSaveInfo"},"minItems":1}},"required":["ordDtlStatCd","updateTargetOrdDtlStatCd","withdrawStatUpdateSaveInfoList"]},"WithdrawStatUpdateSaveInfo":{"type":"object","description":"회수상태업데이트 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드"},"invNo":{"type":"string","description":"송장번호"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"wthdYn":{"type":"string","description":"회수여부"}},"required":["deliNo","hdcCd","invNo","ordNo"]}}}} ``` ## The WithdrawInstructHandlingSaveInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawInstructHandlingSaveInfo":{"type":"object","description":"회수지시대상정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"}},"required":["deliNo","ordNo","rtnQty"]}}}} ``` ## The WithdrawInstructHandlingSaveRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawInstructHandlingSaveRequest":{"type":"object","description":"회수지시대상처리 요청 DTO","properties":{"withdrawInstructHandlingSaveInfoList":{"type":"array","description":"회수 지시 대상 리스트","items":{"$ref":"#/components/schemas/WithdrawInstructHandlingSaveInfo"}}}},"WithdrawInstructHandlingSaveInfo":{"type":"object","description":"회수지시대상정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"}},"required":["deliNo","ordNo","rtnQty"]}}}} ``` ## The ReturnTrnsformRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"ReturnTrnsformRequest":{"type":"object","description":"반품전환요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"claimNo":{"type":"string","description":"클레임번호","minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1}},"required":["claimNo","ordMediaCd","ordNo"]}}}} ``` ## The NoAllowedReturnRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"NoAllowedReturnRequest":{"type":"object","description":"반품불가요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"claimNo":{"type":"string","description":"클레임번호","minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1},"wthdFnshWaitProcCaus":{"type":"string","description":"반품불가사유"}},"required":["claimNo","ordMediaCd","ordNo"]}}}} ``` ## The DeliveryProcessInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryProcessInfo":{"type":"object","description":"배송처리 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"shipQty":{"type":"integer","format":"int32","description":"출고수량"},"deliSeq":{"type":"integer","format":"int32","description":"배송순번"},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드(LO005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지전송여부"}},"required":["deliNo"]}}}} ``` ## The SendFinishPopupRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"SendFinishPopupRequest":{"type":"object","description":"출고완료일괄등록팝업정보요청 DTO","properties":{"ordDeliInfoList":{"type":"array","description":"배송번호목록","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}}},"DeliveryProcessInfo":{"type":"object","description":"배송처리 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"shipQty":{"type":"integer","format":"int32","description":"출고수량"},"deliSeq":{"type":"integer","format":"int32","description":"배송순번"},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드(LO005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지전송여부"}},"required":["deliNo"]}}}} ``` ## The SendFinishPopupInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"SendFinishPopupInfo":{"type":"object","description":"배송상세정보 DTO","properties":{"deliNo":{"type":"string","description":"배송번호"},"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"entrNo":{"type":"string","description":"협력사번호"},"hdcCd":{"type":"string","description":"택배사코드(LO005)"},"invNo":{"type":"string","description":"송장번호"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"}}}}}} ``` ## The EventEtcGiftDeliverySaveInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The EventEtcGiftDeliverySaveRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"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"]}}}} ``` ## The EtDeliRegnGrpInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"EtDeliRegnGrpInfo":{"type":"object","description":"배송지역그룹정보","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015) 10:추가배송비"},"deliRegnGrpNm":{"type":"string","description":"배송지역그룹명"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"useYn":{"type":"string","description":"사용여부"},"deliRegnDesc":{"type":"string","description":"배송지역그룹설명"}}}}}} ``` ## The RealGridCUDRequestEtDeliRegnGrpInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridCUDRequestEtDeliRegnGrpInfo":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/EtDeliRegnGrpInfo"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/EtDeliRegnGrpInfo"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/EtDeliRegnGrpInfo"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/EtDeliRegnGrpInfo"}}}},"EtDeliRegnGrpInfo":{"type":"object","description":"배송지역그룹정보","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015) 10:추가배송비"},"deliRegnGrpNm":{"type":"string","description":"배송지역그룹명"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"useYn":{"type":"string","description":"사용여부"},"deliRegnDesc":{"type":"string","description":"배송지역그룹설명"}}}}}} ``` ## The DeliveryRegionByZipCdRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryRegionByZipCdRequest":{"type":"object","description":"배송지역관리 요청 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015) 10:추가배송비"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"},"regnGbCd":{"type":"string","description":"지역구분코드"},"regnGbNm":{"type":"string","description":"지역구분명"},"searchWord":{"type":"string","description":"검색어"}}}}}} ``` ## The RealGridCUDRequestDeliveryRegionByZipCdRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridCUDRequestDeliveryRegionByZipCdRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionByZipCdRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionByZipCdRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionByZipCdRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionByZipCdRequest"}}}},"DeliveryRegionByZipCdRequest":{"type":"object","description":"배송지역관리 요청 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015) 10:추가배송비"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"},"regnGbCd":{"type":"string","description":"지역구분코드"},"regnGbNm":{"type":"string","description":"지역구분명"},"searchWord":{"type":"string","description":"검색어"}}}}}} ``` ## The ResponseString object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The InsuffDeliveryProcessInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"InsuffDeliveryProcessInfo":{"type":"object","description":"결품처리정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"shipWaitCaus":{"type":"string","description":"결품사유(LO007) 10:재고부족, 20:재고있지만출고불가능, 30:고객변심","minLength":1},"shipWaitCausCont":{"type":"string","description":"결품상세사유"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"}},"required":["deliNo","ordNo","ordProcSeq","ordSeq","shipWaitCaus"]}}}} ``` ## The InsuffDeliveryProcessRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"InsuffDeliveryProcessRequest":{"type":"object","description":"결품처리요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005) 22:출고지시, 23:출고대기","minLength":1},"targetOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005) 22:출고지시, 23:출고대기","minLength":1},"insuffDeliveryProcessInfoList":{"type":"array","description":"배송처리 목록","items":{"$ref":"#/components/schemas/InsuffDeliveryProcessInfo"}}},"required":["insuffDeliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"InsuffDeliveryProcessInfo":{"type":"object","description":"결품처리정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"shipWaitCaus":{"type":"string","description":"결품사유(LO007) 10:재고부족, 20:재고있지만출고불가능, 30:고객변심","minLength":1},"shipWaitCausCont":{"type":"string","description":"결품상세사유"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"}},"required":["deliNo","ordNo","ordProcSeq","ordSeq","shipWaitCaus"]}}}} ``` ## The DeliveryProcessRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryProcessRequest":{"type":"object","description":"배송처리 요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"],"minLength":1},"targetOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"],"minLength":1},"deliDtlStatCd":{"type":"string","description":"원배송내역상태코드(LO016)"},"targetDeliDtlStatCd":{"type":"string","description":"처리배송내역상태코드(LO016)"},"deliveryProcessInfoList":{"type":"array","description":"배송처리 목록","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"required":["deliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"DeliveryProcessInfo":{"type":"object","description":"배송처리 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"shipQty":{"type":"integer","format":"int32","description":"출고수량"},"deliSeq":{"type":"integer","format":"int32","description":"배송순번"},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드(LO005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지전송여부"}},"required":["deliNo"]}}}} ``` ## The WithdrawSearchRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawSearchRequest":{"type":"object","description":"회수정보조회 요청 DTO","properties":{"searchDateType":{"type":"string","description":"조회기간 구분","minLength":1},"startDate":{"type":"string","format":"date","description":"조회 시작일"},"endDate":{"type":"string","format":"date","description":"조회 종료일"},"searchOrdDeliType":{"type":"string","description":"배송정보"},"deliveryType":{"type":"string","description":"배송정보 구분"},"deliTypCd":{"type":"string","description":"배송유형(LO002)"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"searchOrdManType":{"type":"string","description":"주문자정보 구분"},"ordManVal":{"type":"string","description":"주문자정보"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"entrNo":{"type":"string","description":"협력사번호"},"hdcCd":{"type":"string","description":"택배사 코드"},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005)"},"ordDtlStatCdInput":{"type":"string","description":"회수확인 화면 주문내역상태(OM005)"},"targetOrdDtlStatCd":{"type":"string","description":"회수확인 화면 주문내역상태(OM005)"},"wthdYn":{"type":"string","description":"회수필요여부"}},"required":["deliKindCd","deliProcTypCd","entrNo","hdcCd","ordDtlStatCd","ordManVal","searchDateType","searchOrdManType"]}}}} ``` ## The RealGridListResponseWithdrawSearchResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponseWithdrawSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawSearchResponse"}}}},"WithdrawSearchResponse":{"type":"object","description":"회수정보조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)"},"deliNo":{"type":"string","description":"배송번호"},"rtnAccpDtm":{"type":"string","format":"date-time","description":"반품접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliTypCd":{"type":"string","description":"배송유형코드(LO002)"},"deliTypCdNm":{"type":"string","description":"배송유형코드명"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드(OM003)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"},"mbrNo":{"type":"string","description":"회원번호"},"invNo":{"type":"string","description":"송장번호"},"hdcCd":{"type":"string","description":"택배사코드"},"hdcCdNm":{"type":"string","description":"택배사코드명"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"claimNo":{"type":"string","description":"클레임번호"},"wthdYn":{"type":"string","description":"회수필요여부"},"isAllNonReturnable":{"type":"string","description":"회수불필요주문여부"},"shipIndiDtm":{"type":"string","description":"회수지시일시"},"deliIndiDtm":{"type":"string","description":"배송/회수지시일시"},"shipCfmDtm":{"type":"string","format":"date-time","description":"회수확인일시"}}}}}} ``` ## The WithdrawSearchResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawSearchResponse":{"type":"object","description":"회수정보조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)"},"deliNo":{"type":"string","description":"배송번호"},"rtnAccpDtm":{"type":"string","format":"date-time","description":"반품접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliTypCd":{"type":"string","description":"배송유형코드(LO002)"},"deliTypCdNm":{"type":"string","description":"배송유형코드명"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드(OM003)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"},"mbrNo":{"type":"string","description":"회원번호"},"invNo":{"type":"string","description":"송장번호"},"hdcCd":{"type":"string","description":"택배사코드"},"hdcCdNm":{"type":"string","description":"택배사코드명"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"claimNo":{"type":"string","description":"클레임번호"},"wthdYn":{"type":"string","description":"회수필요여부"},"isAllNonReturnable":{"type":"string","description":"회수불필요주문여부"},"shipIndiDtm":{"type":"string","description":"회수지시일시"},"deliIndiDtm":{"type":"string","description":"배송/회수지시일시"},"shipCfmDtm":{"type":"string","format":"date-time","description":"회수확인일시"}}}}}} ``` ## The WithdrawDetailRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawDetailRequest":{"type":"object","description":"회수상세정보조회 요청 DTO","properties":{"deliNo":{"type":"string","description":"배송번호","minLength":1}},"required":["deliNo"]}}}} ``` ## The WithdrawDetailGoodsInfo object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawDetailGoodsInfo":{"type":"object","description":"회수상세상품목록 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"puTypCd":{"type":"string","description":"수거유형코드명(LO006)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명(OM005)"},"hdcCd":{"type":"string","description":"택배사코드명(LO005)"},"invNo":{"type":"string","description":"송장번호"},"claimCause":{"type":"string","description":"클레임중분류코드명(OM006)"},"claimDtlCause":{"type":"string","description":"클레임사유기타내용"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드명(LO011)"}}}}}} ``` ## The WithdrawDetailResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"WithdrawDetailResponse":{"type":"object","description":"회수상세 응답 DTO","properties":{"withdrawDeliNo":{"type":"string","description":"회수배송번호"},"rtnAccpDtm":{"type":"string","format":"date-time","description":"반품접수일시"},"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliTypCd":{"type":"string","description":"배송유형코드명(LO002)"},"deliTypCdNm":{"type":"string","description":"배송유형코드명(LO002)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"zipAddr":{"type":"string","description":"기본주소"},"dtlAddr":{"type":"string","description":"상세주소"},"wthdYn":{"type":"string","description":"회수필요여부"},"withdrawDetailGoodsInfoList":{"type":"array","description":"회수상품정보리스트","items":{"$ref":"#/components/schemas/WithdrawDetailGoodsInfo"}}}},"WithdrawDetailGoodsInfo":{"type":"object","description":"회수상세상품목록 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"puTypCd":{"type":"string","description":"수거유형코드명(LO006)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명(OM005)"},"hdcCd":{"type":"string","description":"택배사코드명(LO005)"},"invNo":{"type":"string","description":"송장번호"},"claimCause":{"type":"string","description":"클레임중분류코드명(OM006)"},"claimDtlCause":{"type":"string","description":"클레임사유기타내용"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드명(LO011)"}}}}}} ``` ## The EventEtcGiftDeliveryRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"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"]}}}} ``` ## The EventEtcGiftDeliveryResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"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":"출고지시일시"}}}}}} ``` ## The RealGridListResponseEventEtcGiftDeliveryResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"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":"출고지시일시"}}}}}} ``` ## The EventEtcGiftBatchRegisterValidRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"EventEtcGiftBatchRegisterValidRequest":{"type":"object","description":"사은품출고완료일괄등록유효성검사 요청 DTO","properties":{"etcGftDlvpNoList":{"type":"array","description":"사은품 배송번호 리스트","items":{"type":"string"},"minItems":1}},"required":["etcGftDlvpNoList"]}}}} ``` ## The DeliveryRegionByZipCdResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryRegionByZipCdResponse":{"type":"object","description":"배송지역관리 응답 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"}}}}}} ``` ## The RealGridListResponseDeliveryRegionByZipCdResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponseDeliveryRegionByZipCdResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionByZipCdResponse"}}}},"DeliveryRegionByZipCdResponse":{"type":"object","description":"배송지역관리 응답 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"zipNo":{"type":"string","description":"우편번호"},"zipAddr":{"type":"string","description":"우편주소"}}}}}} ``` ## The DeliveryRegionGroupRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryRegionGroupRequest":{"type":"object","description":"배송지역그룹관리 요청 DTO","properties":{"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015) 10:추가배송비"},"deliRegnGrpNm":{"type":"string","description":"배송지역그룹명"},"useYn":{"type":"string","description":"사용여부"}}}}}} ``` ## The DeliveryRegionGroupResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryRegionGroupResponse":{"type":"object","description":"배송지역그룹 응답 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015)"},"deliGrpGbCdNm":{"type":"string","description":"배송그룹구분코드명"},"deliRegnGrpNm":{"type":"string","description":"배송지역그룹명"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"useYn":{"type":"string","description":"사용여부"},"deliRegnDesc":{"type":"string","description":"배송지역그룹설명"}}}}}} ``` ## The RealGridListResponseDeliveryRegionGroupResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponseDeliveryRegionGroupResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRegionGroupResponse"}}}},"DeliveryRegionGroupResponse":{"type":"object","description":"배송지역그룹 응답 DTO","properties":{"deliRegnGrpNo":{"type":"string","description":"배송지역그룹번호"},"deliGrpGbCd":{"type":"string","description":"배송그룹구분코드(LO015)"},"deliGrpGbCdNm":{"type":"string","description":"배송그룹구분코드명"},"deliRegnGrpNm":{"type":"string","description":"배송지역그룹명"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"useYn":{"type":"string","description":"사용여부"},"deliRegnDesc":{"type":"string","description":"배송지역그룹설명"}}}}}} ``` ## The DeliveryInquiryRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryInquiryRequest":{"type":"object","description":"배송목록조회 요청 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호"},"entrNo":{"type":"string","description":"협력사번호"},"searchDateType":{"type":"string","description":"조회기간구분"},"startDate":{"type":"string","format":"date","description":"조회기간(시작일)"},"endDate":{"type":"string","format":"date","description":"조회기간(종료일)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005) 12:주문완료, 21:배송지시, 22:출고지시, 23:출고대기, 26:출고완료, 27:배송완료, 33:접수, 34:회수지시, 35:회수확인, 36, 회수완료"},"deliDtlStatCd":{"type":"string","description":"배송내역상태(LO016)"},"searchDeliveryType":{"type":"string","description":"배송정보 구분"},"deliveryVal":{"type":"string","description":"배송정보 입력값"},"deliTypCd":{"type":"string","description":"배송유형(LO002) 10:정상출하, 11:교환출하, 20:반품회수, 21:교환회수"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008) 10:센터배송, 20:업체배송, 30:e-쿠폰배송","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"searchOrdManType":{"type":"string","description":"주문자정보구분"},"ordManVal":{"type":"string","description":"주문자정보입력값"},"deliKindCd":{"type":"string","description":"배송종류(LO009) 10:일반배송, 20:예약배송"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004) 10:일반판매, 20:주문사은품, 30:상품사은품"},"hdcCd":{"type":"string","description":"택배사(LO005) 10:CJ대한통운, 11:우체국택배, 12:굿투럭, 13:DHL택배, 14:로젠택배, 30:부릉, 31:고고밴"},"ordMediaCd":{"type":"string","description":"주문매체(OM007) 10:전화상담(CC), 20:PC, 30:모바일웹, 40:안드로이드앱, 50:IOS앱"},"deliNo":{"type":"string","description":"배송번호"}}}}}} ``` ## The DeliveryInquiryResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryInquiryResponse":{"type":"object","description":"배송조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"deliNo":{"type":"string","description":"배송번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordGbCd":{"type":"string","description":"주문구분코드(OM002)","enum":["NORMAL","GIFT"]},"deliSeq":{"type":"string","description":"출고차수(배송순번)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005)"},"deliDtlStatCd":{"type":"string","description":"배송내역상태(LO016)"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"deliTypCd":{"type":"string","description":"배송유형(LO002)"},"deliKindCd":{"type":"string","description":"배송종류(LO009)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명(PR008)"},"hdcCd":{"type":"string","description":"택배사(LO005)"},"invNo":{"type":"string","description":"송장번호"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004)"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"ordQty":{"type":"string","description":"주문수량"},"shipQty":{"type":"string","description":"출고수량"},"shipNeedQty":{"type":"string","description":"출고필요수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"주문자 로그인ID"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인 휴대폰 번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인 휴대폰 구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인 휴대폰 국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"addr":{"type":"string","description":"주소"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgNm":{"type":"string","description":"배송메시지코드명(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"deliFnshDtm":{"type":"string","format":"date-time","description":"배송완료일시"},"prstStatCd":{"type":"string","description":"선물상태코드(OM044)"},"prstMsg":{"type":"string","description":"선물메시지"},"ordMediaCdNm":{"type":"string","description":"주문매체코드명"},"siteNm":{"type":"string","description":"사이트명"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"}}}}}} ``` ## The RealGridListResponseDeliveryInquiryResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponseDeliveryInquiryResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryInquiryResponse"}}}},"DeliveryInquiryResponse":{"type":"object","description":"배송조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"deliNo":{"type":"string","description":"배송번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordGbCd":{"type":"string","description":"주문구분코드(OM002)","enum":["NORMAL","GIFT"]},"deliSeq":{"type":"string","description":"출고차수(배송순번)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005)"},"deliDtlStatCd":{"type":"string","description":"배송내역상태(LO016)"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"deliTypCd":{"type":"string","description":"배송유형(LO002)"},"deliKindCd":{"type":"string","description":"배송종류(LO009)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명(PR008)"},"hdcCd":{"type":"string","description":"택배사(LO005)"},"invNo":{"type":"string","description":"송장번호"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004)"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"ordQty":{"type":"string","description":"주문수량"},"shipQty":{"type":"string","description":"출고수량"},"shipNeedQty":{"type":"string","description":"출고필요수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"주문자 로그인ID"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인 휴대폰 번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인 휴대폰 구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인 휴대폰 국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"addr":{"type":"string","description":"주소"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgNm":{"type":"string","description":"배송메시지코드명(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"deliFnshDtm":{"type":"string","format":"date-time","description":"배송완료일시"},"prstStatCd":{"type":"string","description":"선물상태코드(OM044)"},"prstMsg":{"type":"string","description":"선물메시지"},"ordMediaCdNm":{"type":"string","description":"주문매체코드명"},"siteNm":{"type":"string","description":"사이트명"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"}}}}}} ``` ## The DeliveryDetailResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryDetailResponse":{"type":"object","description":"배송상세 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"deliNo":{"type":"string","description":"배송번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordGbCd":{"type":"string","description":"주문구분코드(OM002)","enum":["NORMAL","GIFT"]},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005)"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"deliTypCd":{"type":"string","description":"배송유형(LO002)"},"deliKindCd":{"type":"string","description":"배송종류(LO009)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명(PR008)"},"ordManNm":{"type":"string","description":"주문자명"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인 휴대폰 번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인 휴대폰 구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인 휴대폰 국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"addr":{"type":"string","description":"주소"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgNm":{"type":"string","description":"배송메시지코드명(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"prstStatCd":{"type":"string","description":"선물상태코드(OM044)"},"prstMsg":{"type":"string","description":"선물메시지"},"persCstmCd":{"type":"string","description":"통관고유번호"}}}}}} ``` ## The DeliveryMgmtCommonRequest object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryMgmtCommonRequest":{"type":"object","description":"배송관리조회 요청 DTO","properties":{"entrNo":{"type":"string","description":"협력사번호"},"searchDateType":{"type":"string","description":"조회기간구분"},"startDate":{"type":"string","format":"date","description":"조회기간(시작일)"},"endDate":{"type":"string","format":"date","description":"조회기간(종료일)"},"searchDeliveryType":{"type":"string","description":"배송정보 구분"},"deliveryVal":{"type":"string","description":"배송정보 입력값"},"deliKindCd":{"type":"string","description":"배송종류(LO009) 10:일반배송, 20:예약배송"},"searchOrdManType":{"type":"string","description":"주문자정보구분"},"ordManVal":{"type":"string","description":"주문자정보입력값"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008) 10:센터배송, 20:업체배송, 30:e-쿠폰배송"},"searchOrdDtlStatCd":{"type":"string","description":"주문내역상태(조회조건)"},"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005) 12:주문완료, 21:배송지시, 22:출고지시, 23:출고대기, 26:출고완료, 33:접수"},"toOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005) 21:배송지시, 22:출고지시, 23:출고대기, 26:출고완료, 27:배송완료"},"hdcCd":{"type":"string","description":"택배사(LO005) 10:CJ대한통운, 11:우체국택배, 12:굿투럭, 13:DHL택배, 14:로젠택배, 30:부릉, 31:고고밴"},"shipWaitCaus":{"type":"string","description":"출고대기사유(LO007) 10:재고부족, 20:재고있지만출고불가능, 30:고객변심"},"workType":{"type":"string","description":"배송 업무 유형(DeliveryWorkType) insuffMgmt:결품 관리"}}}}}} ``` ## The DeliveryMgmtCommonResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"DeliveryMgmtCommonResponse":{"type":"object","description":"배송처리조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"ordProcSeq":{"type":"string","description":"주문처리순번"},"deliNo":{"type":"string","description":"배송번호"},"deliSeq":{"type":"string","description":"배송순번"},"ordGbCd":{"type":"string","description":"주문구분코드"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliKindCd":{"type":"string","description":"배송종류코드"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"hdcCd":{"type":"string","description":"택배사(LO005)"},"hdcCdNm":{"type":"string","description":"택배사명"},"invNo":{"type":"string","description":"송장번호"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004)"},"partShipYn":{"type":"string","description":"분리출고가능여부"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"ordQty":{"type":"string","description":"주문수량"},"preShipQty":{"type":"string","description":"기출고수량"},"shipNeedQty":{"type":"string","description":"출고필요수량"},"shipQty":{"type":"string","description":"출고수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellNo":{"type":"string","description":"주문자휴대폰번호"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인휴대폰번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"shipWaitCaus":{"type":"string","description":"출고대기사유(LO007)"},"shipWaitCausCont":{"type":"string","description":"출고대기사유상세내용"},"shipWaitDtm":{"type":"string","format":"date-time","description":"출고대기일시"},"insuffElpsdDay":{"type":"string","description":"결품경과일"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"}}}}}} ``` ## The RealGridListResponseDeliveryMgmtCommonResponse object ```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"components":{"schemas":{"RealGridListResponseDeliveryMgmtCommonResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMgmtCommonResponse"}}}},"DeliveryMgmtCommonResponse":{"type":"object","description":"배송처리조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"ordProcSeq":{"type":"string","description":"주문처리순번"},"deliNo":{"type":"string","description":"배송번호"},"deliSeq":{"type":"string","description":"배송순번"},"ordGbCd":{"type":"string","description":"주문구분코드"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliKindCd":{"type":"string","description":"배송종류코드"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"hdcCd":{"type":"string","description":"택배사(LO005)"},"hdcCdNm":{"type":"string","description":"택배사명"},"invNo":{"type":"string","description":"송장번호"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004)"},"partShipYn":{"type":"string","description":"분리출고가능여부"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"ordQty":{"type":"string","description":"주문수량"},"preShipQty":{"type":"string","description":"기출고수량"},"shipNeedQty":{"type":"string","description":"출고필요수량"},"shipQty":{"type":"string","description":"출고수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellNo":{"type":"string","description":"주문자휴대폰번호"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인휴대폰번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"shipWaitCaus":{"type":"string","description":"출고대기사유(LO007)"},"shipWaitCausCont":{"type":"string","description":"출고대기사유상세내용"},"shipWaitDtm":{"type":"string","format":"date-time","description":"출고대기일시"},"insuffElpsdDay":{"type":"string","description":"결품경과일"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"}}}}}} ```