배송지시목록조회 APIShipping Instructed List Search API
정책 및 프로세스 Policy & Process
1. 배송진행상태가 배송지시인 주문을 조회 가능합니다
2. 주문완료 시 배송진행상태 배송지시로 배송데이터가 생성됩니다
3. 아직 결제가 완료되지 않은 주문(입금대기)은 대기 상태로 조회되며 결제 후 정상으로 전환됩니다
4. 배송지시일, 주문완료일, *출고예정일 기준으로 최대 180일까지 조회 가능합니다
1. Search for Shipping Instructed Order.
2. When completing orders, shipping data will be created to Shipping Instructed List.
3. Payment On Hold is searched as ‘Hold’ and after paying, it will be changed as ‘Normal’.
4. Exchange Release Item is searched as ‘Hold’ and after completing collection, it will be changed as ‘Normal’.
5. Based on Shipping Instructed Date, Order Completed Date and Release Scheduled Date, you can search until maximum 180 days.
* 출고예정일: 0시~4시에 들어온 주문은 당일, 4시~0시에 들어온 주문은 익일로 출고예정일이 셋팅됩니다
* Release Scheduled Date: Orders (12am to 3.59am) are set as ‘Day’.Orders (4am to 11.59pm) are set as ‘Day After’.
기본설명 Description
접수된 주문을 조회하는 API입니다
각 항목별 필수값을 넣지 않으면 오류메시지가 발생하니, 각 항목별 필수사항을 체크해주세요
Search for registered orders.
Check essential points since error message can occur regardless of essential values.
API 상세 항목 API Details
URL : /api/pd/{version}/listShppDirection.ssg
Method : POST
URL : /api/pd/{version}/listShppDirection.ssg
Method : POST
RequestHeader :
| 이름 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |
|---|---|---|---|---|---|
| Authorization | String | Y | 업체 인증키 Vendor API Authentication Key | - | |
| Accept | string | Y |
application/xml application/json application/xml application/json |
- | |
RequestURI :
| 이름 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |
|---|---|---|---|---|---|
| version | String | Y | 1 고정 1 fix | - | |
RequestParameter :
| 이름 Property | 타입 PropertyType | 필수 여부 Required | 설명 Description | 수정일 UpdateDate | |||||
|---|---|---|---|---|---|---|---|---|---|
| requestShppDirection | OBJECT | Y | - | ||||||
| perdType | String | Y |
기간타입, 일반조회일 경우 필수 값 01 배송지시일 02 주문완료일 03 출고예정일 If general search, then mandatory value. 01 Shipping Instructed Date 02 Order Completed Date 03 Release Scheduled Date |
- | |||||
| perdStrDts | Date | Y |
기간시작일, 일반조회일 경우 필수 값. 기간은 180일 이내 If general search, then mandatory value. Period is within 180 days |
- | |||||
| perdEndDts | Date | Y |
기간종료일, 일반조회일 경우 필수 값. 기간은 180일 이내 If general search, then mandatory value. Period is within 180 days |
- | |||||
| commType | String | Y |
빠른조회타입, 빠른조회일 경우 필수 값 01 원주문번호 02 배송번호 If general search, then mandatory value. 01 Original Order Number 02 Shipping Number" |
- | |||||
| commValue | String | Y |
빠른조회값, 빠른조회일 경우 필수 값 If quick search, then mandatory value. |
- | |||||
| shppDivDtlCd | String | N |
배송구분상세코드 11 일반출고 12 부분출고 14 재배송 15 교환출고 16 AS출고 Release Type 11 General Release 12 Partial Release 14 Re-shipping 15 Exchange Release 16 AS Release |
- | |||||
| shppStatCd | String | N |
배송상태코드 10 정상 30 대기 Shipping Status Code 10 Normal 30 On Hold |
- | |||||
| rsvtItemYn | String | N |
예약판매여부 Y/N Sales By Subscription Yes Or No Y/N |
- | |||||
| frgShppYn | String | N |
국내/외 구분 Y/N Domestic Or International Yes Or No Domestic : N International : Y |
- | |||||
| reOrderYns | String | N |
재지시여부 구분 Y/N Reinstruct Yes Or No Reinstruct : Y Not Reinstruct : N |
- | |||||
| itemNm | String | N | 상품명 Item Name | - | |||||
| itemDiv | String | N |
주문상품구분코드 10 일반 20 명절 GIFT 일반 30 명절 GIFT 센터 40 명절 GIFT 냉장 Order Item Division Code 10:General 20: Holiday GIFT General 30: Holiday GIFT Center 40: Holiday GIFT Refrigerate |
- | |||||
| itemId | String | N | 상품번호 Item Number | - | |||||
| splVenItemId | String | N | 협력업체상품ID Vendor Item Number | - | |||||
| rcptpeNm | String | N | 수취인 Recipient | - | |||||
| ordpeNm | String | N | 주문자 Customer | - | |||||
| mbrId | String | N | 주문자ID Customer ID | - | |||||
| mallTypeCd | String | N |
몰유형코드 10: 종합몰 20: 오픈마켓 Mall Type 10: general mall 20: open market |
2021-04-20 | |||||
| ordTypeCd06Yn | String | N |
선물하기 주문여부 Y/N GiftItem OrderType Yes Or No Y/N |
2021-08-04 | |||||
| ordItemCertNoYn | String | N |
개런티 주문여부 Y/N GuaranteeItem OrderType Yes Or No Y/N |
2021-08-04 | |||||
ResponseBody :
| 항목 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |||
|---|---|---|---|---|---|---|---|
| resultCode | String | Y | 결과 코드 Result Code | - | |||
| resultMessage | String | Y | 결과 값 Result Message | - | |||
| resultDesc | String | Y | 오류 메시지 Error Message | - | |||
| shppDirections | LIST | - | |||||
| shppDirection | Object | - | |||||
| ordNo | String | 주문번호 Order Number | - | ||||
| ordItemSeq | int | N | 주문순번 Order Sequence | - | |||
| String | 이전주문번호 Previous System Order Number |
2022-12-07 (삭제) 2022-12-07 (deleted) |
|||||
| int | N | 이전시스템주문순번 Previous System Order Sequence |
2022-12-07 (삭제) 2022-12-07 (deleted) |
||||
| String | N | 원주문번호 (2022.1.5 삭제. 'orordNo'를 사용해주세요) Original Order Number (2022.1.5 deleted. Please use 'orordNo') |
2022-01-05 (삭제) 2022-01-05 (deleted) |
||||
| orordNo | String | N | 원주문번호 Original Order Number |
2022-01-05 (추가) 2022-01-05 (added) |
|||
| orordItemSeq | String | N | 원주문상품순번 Original Order Item Sequence | - | |||
| shppNo | String | N | 배송번호 Shipping Number | - | |||
| shppSeq | String | N | 배송순번 Shipping Sequence | - | |||
| ordStatCd | String | N | 주문상태코드 Order Status Code | - | |||
| shppStatCd | String | N |
배송상태코드 10 정상 30 대기 Shipping Status Code 10 Normal 30 On Hold |
- | |||
| shppStatNm | String | N | 배송상태명 Shipping Status Name | - | |||
| shppDivDtlCd | String | N |
배송구분상세코드 11 일반출고 12 부분출고 14 재배송 15 교환출고 16 AS출고 Release Type 11 General Release 12 Partial Release 14 Re-shipping 15 Exchange Release 16 AS Release |
- | |||
| shppDivDtlNm | String | N | 배송구분상세명 Release Type Name | - | |||
| ordRcpDts | Date | N | 주문접수일시 Order Registered Date | - | |||
| ordCmplDts | Date | N | 주문완료일시 Order Completed Date | - | |||
| siteNo | String | N |
사이트번호 6001 이마트몰 6002 트레이더스 6004 신세계몰 6005 SSG.COM 6009 신세계백화점 6100 howdy 6200 신세계TV쇼핑 6300 S.I.VILLAGE 7008 프리미엄아울렛 7011 까사미아 7012 CHICOR 7013 tr,iip 7014 오픈마켓 7015 스타벅스 7019 SSG랜더스 Site Number 6001 emart Mall 6002 TRADERS 6004 Shinsegae Mall 6005 SSG.COM 6009 Department Store 6100 howdy 6200 TV Shopping 6300 S.I.VILLAGE 7008 PREMIUM OUTLETS 7011 casamia 7012 CHICOR 7013 tr,iip 7014 OpenMarket 7015 Starbucks 7019 SSG Landers |
6003 분스몰 2020-04-27 (Deleted) 7015 스타벅스 7019 SSG랜더스 2023-09-06 (Added) 6003 BOONS Mall 2020-04-27 (Deleted) 7015 Starbucks 7019 SSG Landers 2023-09-06 (Added) |
|||
| shppVenId | String | N | 공급업체아이디 Supply Vendor Identification |
2023-05-03 (추가) 2023-05-03 (added) |
|||
| shppVenNm | String | N | 공급업체명 Supply Vendor Name |
2023-05-03 (추가) 2023-05-03 (added) |
|||
| shppLrnkVenId | String | N | 하위공급업체아이디 Low Rank Supply Vendor Identification |
2023-05-03 (추가) 2023-05-03 (added) |
|||
| shppLrnkVenNm | String | N | 하위공급업체명 Low Rank Supply Vendor Name |
2023-05-03 (추가) 2023-05-03 (added) |
|||
| ordShpplocId | int | N | 주문배송지ID Order Shipping Address Identification | - | |||
| shppTypeDtlCd | String | N |
배송유형상세코드 14 업체자사배송 22 업체택배배송 25 해외택배배송 31 매장방문 41 등기 51 SMS 52 EMAIL 61 미발송 91 업체프리미엄 Shipping Type Detail 14 Vendor's In-House Shipping 22 Vendor Shipping 25 International Shipping 31 In-Store Visit 41 Mail 51 SMS 52 EMAIL 61 Not Shipped 91 Premium Shipping |
- | |||
| shppProgStatDtlCd | String | N |
상세배송상태 11 배송지시 21 피킹지시 22 피킹완료 31 패킹완료 41 출고대기 42 출고보류 43 출고완료 51 배송완료 52 배송거절 Detail Shipping Process Status 11 Shipping Instructed 21 Picking Instructed 22 Picking Completed 31 Packing Completed 41 Release On Hold 42 Release Delayed 43 Release Completed 51 Shipping Completed 52 Shipping Rejected |
- | |||
| shppRsvtDt | String | N | 출고예정일자 Release Scheduled Date | - | |||
| shppItemDivCd | String | N |
배송상품구분코드 01 : 일반 02 : 해외구매대행 03 : 설치(유료) 04 : 설치(무료) 05 : 주문제작 06 : 해외직배송 Shipping Item Type 01 : Normal 02 : Overseas Purchasing 03 : Paid Installation 04 : Free Installation 05 : Custom Made Products 06 : International Shipping |
2020-03-11 added |
|||
| itemNm | String | N | 상품명 Item Name | - | |||
| itemId | String | - | 상품번호 Item Number | commCd:I070 | |||
| uitemId | String | N | 단품ID Unit Item Identification | - | |||
| uitemNm | String | N | 단품명 Unit Item Name | - | |||
| splVenItemId | String | N | 협력업체상품ID Vendor Item Number | - | |||
| uSplVenItemId | String | N | 협력업체단품ID Vendor Unit Item Number | - | |||
| mdlNm | String | N | 모델명 Model Name | - | |||
| frebieNm | String | N | 사은품 Free Gifte | - | |||
| rsvtItemYn | String | N |
예약판매여부
Sales By Subscription Order Yes Or No Y: Sales By Subscription / N: Not Sales By Subscription |
- | |||
| frgShppYn | String | N |
국내/외 구분 Y/N Domestic Or International Yes Or No Domestic : N International : Y |
- | |||
| dircItemQty | int | N | 지시수량 Instructed Quantity | - | |||
| cnclItemQty | int | N | 취소수량 Canceled Quantity | - | |||
| ordQty | int | N | 주문수량 Order Quantity | - | |||
| splprc | int | N | 공급가 Supply Price | - | |||
| sellprc | int | N | 판매가 Sales Price | - | |||
| rlordAmt | int | N |
결제가 * 해당 항목은 배송을 위한 참고 정보입니다. 정산을 위해서는 정산 API를 활용해주세요. Real Order Amount * This is reference information for Shipping. Please use Settlement API for an accurate settlement. |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| dcAmt | int | N |
할인가 * 해당 항목은 배송을 위한 참고 정보입니다. 정산을 위해서는 정산 API를 활용해주세요. Discount Amount * This is reference information for Shipping. Please use Settlement API for an accurate settlement. |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| ordpeNm | String | N | 주문자 Customer | - | |||
| ordpeHpno | String | N | 주문자 휴대폰번호 Customer Mobile Phone Number | - | |||
| rcptpeNm | String | N | 수취인 Recipient | - | |||
| shpplocAddr | String | N | 수취인 지번주소 Recipient Land Lot Number Address | - | |||
| shpplocZipcd | String | N | 수취인 우편번호 Recipient Postal Code | - | |||
| shpplocOldZipcd | String | N | 수취인 구우편번호(6자리) Recipient Old Postal Code (6digits) | - | |||
| rcptpeHpno | String | N | 수취인 휴대폰번호 Recipient Mobile Phone Number | - | |||
| rcptpeTelno | String | N | 수취인 집전화번호 Recipient Phone Number | - | |||
| shppcst | int | N | 배송비 Shipping Cost | 2020-05-20 (배송비 총합으로 변경) 2020-05-20 (Changed to the total shipping cost) | |||
| ordCstId | String | N | 주문비용아이디 Order Cost Identification | - | |||
| ordCstOccCd | String | N |
주문비용발생코드 01: 부과 02: 부과취소 Shipping Cost Cash On Delivery Yes Or No 01:Charge 02:Waive |
- | |||
| shppcstId | String | N | 배송비정책아이디 Shipping Cost Policy Identification | - | |||
| shppcstCodYn | String | N |
배송비 착불여부 Y: 착불 N: 선불 Shipping Cost Cash On Delivery Yes Or No Y: Cash On Delivery N: Prepaid" |
- | |||
| ordMemoCntt | String | N | 고객배송메모 Customer Shipping Memo | - | |||
| memoCntt | String | N | 배송업무메모 Shipping Company Memo | - | |||
| shortgProgStatCd | String | N |
판매불가신청상태 11 결품등록 12 결품CS처리중 13 결품확정 21 상품정보오류등록 22 상품정보오류CS처리중 23 상품정보오류확정 41 입고지연등록 43 입고지연완료 51 배송지연등록 Sales Not Permitted Status 11 Shortage Of Stock Registered 12 Shortage Of Stock CS Processing 13 Shortage Of Stock Confirmed 21 Item Information Error Registered 22 Item Information Error CS Processing 23 Item Information Error Confirmed 41 Stock Delay Registered 43 Stock Delay Completed 51 Shipping Delay Registered |
- | |||
| ordpeRoadAddr | String | N | 수취인 도로명주소 Recipient Road Name Address | - | |||
| bookCpnNo | String | N | 인터파크도서 : 도서쿠폰번호 Interpark Books : Book Coupon Number | - | |||
| bookCpnDcAmt | int | N | 인터파크도서 : 도서쿠폰할인금액 Interpark Books : Book Coupon Discount Fee | - | |||
| pCus | String | N | 개인통관고유번호 Personal Serial Number For Customs | 2022-05-18 | |||
| allnOrdNo | int | N | 제휴주문번호 Alliance Order Number | - | |||
| reOrderYn | int | N | 재지시여부구분 Reinstruct Yes Or No | - | |||
| itemDiv | String | N |
주문상품구분코드 10:일반 20: 명절 GIFT 일반 30: 명절 GIFT 센터 40: 명절 GIFT 냉장 Order Item Division Code 10:General 20: Holiday GIFT General 30: Holiday GIFT Center 40: Holiday GIFT Refrigerate |
- | |||
| shpplocBascAddr | String | N |
수취인 행정구역 + 도로명 + 건물번호 (도로명 주소가 없는 경우 지번 기본 주소) Recipient Administrative District + Street Name + Building Number (If there is no road name address, the land lot number basic address is returned.) |
2017-07-12 | |||
| shpplocDtlAddr | String | N |
수취인 도로명 상세주소 (도로명 주소가 없는 경우 지번 상세 주소) Recipient Road Name Detail Address (If there is no road name address, the land lot number detail address is returned.) |
2017-07-12 | |||
| ordItemDivNm | String | N | 주문상품구분 Order Item Division | 2017-08-09 | |||
| autoShortgYn | String | N | 자동결품예정여부 Scheduled to automatically sell out | 2018-05-01 | |||
| whoutCritnDt | String | N | 출고기준일 Deadline of Retrieval (Date) | 2018-05-01 | |||
| whddDivCd | String | N |
출고일구분코드 10: 오늘출발 Forwarding date classification code 10: one-day shipping |
2021-04-20 | |||
| mallTypeCd | String | N |
몰유형코드 10: 종합몰 20: 오픈마켓 Mall Type 10: general mall 20: open market |
2021-04-20 | |||
| ordTypeCd06Yn | String | N |
선물하기 주문여부 Y/N GiftItem OrderType Yes Or No Y/N |
2021-08-04 | |||
| ordItemCertNoYn | String | N |
개런티 주문여부 Y/N GuaranteeItem OrderType Yes Or No Y/N |
2021-08-04 | |||