구매관리에서 조건(기간/주문번호/상품번호/상태 등)에 맞는 주문서 목록을 조회하는 API입니다.
권장 ver: 4.0
Mode: getOrderList
Method: GET
Endpoint: https://domeggook.com/ssl/api/
Request Example:
https://domeggook.com/ssl/api/?ver=4.0&mode=getOrderList&aid={API_KEY}&id={USER_ID}&sId={SESSION_ID}&for=buy&om=json
순서 | 항목(자료형, 필수여부) | 설명 |
1 | ver (string,Y) | API Version: 4.0 |
2 | mode (string,Y) | API 호출 모드값 : getOrderList |
3 | aid (string,Y) | API KEY |
4 | id (string,Y) | 회원 아이디 |
5 | sId (string,Y) | 로그인 API 호출로 발급되는 sId |
6 | day (int,N) | 조회기간(최근 n일)을 정수로 입력 (최대 365일) ※ 미입력 시, default value: 30 |
7 | for (string,Y) | 구매관리 주문서 조회 시 "buy" 입력 |
8 | no (int,N) | 주문서 번호(OR을 제외한 숫자만 입력) |
9 | uid (string,N) | 주문서 UID |
10 | itemNo (int,N) | 상품번호 |
11 | st (string,N) | - 주문상태(한글), 아래 상태 값 중 입력: 입금예정 / 승인대기 / 승인취소/ 결제완료 / 배송준비중 / 배송준비중취소 / 배송중 / 배송완료 / 구매종료 / 구매취소 / 판매취소 / 반품중 ※ 배송준비중취소: 배송준비중 주문서가 취소 요청된 상태의 주문서 ※ 구매종료: 구매자가 직접 구매확정 또는 자동 구매확정 이후의 주문서 |
12 | pg (int,N) | 페이지 번호 |
13 | ic (int,N) | 페이지 당 출력 개수 |
14 | oe (string,N) | 출력 인코딩 (utf-8, euc-kr) |
15 | om (string,Y) | 출력형식 : xml / json |
순서 | 항목 | 자료형 | 설명 |
|---|---|---|---|
1 | header.numberOfItems | int | 총 상품 개수 |
2 | header.currentPage | int | 현재 페이지 번호 |
3 | header.firstItem | int | 시작 상품 번호 |
4 | header.lastItem | int | 마지막 상품 번호 |
5 | header.itemsPerPage | int | 현재 페이지에 출력되는 상품 개수 |
6 | header.numberOfPages | int | 페이지의 총 개수 |
7 | items.orderNo | int | 주문번호 |
8 | items.orderUid | string | 주문 uid |
9 | items.status | string | - 주문상태(한글)입금예정 / 승인대기 / 승인취소/ 결제완료 /배송준비중 / 배송준비중취소 / 배송중 / 배송완료 / 적립예정판매종료 / 구매종료/ 구매취소 / 판매취소 / 반품중 |
10 | items.itemNo | int | 상품번호 |
11 | items.itemTitle | string | 상품명 |
12 | items.market | string | 상품유형 |
13 | items.itemImage150 | string | 썸네일 URL (가로세로 150픽셀) |
14 | items.itemImage075 | string | 썸네일 URL (가로세로 75픽셀) |
15 | items.itemImage150png | string | 썸네일 PNG URL (가로세로 150픽셀) |
16 | items.itemImage075png | string | 썸네일 PNG URL (가로세로 75픽셀) |
17 | items.orderQty | int | 주문수량 |
18 | items.orderAmt | int | 주문금액 |
19 | items.orderAmtPay | int | 상품금액 (배송비 제외) |
20 | items.date | string | 주문일시 (yyyy-mm-dd hh:ii:ss) |
순서 | 항목(자료형, 필수여부) | 설명 |
1 | ver (string,Y) | API Version: 2.0 |
2 | mode (string,Y) | API 호출 모드값 : getOrderList |
3 | aid (string,Y) | API KEY |
4 | id (string,Y) | 회원 아이디 |
5 | sId (string,Y) | 로그인 세션 아이디 |
6 | day (int,N) | 조회기간(최근 n일)을 정수로 입력 (최대 365일) ※ 미입력시 전체조회 |
7 | for (string,Y) | 구매자용은 "buy"를 입력 |
8 | view (string,Y) | 상세정보 : detail, 간략정보 : list |
9 | no (int,N) | 주문서 번호 |
10 | itemNo (int,N) | 상품번호 |
11 | pg (int,N) | 페이지 넘버 |
12 | ic (int,N) | 페이지 당 출력 개수 |
13 | oe (string,N) | 출력 인코딩 (utf-8, euc-kr) |
14 | om (string,Y) | 출력형식 : xml / json |
순서 | 항목 | 자료형 | 설명 |
|---|---|---|---|
1 | header.numberOfItems | int | 총 상품 개수 |
2 | header.currentPage | int | 현재 페이지 번호 |
3 | header.firstItem | int | 시작 상품 번호 |
4 | header.lastItem | int | 마지막 상품 번호 |
5 | header.itemsPerPage | int | 현재 페이지에 출력되는 상품 개수 |
6 | header.numberOfPages | int | 페이지의 총 개수 |
7 | items.orderNo | int | 주문번호 |
8 | items.orderUid | string | 주문 uid |
9 | items.orderQty | int | 주문수량 |
10 | items.orderAmtPay | int | 주문금액 |
11 | items.orderAmount | int | 상품금액 (배송비 제외) |
12 | items.supplyAmount | int | 공급가 금액 (위탁판매 주문서에서만 표시) |
13 | items.ceilAmount | int | 단수조정 금액 (위탁판매 주문서에서만 표시) |
14 | items.status | string | 주문상태 (한글이름) |
15 | items.statusMode | string | 주문상태 (코드)WAITPAY : 입금예정WAITCONFIRM : 승인대기WAITDELI : 발송예정WAITOK : 배송중DONE : 구매종료DENYCONFIRM : 승인취소DENYBUY : 구매취소DENYSELL : 판매취소BACK : 반품중 |
16 | items.item.no | int | 상품번호 |
17 | items.item.title | string | 상품제목 |
18 | items.item.section | string | SELL : 일반판매SHOP : 위탁판매 |
19 | items.item.market | string | 상품유형 |
20 | items.item.img150 | string | 썸네일 URL (가로세로 150픽셀) |
21 | items.item.img075 | string | 썸네일 URL (가로세로 75픽셀) |
22 | items.item.img150png | string | 썸네일 PNG URL (가로세로 150픽셀) |
23 | items.item.img075png | string | 썸네일 PNG URL (가로세로 75픽셀) |
24 | items.item.itemCustomCode | string | 공급사 상품코드 |
25 | items.pay.payAmount | string | 총결제금액 |
26 | items.pay.method | string | 결제방법 |
27 | items.pay.bankInfo | string | 입금정보 (가상계좌 결제시) |
28 | items.pay.cardInfo | string | 카드정보 (카드결제시) |
29 | items.pay.cardInstallment | string | 할부개월수 (카드결제시) |
30 | items.pay.datePay | string | 결제일시 |
31 | items.sellerInfo.sellerId | string | 판매자 ID |
32 | items.sellerInfo.sellerName | string | 판매자 이름 |
33 | items.sellerInfo.sellerNick | string | 판매자 닉네임 |
34 | items.sellerInfo.sellerMail | string | 판매자 메일 |
35 | items.sellerInfo.sellerPhone | string | 판매자 전화번호 |
36 | items.sellerInfo.sellerMobile | string | 판매자 휴대전화 |
37 | items.sellerInfo.authorId | string | 실판매자 ID (위탁판매 주문서에서만 표시) |
38 | items.buyerInfo.buyerId | string | 구매자 ID |
39 | items.buyerInfo.buyerName | string | 구매자 이름 |
40 | items.buyerInfo.buyerBuyRank | int | 구매자 구매등급 (1~9) |
41 | items.buyerInfo.buyerBuyScore | int | 구매자 구매점수 |
42 | items.buyerInfo.buyerMail | string | 구매자 메일 |
43 | items.buyerInfo.buyerZipcode | string | 구매자 우편번호 |
44 | items.buyerInfo.buyerAddress | string | 구매자 주소 |
45 | items.buyerInfo.buyerPhone | string | 구매자 전화번호 |
46 | items.buyerInfo.buyerMobile | string | 구매자 휴대전화 |
47 | items.consumer | - | 소비자정보(도매매 주문인 경우에만 표시) |
48 | items.consumer.name | string | 소비자 이름 |
49 | items.consumer.email | string | 소비자 이메일 주소 |
50 | items.consumer.phone | string | 소비자 유선전화번호 |
51 | items.consumer.mobile | string | 소비자 휴대폰번호 |
52 | items.consumer.zipcode | string | 소비자 우편번호 |
53 | items.consumer.address | string | 소비자 주소 |
54 | items.consumer.deliReq | string | 소비자 배송요청사항 |
55 | items.delivery.method | string | 배송방법 (택배, 소포등기, 퀵서비스, 화물배달, 일반우편, 방문수령/직접배송) |
56 | items.delivery.who | string | 배송비 부담 (무료배송, 선결제, 착불) |
57 | items.delivery.fee | int | 배송비금액 |
58 | items.delivery.code | int | 송장번호 |
59 | items.delivery.company | string | 배송사 코드 |
60 | items.delivery.companyName | string | 배송사 이름 |
61 | items.delivery.code | string | 송장번호 |
62 | items.delivery.date | int | 발송예정 상태변경일자 (Unix Timestamp) |
63 | items.delivery.dateOver | int | 배송기한일자 (Unix Timestamp) |
64 | items.delivery.dateStart | int | 배송시작일자 (Unix Timestamp) |
65 | items.delivery.dateSellerChk | int | 공급사 발주확인일자 (Unix Timestamp) |
66 | items.delivery.dateDeliArrive | int | 배송도착일자 (Unix Timestamp) |
67 | items.delivery.fromOversea | boolean | 해외직배송 여부· true : 해외직배송 상품의 주문서· false : 해외직배송이 아닌 상품의 주문서 |
68 | items.delivery.reqCcno | boolean | 해외통관고유부호 입력여부 여부· true : 해외통관고유부호가 입력됨· false : 해외통관고유부호가 입력되지 않음 |
69 | items.delivery.deliMerge.basis | int | 묶음배송비 기준 주문서 |
70 | items.delivery.deliMerge.method | string | 묶음배송비 부담주체 (S:무료배송, P:선결제, B:착불) |
71 | items.delivery.deliMerge.amount | int | 묶음배송비 금액 |
72 | items.delivery.deliMerge.items.item | int | 묶음배송된 상품번호 |
73 | items.selectOpt | - | 주문옵션 |
74 | items.selectOpt.opt | - | 주문옵션 1항목 |
75 | items.selectOpt.opt.name | string | 주문옵션명 |
76 | items.selectOpt.opt.add | int | 주문옵션 추가금액 |
77 | items.selectOpt.opt.price | int | 주문옵션 추가금액 반영 후의 단가 |
78 | items.selectOpt.opt.amt | int | 주문옵션 주문금액 |
79 | items.selectOpt.opt.qty | int | 주문옵션 주문개수 |
80 | items.selectOpt.opt.code | string | 주문옵션 코드 |
81 | items.isBack | string | 반품중 여부 (true, false) |
82 | items.denyDate | int | 취소일자 (Unix Timestamp)(판매취소 혹은 구매취소의 경우에만 사용) |
83 | items.denyMemo | string | 취소사유(판매취소 혹은 구매취소의 경우에만 사용) |
84 | items.serv | - | 정산정보 |
85 | items.serv.fee | int | 수수료 금액 |
86 | items.serv.per | double | 수수료율 |
87 | items.serv.amt | int | 적립예정금액 |
88 | items.coupon | - | 할인쿠폰 정보 (할인쿠폰은 결제방법을 가상계좌로 선택했을 때에만 사용가능) |
89 | items.coupon.no | int | 사용한 할인쿠폰 번호 |
90 | items.coupon.amt | int | 사용한 할인쿠폰 금액 |
91 | items.insuFee | int | 보증보험료 (보증보험은 결제방법을 가상계좌로 선택했을 때에만 가입가능) |
92 | items.sellerPoint | - | 판매자적립포인트 정보 (지급된 포인트가 없는 경우 생략) |
93 | items.sellerPoint.point | int | 지급된 판매자적립포인트 액수 |
94 | items.sellerPoint.type | int | 판매자적립포인트 지급유형fix : 정액(구매수량에 비례하여 지급)rate : 정률(구매액에 비례하여 지급) |
95 | items.sellerPoint.limitAmt | int | 판매자적립포인트가 지급되는 최저구매액지급유형이 정률일 때만 사용하며, 정액인 경우에는 공란으로 비워둠 |
96 | items.sellerPoint.basePoint | int | 판매자적립포인트 단위지급액정액 : 구매개수 1개당 지급되는 포인트 액수정률 : limitAmt로 입력된 금액당 지급되는 포인트 액수 |
97 | items.log | string | 주문상태기록 |
98 | items.chatList | - | 판매자-구매자간 대화목록 |
99 | items.chatList.list | - | 판매자-구매자간 대화 1건에 대한 정보 |
100 | items.chatList.list.no | int | 대화번호 |
101 | items.chatList.list.type | int | 대화 작성자 유형 (판매자, 구매자) |
102 | items.chatList.list.id | int | 대화 작성자 아이디 |
103 | items.chatList.list.memo | int | 대화 내용 |
104 | items.chatList.list.date | int | 대화 작성일시 (Unix Timestamp) |
105 | items.date | string | 주문일시 (yyyy-mm-dd hh:ii:ss) |
v4.0: 기존
getOrderList 2.0이 “List / View”로 분리v2.0: 분리 이전의 구버전(getOrderList 2.0)
view 항목으로 List / View 각각 조회