{"openapi":"3.1.0","info":{"title":"Homepick API","description":" ### 🔗 Link\n - [굿스플로 (goodsflow.com)](https://goodsflow.com)\n - [홈픽 (homepick.com)](https://homepick.com)\n - [오늘도착 (today.homepick.com)](https://today.homepick.com)\n\n ### 📧 Contact\n 영업팀을 통해 연동 협의 및 API키 발급 후 사용 가능합니다.\n - 제휴/연동 관련: [영업1팀 (tm.sales01@pimz.co.kr)](mailto:tm.sales01@pimz.co.kr)\n - 개발 관련: [개발팀 (tm.tms@pimz.co.kr)](mailto:tm.tms@pimz.co.kr)\n\n ### ❗API 사용 안내\n**인증 방법**\n - 모든 API 호출 시 발급받은 API키를 `Authorization` 헤더에 포함해야 합니다.\n\n **Swagger UI 테스트 방법**\n 1. 이 블록 바로 아래 우측 **Authorize 🔒** 버튼을 클릭하세요.\n 2. 발급받은 API키를 입력하고 **Authorize** 버튼을 누르세요.\n 3. 이제 모든 API에서 **Try it out** 기능을 사용할 수 있습니다.\n\n **참고사항**\n - 인증 정보는 브라우저에 자동 저장되어 새로고침 후에도 유지됩니다.\n - API키가 없거나 유효하지 않을 경우 오류가 발생합니다.\n","version":"1.0"},"servers":[{"url":"/"}],"security":[{"ApiKey":[]}],"paths":{"/v1/totalCost/quick":{"post":{"tags":["2. Validation"],"summary":"퀵서비스 요금 정보 조회","description":"퀵서비스 요금정보 조회 - 퀵서비스 주문 접수시 quickInfoId가 필요합니다.","operationId":"quickTotalCost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickInfoRequestDTO"}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSQuickInfoDTO"}}}}}}},"/v1/sellers/totalCost":{"post":{"tags":["Etc. Sellers API"],"summary":"퀵/화물 요금조회","description":"퀵/화물 통합 요금조회. deliveryType(D_QUICK|D_CARGO)에 따라 quick/cargo 객체 필수.\n- 접수(order) 시 필요한 요금조회 id(36자리 uuid)를 반환합니다.\n- 경유지(waypoint)는 quick/cargo 객체 안에 포함하여 전달합니다.","operationId":"totalCost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCostRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/sellers/order":{"post":{"tags":["Etc. Sellers API"],"summary":"퀵/화물 통합 접수","description":"deliveryType(D_QUICK|D_CARGO)으로 분기하여 접수. 해당 타입의 리스트만 채워 전달.\n- 각 건은 요금조회에서 받은 id(quickInfoId/cargoInfoId)를 포함해야 합니다.\n- customData 는 그대로 보관했다가 추가운임/취소 통보 시 echo 합니다.","operationId":"order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellersOrderRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/sellers/callback/payment":{"post":{"tags":["Etc. Sellers API"],"summary":"추가운임 결제 결과 콜백","description":"셀러스가 추가운임 결제 결과(성공/실패)를 통보. 통보 시 전달한 chargeRef 로 매칭.\n- status=PAID: 미납금 차감 / status=FAILED: 미납 유지","operationId":"callbackPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellersPaymentResultDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/order":{"post":{"tags":["3. Order"],"summary":"주문 접수","description":"홈픽 서비스 주문정보 접수","operationId":"order_1","parameters":[{"name":"partnerOrderNoDuplicateCheck","in":"query","description":"제휴사 주문번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false},{"name":"partnerInvoiceNoDuplicateCheck","in":"query","description":"제휴사 운송장번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"주문접수데이터","items":{"$ref":"#/components/schemas/OrderBoxReceiptDTO"}}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderReceiptResponseDTO"}}}}}}},"/v1/orderToday":{"post":{"tags":["3. Order"],"summary":"오늘도착 주문 접수","description":"홈픽 서비스 오늘도착 주문정보 접수","operationId":"orderToday","parameters":[{"name":"partnerOrderNoDuplicateCheck","in":"query","description":"제휴사 주문번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":true},{"name":"partnerInvoiceNoDuplicateCheck","in":"query","description":"제휴사 운송장번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":true},{"name":"returnDetailMessageOnError","in":"query","description":"에러 발생시 상세 메시지 리턴","required":false,"schema":{"type":"boolean"},"example":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"주문접수데이터","items":{"$ref":"#/components/schemas/OrderBoxTodayReceiptDTO"}}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderReceiptResponseDTO"}}}}}}},"/v1/orderToday/checkZipCodesForToday":{"post":{"tags":["2. Validation"],"summary":"오늘도착서비스 배송가능 우편번호 필터","description":"우편번호 목록을 전달하면 오늘도착서비스 배송가능한 우편번호만 반환합니다.","operationId":"checkZipCodesForToday","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"성공 - 배송가능한 우편번호 목록","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSStringList"}}}}}}},"/v1/orderQuick":{"post":{"tags":["3. Order"],"summary":"퀵서비스 주문 접수","description":"홈픽 서비스 퀵서비스 주문정보 접수","operationId":"orderQuick","parameters":[{"name":"partnerOrderNoDuplicateCheck","in":"query","description":"제휴사 주문번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false},{"name":"partnerInvoiceNoDuplicateCheck","in":"query","description":"제휴사 운송장번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"주문접수데이터","items":{"$ref":"#/components/schemas/OrderBoxQuickReceiptDTO"}}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderReceiptResponseDTO"}}}}}}},"/v1/order/print":{"post":{"tags":["3. Order"],"summary":"송장출력을 위한 데이터 조회","description":"송장출력을 위한 데이터 조회","operationId":"printData","parameters":[{"name":"countCheck","in":"query","description":"건 수 체크 여부(요청 건수와 실 출력 대상 건수가 맞지 않을 경우 error 리턴)","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintDataRequestDTO"}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSStringPrintData"}}}}}}},"/v1/order/printPage":{"post":{"tags":["3. Order"],"summary":"송장출력 페이지 URL(ID) 조회","description":"송장출력 페이지를 띄우기 위한 URL 및 ID 조회","operationId":"printPage","parameters":[{"name":"countCheck","in":"query","description":"건 수 체크 여부(요청 건수와 실 출력 대상 건수가 맞지 않을 경우 error 리턴)","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintDataRequestDTO"}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSStringPrintUrl"}}}}}}},"/v1/order/cancel/orderNo/{orderNo}":{"post":{"tags":["3. Order"],"summary":"주문 취소","operationId":"cancelOrderNo","parameters":[{"name":"orderNo","in":"path","description":"취소 대상 주문번호","required":true,"schema":{"type":"string"},"example":"210520-00126"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/order/cancel/invoiceNo/{invoiceNo}":{"post":{"tags":["3. Order"],"summary":"주문 취소","description":"홈픽 서비스 박스(운송장) 번호로 주문정보 취소","operationId":"cancelInvoiceNo","parameters":[{"name":"invoiceNo","in":"path","description":"취소 대상 박스(운송장) 번호","required":true,"schema":{"type":"string"},"example":"210520-00126-002"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequestDTO"}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonResultForSwaggerEmpty"}}}}}}},"/v1/ezadmin/totalCost":{"post":{"tags":["Etc. EzAdmin API"],"summary":"퀵/화물 요금조회","description":"퀵/화물 통합 요금조회. deliveryType(D_QUICK|D_CARGO)에 따라 quick/cargo 객체 필수.\n- 접수(order) 시 필요한 요금조회 id(36자리 uuid)를 반환합니다.\n- 경유지(waypoint)는 quick/cargo 객체 안에 포함하여 전달합니다.","operationId":"totalCost_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCostRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/ezadmin/order":{"post":{"tags":["Etc. EzAdmin API"],"summary":"퀵/화물 통합 접수","description":"deliveryType(D_QUICK|D_CARGO)으로 분기하여 접수. 해당 타입의 리스트만 채워 전달.\n- 각 건은 요금조회에서 받은 id(quickInfoId/cargoInfoId)를 포함해야 합니다.","operationId":"order_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EzadminOrderRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/ezadmin/order/status/bulk":{"post":{"tags":["Etc. EzAdmin API"],"summary":"배송흐름 벌크 조회","description":"제휴사 주문번호 여러 건(최대 50건)의 배송 상태/흐름을 한번에 조회. 배송조회 진입/새로고침용.\n- 응답은 단건 조회(/order/status/partnerOrderNo/{no})와 동일한 DTO 리스트이며, 각 원소의 partnerOrderNo 로 그룹핑할 수 있습니다.\n- 존재하지 않는 주문번호는 응답에서 제외됩니다.","operationId":"statusBulk","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EzadminBulkStatusRequestDTO"}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTOList"}}}}}}},"/v1/ezadmin/callback/payment":{"post":{"tags":["Etc. EzAdmin API"],"summary":"추가운임 결제 결과 콜백","description":"이지어드민이 추가운임 결제 결과(성공/실패)를 통보. 통보 시 전달한 chargeRef 로 매칭.\n- status=PAID: 미납금 차감 / status=FAILED: 미납 유지","operationId":"callbackPayment_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EzadminPaymentResultDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonResult"}}}}}}},"/v1/compuzone/order/{orderNo}/today/invoice/{invoiceCount}":{"post":{"tags":["Etc. Compuzone API"],"summary":"컴퓨존 오늘도착 주문 송장추가","operationId":"orderCompuzoneAddOrder","parameters":[{"name":"orderNo","in":"path","description":"홈픽 주문번호","required":true,"schema":{"type":"string"},"example":"250602-41425"},{"name":"invoiceCount","in":"path","description":"추가할 송장 개수","required":true,"schema":{"type":"integer","format":"int32"},"example":2}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderReceiptResponseDTO"}}}}}}},"/v1/compuzone/order/quick":{"post":{"tags":["Etc. Compuzone API"],"summary":"컴퓨존 퀵서비스 주문 접수","description":"- pickupRequestDateTime 값이 존재하는 경우 예약픽업, 그렇지 않은 경우 즉시픽업으로 진행됩니다.\n- pickupRequestDateTime 값이 존재하는 경우 현재 시각으로부터 60분 이상이어야 합니다.\n","operationId":"orderCompuzoneQuickCargo","parameters":[{"name":"partnerOrderNoDuplicateCheck","in":"query","description":"제휴사 주문번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false},{"name":"partnerInvoiceNoDuplicateCheck","in":"query","description":"제휴사 운송장번호 중복 체크 여부","required":false,"schema":{"type":"boolean"},"example":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"주문접수데이터","items":{"$ref":"#/components/schemas/OrderBoxCompuzoneQuickCargoReceiptDTO"}}}},"required":true},"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderReceiptResponseDTO"}}}}}}},"/v1/totalCost/{deliveryType}/{boxType}/{fromZipCode}/{toZipCode}":{"get":{"tags":["2. Validation"],"summary":"요금(도선료 포함)정보 조회","description":"배송서비스에 따른 요금정보(도선료 포함) 조회","operationId":"totalCost_2","parameters":[{"name":"deliveryType","in":"path","description":"배송종류","required":true,"schema":{"type":"string","enum":["D_SHIPPING","D_QUICK"]}},{"name":"boxType","in":"path","description":"박스타입","required":true,"schema":{"type":"string","enum":["XSMALL","SMALL","MEDIUM","LARGE"]}},{"name":"fromZipCode","in":"path","description":"출발지 우편번호","required":true,"schema":{"type":"string"},"example":"06052"},{"name":"toZipCode","in":"path","description":"도착지 우편번호","required":true,"schema":{"type":"string"},"example":"07988"},{"name":"pickupRequestDate","in":"query","description":"픽업요청일","required":false,"schema":{"type":"string"},"example":"2022-05-27"},{"name":"transporter","in":"query","description":"택배사 (옵션). 미지정 시 기본 택배사 단가표 반환. 다중 계약 보유 시 transporter별 단가 조회용.","required":false,"schema":{"type":"string","enum":["HANJIN","LOTTE","CJGLS","EPOST"]}}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSBoxCostWithAddedCostDTO"}}}}}}},"/v1/orderToday/zipcodeList":{"get":{"tags":["2. Validation"],"summary":"오늘도착서비스 가능 우편번호 조회","description":"오늘도착서비스 가능 전체 우편번호 리스트","operationId":"getTodayZipcodeList","parameters":[{"name":"area1","in":"query","description":"시도","required":true,"schema":{"type":"string","enum":["서울특별시","경기도","인천광역시"]},"example":"서울특별시"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3ZipcodeDTO"}}}}}}},"/v1/orderToday/sortCode/{zipCodeCommaList}":{"get":{"tags":["2. Validation"],"summary":"오늘도착서비스 분류코드 조회","description":"오늘도착서비스 분류코드 조회/가능 지역 판단","operationId":"getTodaySortCode","parameters":[{"name":"zipCodeCommaList","in":"path","description":"우편번호(컴마구분)","required":true,"schema":{"type":"string"},"example":"06052,06373,01079,06252,12345"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3TodayResponseZipSortCodeDTOList"}}}}}}},"/v1/order/status/transporterInvoiceNo/{transporterInvoiceNo}":{"get":{"tags":["3. Order"],"summary":"배송사 운송장번호별 주문 상태 조회 (One)","description":"배송사 운송장번호(홈픽택배,한진택배)에 해당하는 주문 상태값을 조회합니다.\n- transporterInvoiceNo 를 먼저 조회하고, 검색 결과가 없을 경우 relayTransporterInvoiceNo 룰 조회합니다.","operationId":"statusByTransporterInvoiceNo","parameters":[{"name":"transporterInvoiceNo","in":"path","description":"조회 대상 배송사 운송장 번호","required":true,"schema":{"type":"string"},"example":160008817396}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTO"}}}}}}},"/v1/order/status/partnerOrderNo/{partnerOrderNo}":{"get":{"tags":["3. Order"],"summary":"제휴사 주문 번호별 주문 상태 조회 (List)","description":"제휴사 주문 번호에 해당하는 주문 상태값을 조회합니다.","operationId":"statusByPartnerOrderNo","parameters":[{"name":"partnerOrderNo","in":"path","description":"조회 대상 제휴사 주문 번호","required":true,"schema":{"type":"string"},"example":"201209290624_001"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTOList"}}}}}}},"/v1/order/status/orderNo/{orderNo}":{"get":{"tags":["3. Order"],"summary":"주문 번호별 주문 상태 조회 (List)","description":"주문번호에 해당하는 각 박스(배송)의 상태값을 조회합니다.","operationId":"statusOrderNo","parameters":[{"name":"orderNo","in":"path","description":"조회 대상 주문번호","required":true,"schema":{"type":"string"},"example":"210520-00126"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTOList"}}}}}}},"/v1/order/status/invoiceNo/{invoiceNo}":{"get":{"tags":["3. Order"],"summary":"박스번호(운송장번호)별 주문 상태 조회 (One)","description":"박스(운송장) 번호에 해당하는 주문 상태값을 조회합니다.","operationId":"statusInvoiceNo","parameters":[{"name":"invoiceNo","in":"path","description":"조회 대상 박스(운송장) 번호","required":true,"schema":{"type":"string"},"example":"210520-00126-002"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTO"}}}}}}},"/v1/order/status/dateTerm/{dateTermSearchType}":{"get":{"tags":["3. Order"],"summary":"기간별 주문 상태 조회 (List)","description":"접수/픽업요청일 및 배송상태 조건으로 상태값을 조회합니다.\n- RECEIPT:접수일기준,PICKUP_REQUEST:픽업요청일기준\n- 100건 씩 조회 (다음 페이지를 지정할 경우, page 파라메터 사용)","operationId":"statusByDateTerm","parameters":[{"name":"dateTermSearchType","in":"path","description":"조회기간 구분(접수/픽업요청일)","required":true,"schema":{"type":"string","enum":["RECEIPT","PICKUP_REQUEST"]}},{"name":"fromDate","in":"query","description":"조회일 시작 (일자 포함)","required":true,"schema":{"type":"string"},"example":"2021-07-19"},{"name":"toDate","in":"query","description":"조회일 끝 (일자 포함)","required":true,"schema":{"type":"string"},"example":"2021-07-25"},{"name":"orderStatus","in":"query","description":"배송상태(옵션)","required":false,"schema":{"type":"string","enum":["RESERVED","RESERVED_CANCELED","RECEIVED","TRANSFERRED","ALLOCATED","PICKUP_START","PICKUP_FAILED","PICKUP","MOVING","DLV_START","WAYPOINT_ARRIVAL","COMPLETED","CANCELED"]}},{"name":"page","in":"query","description":"페이지(옵션-미입력시 1)","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderStatusHistoryItemSimpleBoxDTOList"}}}}}}},"/v1/order/invoiceNo/{invoiceNo}":{"get":{"tags":["3. Order"],"summary":"주문 현황(단건) 상세 조회","description":"박스(운송장) 번호를 통한 홈픽 서비스 주문 현황(단건) 상세 조회","operationId":"order_3","parameters":[{"name":"invoiceNo","in":"path","description":"조회 대상 박스(운송장) 번호","required":true,"schema":{"type":"string"},"example":"210520-00126-002"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSOrderBoxOneDTO"}}}}}}},"/v1/nike/orderToday/invoicePrintProperties":{"get":{"tags":["Etc. Nike API"],"summary":"오늘도착 송장출력 필요 프로퍼티 조회","description":"<b>아래는 오늘도착 송장 출력 예시입니다. 아래 표를 참고하여 모든 항목을 송장에 포함해 주세요.</b>\n<table class='today-wrapper'><tr>\n<td><img src='/public/image/invoice_sample_today.png' width='600' /></td>\n<td>\n<table class='today-invoice'>\n<thead><tr><th>번호</th><th>항목</th><th>필드</th><th>비고</th></tr></thead>\n<tbody>\n<tr><td>1</td><td>배송유형</td><td>dawnDelivery</td><td>true: \"새벽\" 노출 / false: 미노출</td></tr>\n<tr><td>2</td><td>분류코드</td><td>sortCode</td><td></td></tr>\n<tr><td>3</td><td>구동 (받는분 구/동)</td><td>guDong</td><td></td></tr>\n<tr><td>4</td><td>받는 분 우편번호</td><td>toZipCode</td><td></td></tr>\n<tr><td>5</td><td>보내는 분 이름</td><td>fromName</td><td>마스킹 필수</td></tr>\n<tr><td>6</td><td>보내는 분 주소1</td><td>fromAddress1</td><td></td></tr>\n<tr><td>7</td><td>보내는 분 주소2</td><td>fromAddress2</td><td></td></tr>\n<tr><td>8</td><td>보내는 분 전화번호</td><td>fromPhoneNumber</td><td>마스킹 필수</td></tr>\n<tr><td>9</td><td>받는 분 이름</td><td>toName</td><td>마스킹 필수</td></tr>\n<tr><td>10</td><td>받는 분 주소1</td><td>toAddress1</td><td></td></tr>\n<tr><td>11</td><td>받는 분 주소2</td><td>toAddress2</td><td></td></tr>\n<tr><td>12</td><td>받는 분 전화번호</td><td>toPhoneNumber</td><td>마스킹 필수</td></tr>\n<tr><td>13</td><td>메모</td><td>memo</td><td></td></tr>\n<tr><td>14</td><td>상품명</td><td>itemName</td><td></td></tr>\n<tr><td>15</td><td>홈픽 로고</td><td>-</td><td><img src='/public/image/today_logo.png' width='50' height='50' /></td></tr>\n<tr><td>16</td><td>송장번호 (바코드)</td><td>invoiceNo</td><td>CODE128</td></tr>\n<tr><td>17</td><td>배송수행일</td><td>orderDate</td><td></td></tr>\n</tbody>\n</table>\n</td>\n</tr></table>\n","operationId":"invoicePrintProperties","parameters":[{"name":"transporterInvoiceNo","in":"query","description":"송장번호","required":true,"schema":{"type":"string"},"example":210000034757}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3InvoicePrintProperties"}}}}}}},"/v1/nike/orderToday/available":{"get":{"tags":["Etc. Nike API"],"summary":"오늘도착 가능지역 확인","operationId":"orderTodayAvailable","parameters":[{"name":"address","in":"query","description":"주소","required":true,"schema":{"type":"string"},"example":"서울 성동구 아차산로 38"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3AvailableAddressCheckDTO"}}}}}}},"/v1/ezadmin/orderToday/invoicePrintProperties":{"get":{"tags":["Etc. EzAdmin API"],"summary":"오늘도착 송장출력 필요 프로퍼티 조회","operationId":"invoicePrintProperties_1","parameters":[{"name":"transporterInvoiceNo","in":"query","description":"송장번호","required":true,"schema":{"type":"string"},"example":210000034757}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3InvoicePrintProperties"}}}}}}},"/v1/ezadmin/orderToday/available":{"get":{"tags":["Etc. EzAdmin API"],"summary":"오늘도착 가능지역 확인","operationId":"orderTodayAvailable_1","parameters":[{"name":"address","in":"query","description":"주소","required":true,"schema":{"type":"string"},"example":"서울 성동구 아차산로 38"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSTms3AvailableAddressCheckDTO"}}}}}}},"/v1/disabledDeliveryArea/{transporterCode}":{"get":{"tags":["2. Validation"],"summary":"배송불가지역 조회","description":"택배사에 따른 배송불가지역 조회 - 제공 중단될 수 있음","operationId":"disabledDeliveryArea","parameters":[{"name":"transporterCode","in":"path","description":"택배사코드","required":true,"schema":{"type":"string","enum":["HANJIN"]},"example":"HANJIN"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSDisabledDeliveryAreaDTOList"}}}}}}},"/v1/cost/{deliveryType}":{"get":{"tags":["2. Validation"],"summary":"요금정보 조회","description":"배송서비스에 따른 요금정보 조회","operationId":"costToday","parameters":[{"name":"deliveryType","in":"path","description":"배송종류","required":true,"schema":{"type":"string","enum":["D_SHIPPING","D_TODAY_D","D_TODAY_P","D_TODAY_PD","D_QUICK"]}},{"name":"transporter","in":"query","description":"택배사 (옵션). 미지정 시 기본 택배사 단가표 반환. 다중 계약 보유 시 transporter별 단가 조회용.","required":false,"schema":{"type":"string","enum":["HANJIN","LOTTE","CJGLS","EPOST"]}}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSAvailableDeliveryTypeDTOBoxTypeDTOList"}}}}}}},"/v1/cost/{deliveryType}/{pickupRequestDate}":{"get":{"tags":["2. Validation"],"summary":"요금정보 조회","description":"배송서비스 및 픽업 예정일에 따른 요금정보 조회","operationId":"cost","parameters":[{"name":"deliveryType","in":"path","description":"배송종류","required":true,"schema":{"type":"string","enum":["D_SHIPPING","D_TODAY_D","D_TODAY_P","D_TODAY_PD","D_QUICK"]}},{"name":"pickupRequestDate","in":"path","description":"픽업예정일","required":true,"schema":{"type":"string"},"example":"2021-05-18"},{"name":"transporter","in":"query","description":"택배사 (옵션). 미지정 시 기본 택배사 단가표 반환. 다중 계약 보유 시 transporter별 단가 조회용.","required":false,"schema":{"type":"string","enum":["HANJIN","LOTTE","CJGLS","EPOST"]}}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSAvailableDeliveryTypeDTOBoxTypeDTOList"}}}}}}},"/v1/code/transporter":{"get":{"tags":["1. Code"],"summary":"배송사","description":"홈픽 서비스 코드목록(배송사) 조회","operationId":"codeTransporter","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/orderStatus":{"get":{"tags":["1. Code"],"summary":"주문상태","description":"홈픽 서비스 코드목록(주문상태) 조회","operationId":"codeOrderStatus","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/deliveryType":{"get":{"tags":["1. Code"],"summary":"배송유형","description":"홈픽 서비스 코드목록(배송유형) 조회","operationId":"codeDeliveryType","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/deliveryServiceSetting":{"get":{"tags":["1. Code"],"summary":"배송유형(종합)","description":"사용 가능한 배송유형(종합) 정보 조회","operationId":"deliveryServiceSetting","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSApiCompanyDeliveryServiceSettingDTOList"}}}}}}},"/v1/code/cancelType":{"get":{"tags":["1. Code"],"summary":"취소유형","description":"홈픽 서비스 코드목록(취소유형) 조회","operationId":"codeCancelType","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/boxType":{"get":{"tags":["1. Code"],"summary":"박스타입","description":"홈픽 서비스 코드목록(박스타입-전체) 조회","operationId":"codeBoxType","responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/boxType/{deliveryType}":{"get":{"tags":["1. Code"],"summary":"박스타입","description":"홈픽 서비스 코드목록(박스타입-배송유형별) 조회","operationId":"codeBoxTypeByDeliveryType","parameters":[{"name":"deliveryType","in":"path","description":"배송종류","required":true,"schema":{"type":"string","enum":["D_SHIPPING","D_TODAY_D","D_TODAY_P","D_TODAY_PD","D_QUICK"]}}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSCodeResponseDTOList"}}}}}}},"/v1/code/boxType/map":{"get":{"tags":["1. Code"],"summary":"박스타입(배송유형별 맵)","description":"배송유형별 박스타입을 Map 형태로 조회 { deliveryType: [boxType, ...] }","operationId":"codeBoxTypeMap","responses":{"200":{"description":"성공","content":{"application/json":{}}}}}},"/v1/available/pickupDateTime/{deliveryType}":{"get":{"tags":["2. Validation"],"summary":"픽업예약시간 조회","description":"배송서비스에 따른 가능한 픽업예약시간 조회","operationId":"availablePickupDateTime","parameters":[{"name":"deliveryType","in":"path","description":"배송종류","required":true,"schema":{"type":"string","enum":["D_SHIPPING","D_TODAY_D","D_TODAY_P","D_TODAY_PD","D_QUICK"]}}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSAvailablePickupDateTimeDTOList"}}}}}}},"/v1/available/deliveryType":{"get":{"tags":["2. Validation"],"summary":"배송종류 조회","description":"출/도착지 우편번호로 가능한 배송종류 조회","operationId":"availableDeliveryType","parameters":[{"name":"fromZipCode","in":"query","description":"출발지 우편번호","required":true,"schema":{"type":"string"},"example":"06052"},{"name":"toZipCode","in":"query","description":"도착지 우편번호","required":true,"schema":{"type":"string"},"example":"07988"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSAvailableDeliveryTypeSimpleDTOList"}}}}}}},"/v1/available/deliveryType/pickupDateTime":{"get":{"tags":["2. Validation"],"summary":"배송종류(+픽업가능일) 조회","description":"출/도착지 우편번호로 가능한 배송종류 + 픽업가능일 조회","operationId":"availableDeliveryTypeWithPickableDateTime","parameters":[{"name":"fromZipCode","in":"query","description":"출발지 우편번호","required":true,"schema":{"type":"string"},"example":"06052"},{"name":"toZipCode","in":"query","description":"도착지 우편번호","required":true,"schema":{"type":"string"},"example":"07988"}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JFSAvailableDeliveryTypeSimpleWithPickupDateTimeDTOList"}}}}}}}},"components":{"schemas":{"JFSQuickInfoDTO":{"type":"object","description":"퀵서비스 정보 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/LegacyQuickInfoDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"LegacyQuickInfoDTO":{"type":"object","properties":{"quickInfoId":{"type":"string"},"createdDateTime":{"type":"string","format":"date-time"},"expireDateTime":{"type":"string","format":"date-time"},"vehicleType":{"type":"string","enum":["BIKE","CAR","ANY"]},"originalCost":{"type":"integer","format":"int32"},"cost":{"type":"integer","format":"int32"},"distance":{"type":"integer","format":"int32"},"costDetail":{"type":"object"},"duration":{"type":"integer","format":"int64"},"discountRatio":{"type":"integer","format":"int32"}}},"QuickInfoRequestDTO":{"type":"object","description":"요금조회 정보","properties":{"weight":{"type":"integer","format":"int32","description":"무게(단위: kg)","example":5},"boxCount":{"type":"integer","format":"int32","description":"박스 수","example":1},"vehicleType":{"type":"string","description":"운송 수단","enum":["BIKE","CAR"],"example":"BIKE"},"pickupRequestDateTime":{"type":"string","format":"date-time","description":"픽업요청일시","example":"2024-11-01 10:00:00"},"fromAddress":{"type":"string","description":"보내는 분 주소","example":"서울 강남구 봉은사로 479 479타워 16층"},"toAddress":{"type":"string","description":"받는 분 주소","example":"서울 용산구 용산동2가 산 1-3"},"toAddress2":{"type":"string","description":"받는 분 주소2","example":"남산서울타워"},"comment":{"type":"string","description":"코멘트","example":"빠른 픽업 부탁드립니다."},"boxType":{"type":"string","description":"물품 크기 (XSMALL: 서류, SMALL: 소형, LARGE: 대형). 미입력시 서류(XSMALL)","enum":["XSMALL","SMALL","LARGE"],"example":"XSMALL"}}},"OrderBoxWaypointDTO":{"type":"object","description":"경유지","properties":{"address1":{"type":"string","description":"주소1","example":"서울 강남구 봉은사로 479"},"address2":{"type":"string","description":"주소2","example":"479타워 16층"},"name":{"type":"string","description":"이름","example":"홍길동"},"phoneNumber":{"type":"string","description":"연락처(휴대폰)","example":"01011110000"},"message":{"type":"string","description":"메시지","example":"경유지 메시지"}}},"TotalCostCargoDTO":{"type":"object","properties":{"weight":{"type":"integer","format":"int32","description":"무게(단위: kg)","example":5},"boxType":{"type":"string","description":"박스 종류","enum":["XSMALL","SMALL","LARGE"],"example":"XSMALL"},"boxCount":{"type":"integer","format":"int32","description":"박스 수","example":1},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격 (최대:200만원)","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupRequestDateTime":{"type":"string","format":"date-time","description":"픽업요청일시","example":"2025-01-01 10:00:00"},"comment":{"type":"string","description":"코멘트","example":"빠른 픽업 부탁드립니다."},"waypoint":{"type":"array","description":"경유지","items":{"$ref":"#/components/schemas/OrderBoxWaypointDTO"}},"vehicleType":{"type":"string","description":"배송수단 차종","enum":["DAMAS","LABO","1T","1.4T","2.5T","3.5T","5T","8T","11T","14T","15T","18T","25T"],"example":"DAMAS"},"vehicleOption":{"type":"string","description":"배송수단 옵션","enum":["DAMAS_NORMAL","CARGO","CANVAS","BOX_TRUCK","LOW_BOX_TRUCK","WINGBODY_TRUCK","FREEZER_TRUCK","REFRIGERATOR_TRUCK","LIFT_TRUCK"],"example":"DAMAS_NORMAL"},"loadingPosition":{"type":"string","description":"출발지 상차위치","enum":["LOADING_PARKING_SPACE","NEED_ITEM_TRANSFER"],"example":"LOADING_PARKING_SPACE"},"loadingMethod":{"type":"string","description":"출발지 상차방법","enum":["LOADING_YOURSELF","LOADING_WITH_DRIVER","LOADING_DRIVER","LOADING_DRIVER_WITH_HELPER"],"example":"LOADING_YOURSELF"},"unloadingPosition":{"type":"string","description":"도착지 하차위치","enum":["UNLOADING_PARKING_SPACE","NEED_ITEM_TRANSFER"],"example":"UNLOADING_PARKING_SPACE"},"unloadingMethod":{"type":"string","description":"도착지 하차방법","enum":["UNLOADING_YOURSELF","UNLOADING_WITH_DRIVER","UNLOADING_DRIVER","UNLOADING_DRIVER_WITH_HELPER"],"example":"UNLOADING_YOURSELF"}}},"TotalCostQuickDTO":{"type":"object","properties":{"weight":{"type":"integer","format":"int32","description":"무게(단위: kg)","example":5},"boxType":{"type":"string","description":"박스 종류","enum":["XSMALL","SMALL","LARGE"],"example":"XSMALL"},"boxCount":{"type":"integer","format":"int32","description":"박스 수","example":1},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격 (최대:200만원)","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupRequestDateTime":{"type":"string","format":"date-time","description":"픽업요청일시","example":"2025-01-01 10:00:00"},"comment":{"type":"string","description":"코멘트","example":"빠른 픽업 부탁드립니다."},"waypoint":{"type":"array","description":"경유지","items":{"$ref":"#/components/schemas/OrderBoxWaypointDTO"}},"vehicleCategory":{"type":"string","description":"배송수단 유형","enum":["BIKE","CAR","ANY"],"example":"CAR"},"vehicleOption":{"type":"string","description":"배송수단 옵션 (배송수단이 BIKE, CAR 인 경우 필수)","enum":["BIKE_BOX","BIKE_NO_BOX","CAR_SUV","CAR_ANY"],"example":"CAR_ANY"}}},"TotalCostRequestDTO":{"type":"object","description":"요금조회 정보","properties":{"deliveryType":{"type":"string","description":"배송타입","enum":["D_QUICK","D_CARGO"],"example":"D_QUICK"},"fromAddress1":{"type":"string","description":"보내는 분 주소1","example":"서울 강남구 봉은사로 479"},"fromAddress2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층"},"toAddress1":{"type":"string","description":"받는 분 주소2","example":"서울 용산구 용산동2가 산 1-3"},"toAddress2":{"type":"string","description":"받는 분 주소2","example":"남산서울타워"},"quick":{"$ref":"#/components/schemas/TotalCostQuickDTO","description":"퀵서비스 정보"},"cargo":{"$ref":"#/components/schemas/TotalCostCargoDTO","description":"화물 정보"}}},"JsonResult":{"type":"object","description":"공통 응답 Wrapper","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"data":{"type":"object"},"responseDateTime":{"type":"string"}}},"JsonNode":{"type":"object"},"OrderBoxCargoReceiptDTO":{"type":"object","description":"화물 접수 요청","properties":{"fromZipCode":{"type":"string","description":"보내는 분 우편번호","enum":["range[0","5]"],"example":"07988"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처(휴대폰)","example":"01011110000"},"fromAddr1":{"type":"string","description":"보내는 분 주소1","example":"서울 강남구 봉은사로 479"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층"},"toZipCode":{"type":"string","description":"받는 분 우편번호","enum":["range[0","5]"],"example":"06095"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"toAddr1":{"type":"string","description":"받는 분 주소1","example":"서울 용산구 용산동2가 산 1-3"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"남산서울타워"},"pickupRequestDateTime":{"type":"string","description":"픽업 요청(희망) 일시 (현재시간 이후)","example":"2023-10-16 15:00"},"itemName":{"type":"string","description":"상품명","example":"보낼 물품을 상세히 입력(예:5단 책장,가구 등)"},"comment":{"type":"string","description":"코멘트","example":"빠른 픽업 부탁드립니다."},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"cargoInfoId":{"type":"string","description":"화물 요금조회 정보 id","example":"화물 요금조회 정보 id"},"customData":{"$ref":"#/components/schemas/JsonNode","description":"이지어드민 커스텀 데이터(결제정보 등). JSON 그대로 저장되며 추가운임 통보 시 그대로 반환됨"}}},"OrderBoxQuickReceiptDTO":{"type":"object","description":"퀵서비스 접수 요청","properties":{"fromZipCode":{"type":"string","description":"보내는 분 우편번호","enum":["range[0","5]"],"example":"07988"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처(휴대폰)","example":"01011110000"},"fromAddr1":{"type":"string","description":"보내는 분 주소1","example":"서울 양천구 목동서로 117"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"2층 굿스코아"},"toZipCode":{"type":"string","description":"받는 분 우편번호","enum":["range[0","5]"],"example":"06095"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"toAddr1":{"type":"string","description":"받는 분 주소1","example":"서울 강남구 봉은사로 479"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"479타워 16층 굿스플로"},"boxType":{"type":"string","description":"박스 종류","enum":["XXSMALL","XSMALL","SMALL","MEDIUM","MEDIUM_LARGE","LARGE","XLARGE"],"example":"SMALL"},"boxCount":{"type":"integer","format":"int32","description":"박스 수량","example":1},"weight":{"type":"integer","format":"int32","description":"무게 (kg)","example":5},"vehicleType":{"type":"string","description":"배송수단","enum":["BIKE","CAR"],"example":"BIKE"},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격 (최대:200만원)","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupMessage":{"type":"string","description":"픽업 기사에게 메시지","example":"현관 앞에 둘게요."},"deliveryMessage":{"type":"string","description":"배달 기사에게 메시지","example":"경비실에 맡겨 주세요."},"pickupRequestDateTime":{"type":"string","description":"픽업 요청(희망) 일시 (현재시간 이후)","example":"2023-02-27 13:00"},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"quickInfoId":{"type":"string","description":"퀵 요금조회 정보 id","example":"퀵 요금조회 정보 id"},"customData":{"$ref":"#/components/schemas/JsonNode","description":"이지어드민 커스텀 데이터(결제정보 등). JSON 그대로 저장되며 추가운임 통보 시 그대로 반환됨"}}},"SellersOrderRequestDTO":{"type":"object","description":"퀵/화물 접수 정보","properties":{"deliveryType":{"type":"string","description":"배송타입","enum":["D_QUICK","D_CARGO"],"example":"D_QUICK"},"quick":{"type":"array","description":"퀵 접수 목록 (deliveryType=D_QUICK 인 경우)","items":{"$ref":"#/components/schemas/OrderBoxQuickReceiptDTO"}},"cargo":{"type":"array","description":"화물 접수 목록 (deliveryType=D_CARGO 인 경우)","items":{"$ref":"#/components/schemas/OrderBoxCargoReceiptDTO"}}}},"SellersPaymentResultDTO":{"type":"object","description":"결제 결과","properties":{"chargeRef":{"type":"string"},"status":{"type":"string"},"amount":{"type":"integer","format":"int32"},"paidAt":{"type":"string","format":"date-time"},"failReason":{"type":"string"},"paid":{"type":"boolean"},"failed":{"type":"boolean"}}},"Coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"double","description":"위도","example":37.4979},"longitude":{"type":"number","format":"double","description":"경도","example":127.0276}}},"JFSOrderReceiptResponseDTO":{"type":"object","description":"주문 접수 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/OrderReceiptResponseDTOOrderBoxReceiptResponseDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"OrderBoxReceiptResponseDTO":{"type":"object","description":"주문 접수 응답-data item","properties":{"deliveryType":{"type":"string","description":"접수된 배송 유형","example":"D_PICKUP"},"deliveryTypeName":{"type":"string","description":"접수된 배송 유형명","example":"오늘픽업"},"invoiceNo":{"type":"string","description":"박스(운송장) 번호","example":"220527-00077-001"},"boxType":{"type":"string","description":"박스 종류","example":"SMALL"},"boxTypeName":{"type":"string","description":"박스 종류 명","example":"소형"},"boxCost":{"type":"integer","format":"int32","description":"박스 기본 가격","example":4500},"addedCost":{"type":"integer","format":"int32","description":"추가 요금(도선료 등)","example":5000},"totalCost":{"type":"integer","format":"int32","description":"박스 가격(기본가격 + 도선료)","example":9500},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"partnerMemo":{"type":"string","description":"제휴사 메모","example":"홍길동 고객님 접수 건"},"transporter":{"type":"string","description":"배송사코드","example":"HOMEPICK3"},"transporterName":{"type":"string","description":"배송사명","example":"홈픽v3"},"transporterInvoiceNo":{"type":"string","description":"배송사운송장번호","example":1000002012929},"convenienceReserveNo":{"type":"string","description":"편의점택배 예약번호 (송장번호와 별개, 편의점 방문 접수용)","example":503000000007},"orderStatus":{"type":"string","description":"배송상태","example":"RECEIVED"},"orderStatusName":{"type":"string","description":"배송상태명","example":"접수완료"},"partnerOriginOrderNo":{"type":"string","description":"반품/맞교환 시 원 주문번호","example":"OD-54472342001"},"tmsError":{"type":"string","description":"배차 접수 실패 메시지 (자동 취소 시)"},"toCoordinates":{"$ref":"#/components/schemas/Coordinates","description":"받는 곳 좌표"},"fromCoordinates":{"$ref":"#/components/schemas/Coordinates","description":"보내는 곳 좌표"}}},"OrderReceiptResponseDTOOrderBoxReceiptResponseDTO":{"type":"object","description":"주문 접수 응답-data","properties":{"orderNo":{"type":"string","description":"주문(접수) 번호","example":"210518-00077"},"orderBoxList":{"type":"array","description":"주문 박스 리스트","items":{"$ref":"#/components/schemas/OrderBoxReceiptResponseDTO"}}}},"OrderBoxReceiptDTO":{"type":"object","description":"주문 접수 요청","properties":{"fromZipCode":{"type":"string","description":"보내는 분 우편번호","enum":["range[0","5]"],"example":"06095"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처","example":"01011110000"},"fromAddr1":{"type":"string","description":"보내는 분 주소1","example":"서울 강남구 봉은사로 479"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층 굿스플로"},"toZipCode":{"type":"string","description":"받는 분 우편번호","enum":["range[0","5]"],"example":"07988"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"toAddr1":{"type":"string","description":"받는 분 주소1","example":"서울 양천구 목동서로 117"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"2층 굿스코아"},"deliveryType":{"type":"string","description":"배송 종류","enum":["D_SHIPPING","D_CONVENIENCE","D_PICKUP","D_QUICK","D_CARGO","D_TODAY_P","D_TODAY_D","D_TODAY_PD"],"example":"D_SHIPPING"},"transporter":{"type":"string","description":"택배사 코드","enum":["HOMEPICK","HOMEPICK3","TODAY","EPOST","HANJIN","CJGLS","LOTTE","LOGEN","CUHOME","SEVENELEVEN","RETURNALL","DVER","GOGOX","INSUNG"],"example":"HANJIN,EPOST"},"boxType":{"type":"string","description":"박스 종류","enum":["XXSMALL","XSMALL","SMALL","MEDIUM","MEDIUM_LARGE","LARGE","XLARGE"],"example":"XSMALL,SMALL,MEDIUM,LARGE (극소형,소형,중형,대형)"},"boxCount":{"type":"integer","format":"int32","description":"박스 수량","example":1},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupMessage":{"type":"string","description":"픽업 기사에게 메시지","example":"현관 앞에 둘게요."},"deliveryMessage":{"type":"string","description":"배달 기사에게 메시지","example":"경비실에 맡겨 주세요."},"pickupRequestDateTime":{"type":"string","description":"픽업 요청(희망) 일시","example":"2022-05-27 13:00"},"deliveryRequestDateTime":{"type":"string","description":"배송 요청(희망) 일시","example":"2022-05-27 13:00"},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"partnerMemo":{"type":"string","description":"제휴사 메모","example":"홍길동 고객님 접수 건"}}},"OrderBoxTodayReceiptDTO":{"type":"object","description":"오늘도착 접수 요청","properties":{"fromZipCode":{"type":"string","description":"보내는 분 우편번호","enum":["range[0","5]"],"example":"07988"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처(휴대폰)","example":"01011110000"},"fromAddr1":{"type":"string","description":"보내는 분 주소1","example":"서울 양천구 목동서로 117"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"2층 굿스코아"},"toZipCode":{"type":"string","description":"받는 분 우편번호","enum":["range[0","5]"],"example":"06095"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"toAddr1":{"type":"string","description":"받는 분 주소1","example":"서울 강남구 봉은사로 479"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"47타워 16층 굿스플로"},"boxType":{"type":"string","description":"박스 종류","enum":["XXSMALL","XSMALL","SMALL","MEDIUM","MEDIUM_LARGE","LARGE","XLARGE"],"example":"MEDIUM"},"boxCount":{"type":"integer","format":"int32","description":"박스 수량","example":1},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격 (최대:200만원)","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupMessage":{"type":"string","description":"픽업 기사에게 메시지","example":"현관 앞에 둘게요."},"deliveryMessage":{"type":"string","description":"배달 기사에게 메시지","example":"경비실에 맡겨 주세요."},"pickupRequestDateTime":{"type":"string","description":"픽업 요청(희망) 일시 (현재시간 이후)","example":"2022-05-27 13:00"},"deliveryRequestDateTime":{"type":"string","description":"배송 요청(희망) 일시 (최대 요청가능일 +30일)","example":"2022-05-27 13:00"},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"partnerMemo":{"type":"string","description":"제휴사 메모","example":"홍길동 고객님 접수 건"},"partnerOriginOrderNo":{"type":"string","description":"제휴사 원 주문번호","example":54472341},"deliveryType":{"type":"string","description":"배송 종류(D_TODAY_P 픽업,D_TODAY_D 배송,D_TODAY_PD 픽업&배송)","enum":["D_SHIPPING","D_CONVENIENCE","D_PICKUP","D_QUICK","D_CARGO","D_TODAY_P","D_TODAY_D","D_TODAY_PD"],"example":"D_TODAY_D"},"terminalFirstCode":{"type":"string","description":"오늘도착(배송) 터미널 코드","example":"T_PANGYO"},"terminalFinalCode":{"type":"string","description":"오늘도착(픽업) 터미널 코드","example":"T_PANGYO"},"sendAlimtalkImmediately":{"type":"boolean","description":"시간과 관계없이 알림톡 즉시발송 (값을 지정하지 않거나 false인 경우 내부 설정값(발송 마감시간, 예약시간)에 의해 발송) ","example":true},"commonEntrancePassword":{"type":"string","description":"공동현관 비밀번호","example":"#1234"}}},"JFSStringList":{"type":"object","description":"문자열 목록","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"type":"string"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"InvoicePrintDataDTO":{"type":"object","description":"송장 출력 응답-data","properties":{"invoiceNo":{"type":"string","description":"송장(박스)번호","example":"210520-00126-001"},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"tmsSortCode":{"type":"string","description":"휠소터 코드","example":"SI0001"},"areaName":{"type":"string","description":"도착지 지역 이름","example":"논현동"},"tmsAreaName":{"type":"string","description":"도착지 시·구·동 (TMS 정보 기반)","example":"양천구 목동"},"toZipCode":{"type":"string","description":"받는 분 우편번호","example":210000009246},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처","example":"01011110000"},"fromAddr1":{"type":"string","description":"보내는 분 주소","example":"서울 강남구 봉은사로 479"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층 굿스플로"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"07988"},"toAddr1":{"type":"string","description":"받는 분 주소","example":"서울 양천구 목동서로 117"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"2층 굿스코아"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"customerMessage":{"type":"string","description":"기사에게 메시지","example":"문 앞 경비실"},"transporterInvoiceNo":{"type":"string","description":"송장번호","example":210000009246}}},"JFSStringPrintData":{"type":"object","description":"송장출력을 위한 데이터 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePrintDataDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"PrintDataRequestDTO":{"type":"object","description":"출력 대상 박스(운송장/고객주문) 번호","properties":{"invoiceNo":{"type":"array","description":"박스(접수)번호","example":["220329-18880-002","220329-18880-001","220329-18880-003","220329-18880-004"],"items":{"type":"string"},"uniqueItems":true},"transporterInvoiceNo":{"type":"array","description":"TMS운송장번호","example":["200000007360","200000007359","200000007358","200000007357"],"items":{"type":"string"},"uniqueItems":true},"partnerOrderNo":{"type":"array","description":"고객사주문번호","example":["200000007360","200000007359","200000007358","200000007357"],"items":{"type":"string"},"uniqueItems":true}}},"JFSStringPrintUrl":{"type":"object","description":"송장출력을 위한 Homepick URL(ID) 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/송장 출력 페이지 URL(ID) 응답"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"송장 출력 페이지 URL(ID) 응답":{"type":"object","description":"여러건을 출력할 경우, URL에 컴마 구분으로 id 추가, 발급된 id는 3분간 유효","properties":{"id":{"type":"string","description":"출력 id","example":"b8752c69010c4f2e092a5afc9fd859308841e6a72a15a7150e1ed2d859ce23b34028948d802166b30180218acd960009"},"url":{"type":"string","description":"출력 url","example":"https://www.homepick.com/invoice/print/b8752c69010c4f2e092a5afc9fd859308841e6a72a15a7150e1ed2d859ce23b34028948d802166b30180218acd960009"},"count":{"type":"integer","format":"int32","description":"출력 대상 건수","example":100}}},"CancelRequestDTO":{"type":"object","description":"취소 요청값","properties":{"cancelType":{"type":"string","description":"취소사유코드","example":"RE_RECEIVED"},"cancelReason":{"type":"string","description":"취소사유","example":"취소 후 재신청"}}},"JsonResultForSwaggerEmpty":{"type":"object","description":"빈 성공 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"}}},"EzadminOrderRequestDTO":{"type":"object","description":"퀵/화물 접수 정보","properties":{"deliveryType":{"type":"string","description":"배송타입","enum":["D_QUICK","D_CARGO"],"example":"D_QUICK"},"quick":{"type":"array","description":"퀵 접수 목록 (deliveryType=D_QUICK 인 경우)","items":{"$ref":"#/components/schemas/OrderBoxQuickReceiptDTO"}},"cargo":{"type":"array","description":"화물 접수 목록 (deliveryType=D_CARGO 인 경우)","items":{"$ref":"#/components/schemas/OrderBoxCargoReceiptDTO"}}}},"JFSOrderStatusHistoryItemSimpleBoxDTOList":{"type":"object","description":"주문 상태 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusHistoryItemSimpleBoxDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"OrderBoxCostChangeHistoryDTO":{"type":"object","properties":{"id":{"type":"string"},"changedAmount":{"type":"integer","format":"int32"},"reason":{"type":"string"},"createdDateTime":{"type":"string","format":"date-time"}}},"OrderStatusHistoryItemSimpleBoxDTO":{"type":"object","description":"주문 상태 조회 응답-data","properties":{"orderNo":{"type":"string","description":"주문 번호","example":"210514-00099"},"invoiceNo":{"type":"string","description":"박스(운송장) 번호","example":"210514-00099-001"},"transporter":{"type":"string","description":"배송사 코드","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"HOMEPICK"},"transporterInvoiceNo":{"type":"string","description":"배송사 송장번호","example":160008817396},"relayTransporter":{"type":"string","description":"연계배송사 코드","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"HANJIN"},"relayTransporterInvoiceNo":{"type":"string","description":"연계배송사 운송장번호","example":510684846125},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":"20120929-0624"},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":510123456725},"partnerMemo":{"type":"string","description":"제휴사 메모","example":"홍길동님 주문건"},"statusList":{"type":"array","description":"주문 상태 이력 리스트","items":{"$ref":"#/components/schemas/OrderStatusHistoryItemSimpleDTO"}},"costChangeHistory":{"type":"array","description":"추가요금 이력 리스트","items":{"$ref":"#/components/schemas/OrderBoxCostChangeHistoryDTO"}},"boxCost":{"type":"integer","format":"int32","description":"박스금액"},"addedCost":{"type":"integer","format":"int32","description":"추가금액"},"cancelAmount":{"type":"integer","format":"int32","description":"취소금액"},"cart":{"type":"boolean"}}},"OrderStatusHistoryItemSimpleDTO":{"type":"object","description":"주문 상태 이력 응답-data","properties":{"createdDateTime":{"type":"string","description":"상태 생성일시","example":"2021-05-14 17:54:27"},"orderStatus":{"type":"string","description":"주문상태","enum":["RESERVED","RESERVED_CANCELED","RECEIVED","TRANSFERRED","ALLOCATED","PICKUP_START","PICKUP_FAILED","PICKUP","MOVING","DLV_START","WAYPOINT_ARRIVAL","COMPLETED","CANCELED"],"example":"RECEIVED"},"orderStatusName":{"type":"string","description":"주문상태명","enum":["예약","예약취소","접수완료","이관","배차","픽업출발","미픽업","픽업완료","이동중","배송출발","경유지도착","배송완료","취소"],"example":"접수"},"orderStatusDateTime":{"type":"string","description":"상태 일시","example":"2021-05-14 17:54:27"},"location":{"type":"string","description":"현재 위치(지점)","example":"강남논현"},"tmsStatusName":{"type":"string","description":"배송사 상태명","example":"배송중(출고)"},"driverName":{"type":"string","description":"기사명","example":"홍길동"},"driverPhoneNumber":{"type":"string","description":"기사 연락처","example":"01011110000"},"reasonType":{"type":"string","description":"사유(픽업/배송)","example":"RECEIVER_REFUSE"},"contents":{"type":"string","description":"사유텍스트","example":"수취거부"}}},"EzadminBulkStatusRequestDTO":{"type":"object","description":"조회 대상 제휴사 주문번호 목록 (최대 50건)","properties":{"partnerOrderNos":{"type":"array","description":"조회 대상 제휴사 주문번호 목록 (최대 50건)","example":["201209290624_001","201209290624_002"],"items":{"type":"string"}}}},"EzadminPaymentResultDTO":{"type":"object","description":"결제 결과","properties":{"chargeRef":{"type":"string"},"status":{"type":"string"},"amount":{"type":"integer","format":"int32"},"paidAt":{"type":"string","format":"date-time"},"failReason":{"type":"string"},"paid":{"type":"boolean"},"failed":{"type":"boolean"}}},"OrderBoxCompuzoneQuickCargoReceiptDTO":{"type":"object","description":"컴퓨존 퀵서비스, 화물 접수 요청","properties":{"fromAddress1":{"type":"string","description":"보내는 분 주소1","example":"서울 강남구 봉은사로 479"},"fromAddress2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처(휴대폰)","example":"01011110000"},"toAddress1":{"type":"string","description":"받는 분 주소2","example":"서울 용산구 용산동2가 산 1-3"},"toAddress2":{"type":"string","description":"받는 분 주소2","example":"남산서울타워"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"partnerOrderNo":{"type":"string","description":"제휴사 주문번호","example":54472342},"partnerInvoiceNo":{"type":"string","description":"제휴사 운송장번호","example":6865493792285},"pickupMessage":{"type":"string","description":"픽업 기사에게 메시지","example":"현관 앞에 둘게요."},"deliveryMessage":{"type":"string","description":"배달 기사에게 메시지","example":"경비실에 맡겨 주세요."},"weight":{"type":"integer","format":"int32","description":"무게(단위: kg)","example":5},"boxType":{"type":"string","description":"박스 종류","enum":["XSMALL","SMALL","LARGE"],"example":"XSMALL"},"boxCount":{"type":"integer","format":"int32","description":"박스 수","example":1},"itemCategory":{"type":"string","description":"상품 유형","example":"옷"},"itemName":{"type":"string","description":"상품명","example":"폴로셔츠"},"itemPrice":{"type":"integer","format":"int32","description":"상품가격 (최대:200만원)","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"pickupRequestDateTime":{"type":"string","format":"date-time","description":"픽업요청일시","example":"2025-01-01 10:00:00"},"vehicleCategory":{"type":"string","description":"배송수단 유형","enum":["BIKE","CAR","ANY"],"example":"CAR"},"vehicleOption":{"type":"string","description":"배송수단 옵션 (배송수단이 BIKE, CAR 인 경우 필수)","enum":["BIKE_BOX","BIKE_NO_BOX","CAR_SUV","CAR_ANY"],"example":"CAR_ANY"},"prepaidCost":{"type":"integer","format":"int32","description":"컴퓨존 선불 비용","example":3000},"collectCost":{"type":"integer","format":"int32","description":"컴퓨존 착불 비용","example":5000},"selectedDeliveryDateTime":{"type":"string","format":"date-time","description":"컴퓨존 고객 선택 수령 시간","example":"2025-01-01 10:00:00"},"express":{"type":"boolean","description":"급송 여부","example":false},"comment":{"type":"string","description":"코멘트","example":"컴퓨존 주문입니다."},"waypoint":{"type":"array","description":"경유지","items":{"$ref":"#/components/schemas/OrderBoxWaypointDTO"}}}},"BoxCostWithAddedCostDTO":{"type":"object","description":"추가요금(도선료) 포함 박스 가격정보","properties":{"boxType":{"type":"string","description":"박스타입","example":"SMALL"},"boxTypeName":{"type":"string","description":"박스타입명","example":"소형"},"weight":{"type":"integer","format":"int32","description":"무게","example":5000},"volume":{"type":"integer","format":"int32","description":"3변합","example":100},"cost":{"type":"integer","format":"int32","description":"기본금액","example":5000},"addedCost":{"type":"integer","format":"int32","description":"추가금액","example":3000},"totalCost":{"type":"integer","format":"int32","description":"합계금액","example":8000},"accountGroupCost":{"type":"boolean","description":"기업요금여부","example":true},"accountGroupName":{"type":"string","description":"기업명","example":"굿스플로"},"errorMessage":{"type":"string"}}},"JFSBoxCostWithAddedCostDTO":{"type":"object","description":"요금(도선료 포함)정보 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/BoxCostWithAddedCostDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"JFSTms3ZipcodeDTO":{"type":"object","description":"오늘도착 배송가능 우편번호 정보 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/Tms3TodayZipcodeDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"Tms3TodayZipcodeDTO":{"type":"object","properties":{"zipcode":{"type":"string","description":"우편번호","example":"06052"},"area2":{"type":"string","description":"구군","example":"강남구"},"area3":{"type":"string","description":"동","example":"논현동"}}},"JFSTms3TodayResponseZipSortCodeDTOList":{"type":"object","description":"오늘도착 분류코드 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Tms3TodayResponseZipSortCodeDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"Tms3TodayResponseZipSortCodeDTO":{"type":"object","description":"오늘도착 분류코드 응답-data","properties":{"zipCode":{"type":"string","description":"우편번호","example":13979},"sortCode":{"type":"string","description":"분류코드","example":"4G-401"}}},"JFSOrderStatusHistoryItemSimpleBoxDTO":{"type":"object","description":"주문(박스) 상태 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/OrderStatusHistoryItemSimpleBoxDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"JFSOrderBoxOneDTO":{"type":"object","description":"주문 현황(단건) 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/OrderBoxOneDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"OrderBoxOneDTO":{"type":"object","description":"주문 현황(단건) 조회 응답-data","properties":{"orderStatus":{"type":"string","description":"주문 상태","enum":["RESERVED","RESERVED_CANCELED","RECEIVED","TRANSFERRED","ALLOCATED","PICKUP_START","PICKUP_FAILED","PICKUP","MOVING","DLV_START","WAYPOINT_ARRIVAL","COMPLETED","CANCELED"],"example":"PICKUP_START"},"orderStatusName":{"type":"string","description":"주문 상태명","enum":["예약","예약취소","접수완료","이관","배차","픽업출발","미픽업","픽업완료","이동중","배송출발","경유지도착","배송완료","취소"],"example":"픽업출발"},"orderStatusStep":{"type":"integer","format":"int32","description":"주문 상태 순서","example":1},"orderNo":{"type":"string","description":"주문번호","example":"210520-00126"},"orderNoSeq":{"type":"integer","format":"int32","description":"주문순번","example":1},"invoiceNo":{"type":"string","description":"송장(박스)번호","example":"210520-00126-001"},"deliveryType":{"type":"string","description":"배송 유형","enum":["D_SHIPPING,D_TODAY_D,D_TODAY_P,D_TODAY_PD,D_QUICK"],"example":"D_PICKUP"},"deliveryTypeName":{"type":"string","description":"배송 유형명","enum":["일반택배,오늘도착(배송),오늘도착(픽업),오늘도착(픽업&배송),퀵서비스"],"example":"오늘픽업"},"createdDateTime":{"type":"string","format":"date-time","description":"생성일시","example":"2021-07-23T08:00:00.000+09:00"},"fromPickupRequestDateTime":{"type":"string","format":"date-time","description":"요청일시(From)","example":"2021-07-23T11:00:00.000+09:00"},"toPickupRequestDateTime":{"type":"string","format":"date-time","description":"요청일시(From)","example":"2021-07-23T12:00:00.000+09:00"},"pickupDateTime":{"type":"string","format":"date-time","description":"요청일시(From)","example":"2021-07-23T12:00:00.000+09:00"},"completeDateTime":{"type":"string","format":"date-time","description":"요청일시(From)","example":"2021-07-26T12:00:00.000+09:00"},"inflowType":{"type":"string","description":"유입 경로","enum":["API,APP_AND,APP_IOS,WEB_MOBILE,WEB_PC,EXCEL,LINK,MIGRATED"],"example":"API"},"inflowTypeName":{"type":"string","description":"유입 경로명","enum":["API,안드로이드 앱,아이폰 앱,모바일 웹,PC 웹,엑셀,링크,2.0등록"],"example":"API"},"fromName":{"type":"string","description":"보내는 분 이름","example":"홍길동"},"fromPhoneNumber":{"type":"string","description":"보내는 분 연락처","example":"01011110000"},"fromZipCode":{"type":"string","description":"보내는 분 우편번호 ","example":"06095"},"fromAddr1":{"type":"string","description":"보내는 분 주소1","example":"서울 강남구 봉은사로 479"},"fromAddr2":{"type":"string","description":"보내는 분 주소2","example":"479타워 16층 굿스플로"},"toName":{"type":"string","description":"받는 분 이름","example":"임꺽정"},"toPhoneNumber":{"type":"string","description":"받는 분 연락처","example":"01011110000"},"toZipCode":{"type":"string","description":"받는 분 우편번호","example":"07988"},"toAddr1":{"type":"string","description":"받는 분 주소1","example":"서울 양천구 목동서로 117"},"toAddr2":{"type":"string","description":"받는 분 주소2","example":"2층 굿스코아"},"boxCount":{"type":"integer","format":"int32","description":"박스 수량","example":1},"itemName":{"type":"string","description":"폴로셔츠","example":1},"itemPrice":{"type":"integer","format":"int32","description":"상품가격","example":50000},"itemQuantity":{"type":"integer","format":"int32","description":"상품수량(박스 1개에 담긴 수량)","example":1},"boxType":{"type":"string","description":"박스 타입","enum":["XSMALL,SMALL,MEDIUM,LARGE"],"example":"MEDIUM"},"boxTypeName":{"type":"string","description":"박스 타입명","enum":["극소형,소형,중형,대형"],"example":"중형"},"boxCost":{"type":"integer","format":"int32","description":"박스가격","example":5000},"addedCost":{"type":"integer","format":"int32","description":"추가요금(도선료 등)","example":2000},"transporter":{"type":"string","description":"배송사 코드","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"HOMEPICK"},"transporterInvoiceNo":{"type":"string","description":"배송사 송장번호","example":160008817396},"relayTransporter":{"type":"string","description":"연계배송사 코드","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"HANJIN"},"relayTransporterInvoiceNo":{"type":"string","description":"연계배송사 운송장번호","example":510684846125},"currentDriverName":{"type":"string","description":"현재(최종) 기사명","example":"강배달"},"currentDriverPhoneNumber":{"type":"string","description":"현재(최종) 기사 연락처","example":"01011110000"},"currentTransporterInvoiceNo":{"type":"string","description":"현재(최종) 운송장번호","example":510684846125},"currentTransporter":{"type":"string","description":"현재(최종) 배송사 코드","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"HANJIN"},"currentTransporterTelephoneNumber":{"type":"string","description":"현재(최종) 배송사 연락처","enum":["HANJIN,CUHOME,EPOST,CJGLS"],"example":"07000000000"},"orderStatusHistoryList":{"type":"array","description":"주문상태 이력 리스트","items":{"$ref":"#/components/schemas/OrderStatusHistoryItemDTO"}},"costChangeHistory":{"type":"array","description":"추가요금 이력 리스트","items":{"$ref":"#/components/schemas/OrderBoxCostChangeHistoryDTO"}},"driverLocationUrl":{"type":"string","description":"기사 위치 url"},"photoUrl":{"type":"string","description":"사진 url"},"currentTransporterInfoFrom":{"$ref":"#/components/schemas/TransporterInfo","writeOnly":true}}},"OrderStatusHistoryItemDTO":{"type":"object","description":"주문 종적 응답-data","properties":{"orderStatus":{"type":"string","description":"주문 상태","enum":["RESERVED","RESERVED_CANCELED","RECEIVED","TRANSFERRED","ALLOCATED","PICKUP_START","PICKUP_FAILED","PICKUP","MOVING","DLV_START","WAYPOINT_ARRIVAL","COMPLETED","CANCELED"],"example":"PICKUP_START"},"orderStatusName":{"type":"string","description":"주문 상태명","enum":["예약","예약취소","접수완료","이관","배차","픽업출발","미픽업","픽업완료","이동중","배송출발","경유지도착","배송완료","취소"],"example":"픽업출발"},"statusDateTime":{"type":"string","format":"date-time","description":"상태일시","example":"2021-07-23T08:00:00.000+09:00"},"location":{"type":"string","description":"현재 위치(지점)","example":"강남논현"},"tmsStatusName":{"type":"string","description":"배송사 상태명","example":"배송중(출고)"},"driverName":{"type":"string","description":"기사명","example":"홍길동"},"driverPhoneNumber":{"type":"string","description":"기사 연락처","example":"01011110000"},"reasonType":{"type":"string","description":"사유(픽업/배송)","example":"RECEIVER_REFUSE"},"reasonTypeName":{"type":"string","description":"사유텍스트","example":"수취거부"},"contents":{"type":"string","description":"사유내용","example":"수취거부"},"photoUrl":{"type":"string","description":"사진","example":"사진"},"driverLocationUrl":{"type":"string","description":"기사위치","example":"기사위치"}}},"TransporterInfo":{"type":"object","properties":{"transporter":{"type":"string","enum":["HOMEPICK","HOMEPICK3","TODAY","EPOST","HANJIN","CJGLS","LOTTE","LOGEN","CUHOME","SEVENELEVEN","RETURNALL","DVER","GOGOX","INSUNG"]},"name":{"type":"string"},"telephoneNumber":{"type":"string"},"addedCostCalculateTransporter":{"type":"string","enum":["HOMEPICK","HOMEPICK3","TODAY","EPOST","HANJIN","CJGLS","LOTTE","LOGEN","CUHOME","SEVENELEVEN","RETURNALL","DVER","GOGOX","INSUNG"]},"costToIsland":{"type":"integer","format":"int32"},"costFromIsland":{"type":"integer","format":"int32"},"costToJeju":{"type":"integer","format":"int32"},"costFromJeju":{"type":"integer","format":"int32"},"costToJejuIsland":{"type":"integer","format":"int32"},"costFromJejuIsland":{"type":"integer","format":"int32"}}},"JFSTms3InvoicePrintProperties":{"type":"object","description":"오늘도착 송장 필요정보 조회","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/Tms3InvoicePrintPropertiesDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"Tms3InvoicePrintPropertiesDTO":{"type":"object","properties":{"invoiceNo":{"type":"string","description":"송장번호"},"sortCode":{"type":"string","description":"분류코드"},"guDong":{"type":"string","description":"구동"},"fromAddress1":{"type":"string","description":"보내는 분 주소1"},"fromAddress2":{"type":"string","description":"보내는 분 주소2"},"fromZipCode":{"type":"string","description":"보내는 분 우편번호"},"fromName":{"type":"string","description":"보내는 분 이름"},"fromPhoneNumber":{"type":"string","description":"보내는 분 전화번호"},"toAddress1":{"type":"string","description":"받는 분 주소1"},"toAddress2":{"type":"string","description":"받는 분 주소2"},"toZipCode":{"type":"string","description":"받는 분 우편번호"},"toName":{"type":"string","description":"받는 분 이름"},"toPhoneNumber":{"type":"string","description":"받는 분 전화번호"},"memo":{"type":"string","description":"메모"},"itemName":{"type":"string","description":"상품명"},"dawnDelivery":{"type":"boolean","description":"새벽도착 여부"},"orderDate":{"type":"string","description":"배송수행일"}}},"JFSTms3AvailableAddressCheckDTO":{"type":"object","description":"오늘도착 가능지역 확인","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"$ref":"#/components/schemas/Tms3AvailableAddressCheckDTO"},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"Tms3AvailableAddressCheckDTO":{"type":"object","properties":{"address":{"type":"string","description":"주소"},"available":{"type":"boolean","description":"배송가능 여부"},"zipcode":{"type":"string","description":"우편번호"}}},"DisabledDeliveryAreaDTO":{"type":"object","description":"택배사터미널정보","properties":{"zipCode":{"type":"string","description":"우편번호","example":15476},"terminalCode":{"type":"string","description":"터미널코드","example":451},"terminalName":{"type":"string","description":"터미널명","example":"상록"},"modifiedDateTime":{"type":"string","description":"데이터 갱신일시","example":"2022-04-12 10:00"}}},"JFSDisabledDeliveryAreaDTOList":{"type":"object","description":"택배사 배송불가지역 목록 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DisabledDeliveryAreaDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"BoxTypeDTO":{"type":"object","description":"박스타입","properties":{"boxType":{"type":"string","description":"박스타입","example":"SMALL"},"boxTypeName":{"type":"string","description":"박스타입명","example":"소형"},"weight":{"type":"integer","format":"int32","description":"무게","example":5000},"volume":{"type":"integer","format":"int32","description":"3변합","example":100},"cost":{"type":"integer","format":"int32","description":"금액","example":5000},"accountGroupCost":{"type":"boolean","description":"기업요금여부","example":true},"accountGroupName":{"type":"string","description":"기업명","example":"굿스플로"}}},"JFSAvailableDeliveryTypeDTOBoxTypeDTOList":{"type":"object","description":"요금정보 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BoxTypeDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"CodeResponseDTO":{"type":"object","description":"코드 목록 응답-data","properties":{"code":{"type":"string","description":"코드","example":"코드"},"description":{"type":"string","description":"설명","example":"설명"}}},"JFSCodeResponseDTOList":{"type":"object","description":"코드 목록 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CodeResponseDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"ApiCompanyDeliveryServiceBoxSettingDTO":{"type":"object","description":"API접수 가능 유형-박스","properties":{"boxType":{"type":"string","description":"박스타입","example":"MEDIUM"},"boxTypeName":{"type":"string","description":"박스타입명","example":"중형"},"volume":{"type":"integer","format":"int32","description":"박스부피","example":120},"weight":{"type":"integer","format":"int32","description":"박스중량(Kg)","example":5}}},"ApiCompanyDeliveryServiceSettingDTO":{"type":"object","description":"API접수 가능 유형","properties":{"serviceCode":{"type":"string","description":"서비스코드","example":"HANJIN_C"},"deliveryType":{"type":"string","description":"배송유형","example":"D_SHIPPING"},"deliveryTypeName":{"type":"string","description":"배송유형명","example":"일반택배"},"transporter":{"type":"string","description":"배송사코드","example":"HANJIN"},"transporterName":{"type":"string","description":"배송사명","example":"한진택배"},"boxList":{"type":"array","description":"박스목록","items":{"$ref":"#/components/schemas/ApiCompanyDeliveryServiceBoxSettingDTO"}}}},"JFSApiCompanyDeliveryServiceSettingDTOList":{"type":"object","description":"API접수 가능 유형 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiCompanyDeliveryServiceSettingDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"AvailablePickupDateTimeDTO":{"type":"object","description":"픽업예약시간 조회 응답-data","properties":{"availableDate":{"type":"string","description":"서비스 가능일","example":"2022-05-29"},"availableTimeList":{"type":"array","description":"서비스 가능 트랙 리스트","items":{"$ref":"#/components/schemas/AvailablePickupTimeDTO"}}}},"AvailablePickupTimeDTO":{"type":"object","description":"트랙 시작-종료 시간 응답-data","properties":{"receiptDeadlineDateTime":{"type":"string","description":"접수 마감 시간","example":"08:00"},"availableTimeFrom":{"type":"string","description":"트랙 시작 시간","example":"09:00"},"availableTimeTo":{"type":"string","description":"트랙 종료 시간","example":"13:00"},"enabled":{"type":"boolean","description":"접수 가능 여부 - 현재는 접수 마감시간과 현재 시각만 비교 처리","example":true}}},"JFSAvailablePickupDateTimeDTOList":{"type":"object","description":"픽업예약시간 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailablePickupDateTimeDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"AvailableDeliveryTypeSimpleDTO":{"type":"object","description":"배송종류 조회 응답-data","properties":{"deliveryType":{"type":"string","description":"배송종류","enum":["D_SHIPPING","D_CONVENIENCE","D_PICKUP","D_QUICK","D_CARGO","D_TODAY_P","D_TODAY_D","D_TODAY_PD"]},"transporter":{"type":"string","description":"택배사코드","enum":["HOMEPICK","HOMEPICK3","TODAY","EPOST","HANJIN","CJGLS","LOTTE","LOGEN","CUHOME","SEVENELEVEN","RETURNALL","DVER","GOGOX","INSUNG"]},"available":{"type":"boolean","description":"이용가능여부"},"addedCost":{"type":"integer","format":"int32","description":"추가요금"}}},"JFSAvailableDeliveryTypeSimpleDTOList":{"type":"object","description":"배송종류 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDeliveryTypeSimpleDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}},"AvailableDeliveryTypeSimpleWithPickupDateTimeDTO":{"type":"object","properties":{"deliveryType":{"type":"string","description":"배송종류","enum":["D_SHIPPING","D_CONVENIENCE","D_PICKUP","D_QUICK","D_CARGO","D_TODAY_P","D_TODAY_D","D_TODAY_PD"]},"transporter":{"type":"string","description":"택배사코드","enum":["HOMEPICK","HOMEPICK3","TODAY","EPOST","HANJIN","CJGLS","LOTTE","LOGEN","CUHOME","SEVENELEVEN","RETURNALL","DVER","GOGOX","INSUNG"]},"available":{"type":"boolean","description":"이용가능여부"},"addedCost":{"type":"integer","format":"int32","description":"추가요금"},"availableDateTimeList":{"type":"array","description":"픽업예약시간 목록","items":{"$ref":"#/components/schemas/AvailablePickupDateTimeDTO"}}}},"JFSAvailableDeliveryTypeSimpleWithPickupDateTimeDTOList":{"type":"object","description":"배송종류(상세) 조회 응답","properties":{"success":{"type":"boolean","description":"성공여부","example":true},"message":{"type":"string","description":"메시지","example":"오류가 있을 경우 오류 메시지"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDeliveryTypeSimpleWithPickupDateTimeDTO"}},"responseDateTime":{"type":"string","format":"date-time","description":"응답 서버 시간","example":"2022-05-27T14:45:13.051+09:00"}}}},"securitySchemes":{"ApiKey":{"type":"apiKey","description":"발급된 API 키","name":"Authorization","in":"header"}}}}