주문목록/배송조회
Last updated
Last updated
기본 스킨에서 주문목록/배송조회 페이지는 아래와 같은 항목으로 구성되어 있습니다.
주문일자(주문번호) : 주문이 발생한 일자 (YYYY.MM.DD) 와 주문번호가 노출되며, 해당 주문 클릭시 주문 상세 페이지로 이동 가능합니다.
상품 정보 : 동일 주문 번호 내 상품 옵션 기준으로 상품의 썸네일, 상품명, 구매한 옵션 (선택형 옵션, 텍스트형 옵션)이 출력됩니다.
수량 : 주문 상품 구매 수량을 출력합니다.
상품금액 : 상품 결제 금액이 출력됩니다.
진행상태 : 주문 상품 기준으로 조회 시점의 주문상태와 클레임 상태가 출력됩니다.
접수 : 주문 상품의 '진행상태'에 따른 클레임 신청 버튼이 출력됩니다.
비회원의 경우 비회원 인증 후(주문번호 및 주문비밀번호 입력) 주문 목록 접근 시 주문 상세 페이지로 이동됩니다. 비회원 주문상세 페이지에 대해서는 아래 비회원 주문상세에서 확인 하실 수 있습니다.
기본 스킨의 경우 아래 API 를 통해 아래와 같이 주문 목록 화면을 제공하고 있습니다.
► 주문 리스트 조회하기 회원 기준으로 일정 기간동안 생성한 주문 리스트를 조회합니다.
회원이 일정 기간 (시작일~종료일) 에 생성한 주문리스트를 조회하는 것으로 accessToken(회원 엑세스 토큰)을 기준으로 호출하여 주문리스트 데이터를 응답 받을 수 있습니다. 주문 리스트 조회 API의 경우 시작일~종료일을 지정하여 주문리스트를 호출하거나, 주문상태를 지정하여 주문리스트를 호출 할 수도 있습니다.
기본 스킨의 경우 당일로 부터 이전 7일 까지의 주문리스트를 Default로 제공합니다. 주문번호 내 상품 옵션기준으로 상품정보가 노출되므로, 1개의 주문번호에 주문한 다수 개의 상품 정보가 출력될 수 있습니다.
오로라 개별형 기본 스킨에는 한 페이지 당 20개의 주문번호를 노출합니다
주문리스트 조회 API GET/ profile/orders에서는 상품 정보를 주문번호 itms > 옵션주문번호orderOptions 기준으로 2Depth 배열로 데이터 제공하며, 기본 스킨에서는 위의 2Depth 데이터인 orderOptions 값을 옵션 단위의 1Depth 배열로 구성하여 화면을 출력하고 있습니다.
진행상태 영역에서는 해당 주문 건의 주문상태 및 클레임 상태를 출력합니다.
주문 상태 : 입금대기 , 결제완료, 상품준비중, 배송준비중, 배송중, 배송완료, 구매확정
클레임 상태 : 취소신청, 취소대기, 취소완료, 교환신청, 교환처리, 교환완료, 반품신청, 반품처리, 반품완료
주문 상태, 클레임 상태의 출력은 주문리스트 조회 API 의 응답값 중 clameStatusType (클레임 상태 정보), orderStatusTypeLabel (주문 상태 정보), nextAction (다음에 할 수 있는 작업)등을 사용하여 진행상태 텍스트와 버튼을 제공할 수 있습니다.
clameStatusType (클레임 상태 정보)의 응답 여부에 따라 진행상태 값을 출력합니다.
클레임 정보가 없는 경우 주문 상태 정보를 출력 합니다. 즉, clameStatusType = null 일 때, orderStatusTypeLabel 값을 주문 상태 정보로 출력할 수 있습니다.
클레임 정보가 있는 경우 클레임 상태 정보를 출력 합니다. 즉, clameStatusType 값이 null이 아닐 때, claimStatusType , claimNo, claimStatusTypeLabel 값을 사용하여 진행상태를 출력합니다.
다음에 할 수 있는 작업 값을 통해 진행 상태 값에 따른 구매자 액션 버튼을 제공합니다. 예를 들어, 진행상태가 배송완료 상태 인 경우 '배송완료'에서 구매자가 할 수 있는 액션인 배송조회, 구매확정, 후기작성, 교환신청, 반품신청에 대한 버튼을 제공합니다.
nextActions 의 응답 값으로 회신 되는 값에 맞는 버튼을 노출하여 구매자에게 쇼핑몰 기능을 제공할 수 있습니다. nextActions 의 값으로는 진행상태 정보에 따라 아래의 표의 액션을 할 수 있습니다.
주문번호 items 기준
입금대기와 결제완료 상태에서만 주문단위 action이 가능합니다.
| 주문상태/클레임상태 | nextAction | 제공 필요 버튼 |
|---|---|---|
DEPOSIT_WAIT 입금대기 | CANCEL_ALL 주문번호 내 전체상품 취소 CHANGE_ADDRESS 배송지변경 | 취소신청 배송지변경 |
PAY_DONE 결제완료 | CANCEL_ALL 주문번호 내 전체상품 취소 CHANGE_ADDRESS 배송지변경 | 취소신청 배송지변경 |
옵션주문번호 orderOptions 기준
| 주문상태/클레임상태 | nextAction | 제공 필요 버튼 |
|---|---|---|
DEPOSIT_WAIT 입금대기 | CANCEL (옵션별) 취소 | 취소신청 |
PAY_DONE 결제완료 | EXCHANGE 교환 CANCEL 취소 | 교환신청 취소신청 |
PRODUCT_PREPARE 상품준비중 | EXCHANGE 교환 CANCEL 취소 | 교환신청 취소신청 |
DELIVERY_PREPARE 배송준비중 | EXCHANGE 교환 CANCEL 취소 | 교환신청 취소신청 |
DELIVERY_ING 배송중 | DELIVERY_DONE 수취확인 VIEW_DELIVERY 배송조회 RETURN 반품 EXCHANGE 교환 CONFIRM_ORDER 구매확정 WRITE_REVIEW 후기작성 | 배송조회 반품신청 교환신청 구매확정 후기작성 |
DELIVERY_DONE 배송완료 | VIEW_DELIVERY 배송조회 CONFIRM_ORDER 구매확정 RETURN 반품 EXCHANGE 교환 WRITE_REVIEW 후기작성 | 배송조회 구매확정 교환신청 반품신청 후기작성 |
BUY_CONFIRM 구매확정 | WRITE_REVIEW 후기작성 | 후기작성 |
CANCEL_REQUEST 취소신청(승인대기) | VIEW_CLAIM 클레임조회 WITHDRAW_CANCEL 취소신청 취소 | 취소신청(=진행상태 조회버튼) 취소신청철회 |
CANCEL_PROC_REQUEST_REFUND 취소처리(환불보류) CANCEL_PROC_WAITING_REFUND 취소처리(환불대기) | - | 취소처리중(=진행상태 조회 버튼) |
CANCEL_DONE 취소완료 (환불완료) CANCEL_NO_REFUND 취소완료(환불없음) | VIEW_CLAIM 클레임조회 | 취소완료(=진행상태 조회 버튼) |
EXCHANGE_REQUEST 교환신청(승인대기) | VIEW_CLAIM 클레임조회 WITHDRAW_EXCHANGE교환신청 취소 | 교환신청(=진행상태 조회 버튼) 교환신청철회 |
EXCHANGE_REJECT_REQUEST 교환처리(철회대기) | VIEW_CLAIM 클레임조회 | 교환신청(=진행상태 조회 버튼) |
EXCHANGE_PROC_BEFORE_RECEIVE 교환처리(수거진행) EXCHANGE_PROC_REQUEST_PAY 교환처리(결제대기) EXCHANGE_PROC_REQUEST_REFUND 교환처리(환불보류) EXCHANGE_PROC_WAITING 교환처리(처리대기) EXCHANGE_PROC_WAITING_PAY 교환처리(입금처리대기) EXCHANGE_PROC_WAITING_REFUND 교환처리(환불대기) | - | 교환처리중(=진행상태 조회 버튼) |
EXCHANGE_DONE 교환완료 (차액없음) EXCHANGE_DONE_PAY_DONE 교환완료 (결제완료) EXCHANGE_DONE_REFUND_DONE 교환완료(환불완료) | VIEW_CLAIM 클레임조회 | 교환완료(=진행상태 조회 버튼) |
RETURN_REQUEST 반품신청(승인대기) | VIEW_CLAIM 클레임조회 WITHDRAW_RETURN 반품신청 취소 | 반품신청(=진행상태 조회 버튼) 반품신청철회 |
RETURN_REJECT_REQUEST 반품신청 (철회대기) | VIEW_CLAIM 클레임조회 | 반품신청(=진행상태 조회 버튼) |
RETURN_PROC_BEFORE_RECEIVE 반품처리(수거진행) RETURN_PROC_REQUEST_REFUND 반품처리(환불보류) RETURN_PROC_WAITING_REFUND 반품처리(환불대기) RETURN_REFUND_AMT_ADJUST_REQUESTED 반품처리(조정요청) | - | 반품처리중(=진행상태 조회 버튼) |
RETURN_DONE 반품완료(환불완료) RETURN_NO_REFUND 반품완료(환불없음) | VIEW_CLAIM 클레임조회 | 반품완료(=진행상태 조회 버튼) |
배송조회 팝업을 출력합니다.
배송조회 팝업은 nextActions 의 URL 를 참고하여 출력합니다.
구매확정 버튼 클릭 시 아래 구매확정 API를 호출 하여 구매확정 처리를 합니다.
에스크로 결제 건의 경우, 배송완료 시 PG사에서 발송한 이메일을 통해 구매확정 처리가 가능하므로 구매확정 버튼을 제공하지 않습니다.
PUT /profile/order-options/{orderOptionNo}/confirm
▶ 상품 주문 구매 확정하기 상품 주문을 구매확정 처리합니다
후기(상품평) 작성 버튼 클릭 시 후기를 작성할 수 있는 페이지를 제공합니다.
기본 스킨에서는 후기작성 페이지를 레이어팝업으로 제공하고 있습니다.
페이지 형식은 스킨 개발 시 자유롭게 처리 가능합니다.
POST /products/{productNo}/product-reviews
▶ 상품평 등록하기 상품평을 등록합니다
주문 옵션 번호와 옵션 번호 기준으로 상품평을 작성할 수 있으며, 상품평 평점, 상품평 내용, 첨부파일을 등록할 수 있습니다. API 호출 시 상품번호와 회원 엑세 스토큰을 통해 작성할 상품을 지정하여 상품평을 등록 받을 수 있습니다.
또한, 비회원의 경우 상품평 등록 시 작성자명과 비밀번호를 입력 받아 작성자 검증을 할 수 있습니다. 등록된 후기는 각 상품의 상품 상세 페이지 및 마이페이지 > 나의 게시글의 상품 후기메뉴에서 확인 가능합니다.
네이버페이 주문의 구매확정 이후 후기 작성이 가능합니다. * 구매확정 이전 상태에서 후기 작성 요청 시 에러 메시지 회신됩니다.
에스크로 주문건은 구매확정 이후 후기 작성이 가능합니다. * 구매확정 이전 상태에서 후기작성 요청 시 에러 메시지가 회신됩니다.
클레임 상태 정보는 주문번호 내 진행 중이거나 완료된 클레임이 있는 경우 클레임 신청 내역을 확인할 수 있는 페이지 입니다.
기본 스킨 기준으로 클레임 상태 정보는 레이어 팝업으로 제공되고 있습니다.
GET /profile/claims/{claimNo}/result
▶ 회원 클레임 상세보기(클레임 번호) 클레임 번호로 해당 회원의 클레임 신청 내역의 세부 정보를 확인합니다
GET /guest/claims/{claimNo}/result
▶ 클레임 상세보기 (클레임 번호) 클레임 번호로 비회원의 클레임 신청 내역의 세부 정보를 확인합니다
클레임 상세 보기는 회원/비회원 여부에 따라 호출하는 API 가 다릅니다. 회원의 경우 회원 클레임 상세 보기 API를 통해, 비회원의 경우 비회원 클레임 상세보기 API 를 통해 호출바랍니다.
주문 목록 내 접수 항목은 주문상태에 따라 구매자가 신청 가능한 클레임 단계 (취소, 반품, 교환, 신청철회 등) 버튼이 출력됩니다. 주문상태에 따른 클레임 신청 버튼은 GET /profile/orders 내 nextActions 의 값이 아래의 값을 가질 때 각 값에 따른 버튼을 노출해주시면 됩니다.
| nextAction | 다음 단계 액션명 | 버튼 |
|---|---|---|
CANCEL | 취소신청 | [취소신청] 버튼이미지 |
CANCEL_ALL | 주문번호 내 전체 상품 취소신청 | [취소신청] 버튼이미지 |
WITHDRAW_CANCEL | 취소신청 철회 | [취소신청철회] 버튼이미지 |
EXCHANGE | 교환신청 | [교환신청] 버튼이미지 |
WITHDRAW_EXCHANGE | 교환신청 철회 | [교환신청철회] 버튼이미지 |
RETURN | 반품신청 | [반품신청] 버튼이미지 |
WITHDRAW_RETURN | 반품신청 철회 | [반품신청철회] 버튼이미지 |
클레임 신청 버튼인 취소신청 , 교환신청, 반품신청 버튼 클릭 시 클레임 신청 화면으로 이동합니다. orderOptionNo, claimType의 값에 따라 클레임 신청 API를 호출하며, 클레임 신청 시 회원/비회원에 따라 제공되는 API가 다릅니다.
비회원 : [GET] 클레임 신청 정보 조회 API
클레임 신청 화면은 아래 페이지에서 더 자세히 확인해주세요.
에스크로 결제 주문은 주문번호에 포함된 상품의 전체 취소만 가능하며, 부분 취소, 전체 교환, 부분 교환, 전체 반품, 부분 반품 신청은 불가하도록 작업해야 합니다.
* 부분 취소, 전체 교환, 부분 교환, 전체 반품, 부분 반품 요청 시 오류 메시지를 응답하고 있습니다.
네이버페이 주문건의 경우 취소/교환/반품 신청 모두 네이버페이 판매자센터에서 처리해야 합니다.
주문에 대한 취소/반품/교환을 신청할 수 있는 페이지를 제공합니다. 취소/반품/교환 신청 페이지는 회원 및 비회원 에 따라 API가 각각 제공되며, 아래의 API를 통해 신청 페이지를 생성하여 제공할 수 있습니다.
GET /profile/order-options/{orderOptionNo}/claims
▶ 회원 클레임 신청을 위한 정보 조회하기 회원이 구매한 주문 중 주문상품옵션 기준으로 클레임(취소/반품/교환)을 신청할 수 있도록 정보를 조회합니다
GET /guest/order-options/{orderOptionNo}/claims
▶ 클레임 신청을 위한 정보 조회하기 비회원이 구매한 주문 중 클레임(취소/반품/교환)을 신청할 수 있도록 정보 조회합니다
주문 내 주문상품옵션 기준으로 취소/반품/교환하려는 상품과 수량을 선택할 수 있습니다. 클레임(취소/반품/교환)은 주문상품옵션 기준으로 하기 때문에 API 호출 시 orderOptionNo 기준으로 주문상품 리스트를 가져옵니다.
취소/반품의 경우 동일 주문번호 내 클레임 신청 1회에 다수의 주문상품옵션을 선택하여 복수 신청이 가능합니다. 교환의 경우에는 클레임 1회 신청 시 동일 주문번호 내 클레임 복수 신청이 불가하니 교환 기능 제공 시 주문상품옵션 별로 각각 교환 신청이 가능하도록 기능 제공해야 합니다.
* 네이버페이 주문의 경우 네이버페이 정책 상 각 주문상품옵션 별로 클레임 신청해야 합니다.
클레임 신청 시 복수 신청이 가능한 주문상품옵션번호의 경우 claimableOptions 값으로 주문상품옵션 정보를 확인할 수 있습니다. 복수 신청이 불가한 주문상품의 경우 claimableOptions값은 전송되지 않습니다.
취소/반품/교환 신청 하는 사유를 입력할 수 있는 영역입니다. 입력한 귀책 사유에 따라 반품 배송비 등이 구매자 혹은 판매자에게 부과 됩니다.
클레임 사유로는 '귀책 대상' , '귀책사유', '상세사유', '첨부파일'을 입력할 수 있습니다.
귀책 대상 - 귀책 대상은 구매자 BUYER, 판매자 SELLER 2가지 항목만 있습니다. - 결제완료 이후 주문건에 대해서는 모두 입력 항목 제공됩니다. (입금 대기 미제공) - 에스크로 주문 건의 경우 입력 항목 제공하지 않습니다.
귀책 사유 - select-box로 제공하며, claimReasonTypes 스키마 ENUM으로 클레임 사유 출력합니다. - 귀책 사유의 경우에도 귀책 대상과 동일하게 결제 완료 주문건에 대해 입력 항목 제공(입금 대기 미제공)하며,
에스크로 주문건의 경우 노출하지 않습니다.
상세 사유 - input 으로 입력 항목 제공합니다. - 모든 클레임 상태에서 사유에 대해 자유 입력 가능합니다.
첨부파일 - 클레임 신청을 증명할 수 있는 첨부파일 업로드 할 수 있습니다. - 배송중이거나 배송완료의 주문상태에서만 기능 제공됩니다.
무통장 및 가상계좌 입금을 통해 주문한 경우, 환불 금액을 받을 계좌 정보를 입력할 수 있습니다. '취소', '반품' 신청페이지에서만 해당 영역을 제공합니다. 환불 계좌 정보 내 은행은 select-box로 제공하며 선택 값은 availableBanks의 값을 사용하여 노출합니다.
배송 이후 (주문상태값 : 배송중, 배송완료) '교환', '반품' 을 신청하는 경우에 주문 상품의 수거에 대한 정보를 입력할 수 있는 영역입니다. 반품 수거 방법으로는 판매자 수거요청 과 구매자 직접 반품 2가지 항목을 제공하며, 선택한 수거 방법에 따라 입력 항목은 다르게 제공합니다.
판매자 수거 요청
교환, 반품 신청 시 배송된 상품을 판매자가 택배사에 연락하여 수거 하는 방식입니다.
반품 수거 방법, 반품자명, 수거지 주소, 휴대폰 번호, 전화번호, 수거시 참고사항을 입력할 수 있습니다.
returnAddress 의 값을 입력 화면에 출력합니다.
[배송지 목록에서 선택] 버튼 클릭 시 배송지 관리 팝업을 노출합니다.
구매자 직접 반품
교환, 반품 시 배송된 상품을 구매자가 알아서 택배사를 통해 쇼핑몰에 상품을 배송합니다.
반품 수거 방법 , 반품 접수 정보를 입력 할 수 있습니다.
반품 접수 정보 내 택배사 선택은 select-box로 제공되며, 택배사 값은 deliveryCompanyTypeWithLabels 값을 통해 제공합니다.
교환되어 재발송 되는 상품의 배송지 정보를 입력할 수 있습니다. 교환 신청 페이지에서만 입력 항목을 제공하며, 입력 항목에 기본 데이터로 exchangeAddress의 값을 출력합니다.
쇼핑몰 회원 계정에 저장된 배송지 정보를 활용하기 위해서는 배송지 관리 팝업을 노출하여 기능을 제공합니다.
해외구매대행 상품으로 exchangeAddress.customsIdNumber 값이 존재하는 경우 개인통관고유부호를 입력할 수 있는 input 을 제공합니다.
신청 버튼 클릭 시, 실제 클레임 신청 페이지에서 입력한 내용을 확인 (유효성 체크) 하고, 각 클레임 타입(주문취소/교환/반품)에 맞는 API를 호출 하여 클레임을 신청합니다.
주문 취소에 대한 API 호출 경로는 아래와 같습니다. 주문 취소는 부분 취소 요청 가능하며 1개의 클레임 신청 시 복수신청 가능하므로 회원/비회원에 따라 아래의 API 경로를 통해 요청하시면 됩니다.
▶ 회원 주문취소 신청하기 회원의 주문을 취소 신청합니다.
▶ 비회원 주문취소 신청하기 비회원의 주문을 취소 신청합니다.
에스크로 주문건의 경우 회원/비회원 여부에 따라 별도 API를 통해 취소 신청이 가능합니다. 에스크로 주문건은 전체 취소만 지원하므로, 아래의 API 를 통해 취소 신청을 해야 합니다.
POST /profile/orders/{orderNo}/claims/cancle
▶ 회원 주문취소 신청하기 회원의 에스크로 주문을 취소 신청합니다.
POST /guest/order/{orderNo}/claims/cancle
▶ 비회원 주문취소 신청하기 비회원의 에스크로 주문을 취소 신청합니다.
반품 요청 또한 1회 클레임 신청 시 복수 주문상품 옵션에 대해 반품 신청할 수 있으므로 회원/비회원 여부에 따라 아래의 API를 통해 신청해주시면 됩니다.
▶ 회원 반품 신청하기 회원의 주문을 반품 신청합니다.
▶ 비회원 반품 신청하기 비회원의 주문을 반품 신청합니다
교환 신청은 회원만 가능하며, 비회원은 교환 신청이 불가합니다. 교환 신청은 1회 클레임 신청 시 1개의 주문상품옵션번호만 신청 가능합니다.
POST /profile/order-options/{orderOptionNo}/claims/exchange
▶ 회원 교환 신청하기 회원의 주문에 대한 교환을 신청합니다
