주문서

주문하기

post

기능 설명

  • 주문을 생성하는 API입니다.


상세 설명

  • 결제 승인을 하고 주문을 생성합니다. 주문이 성공하면 주문자에게 주문완료 알림톡과 메일을 발송합니다.


특이사항

  • 비회원으로 주문 성공 시 비회원 로그인 처리 쿠키를 생성합니다.

  • 주문 실패시 오류 응답 내 isProcess 값이 true이면 주로 결제 관련 오류로, 결제수단을 변경하면 같은 정보로 재주문이 가능합니다. 주문서 페이지로 이동 처리해주세요.

  • 주문 실패시 오류 응답 내 isProcess 값이 false이면 동일 정보로 주문이 불가한 오류로, 주문 실패 페이지로 이동 처리해주세요.

  • FO 전용 API로 FO의 로그인 정보로 주문을 생성합니다.

  • 로그인 정보를 API 내부에서 조회하기 때문에 파라미터로 회원번호(mbrNo)는 필요하지 않습니다.


수정번호

  • release_231009_01: 내부 개선.

  • Release v2.00_240401 : 주문상세상품정보 조회 시 단일상품여부(snsGoodsYn) 추가

  • Release v2.00_240401 : 주문완료 이메일에 필요한 값 추가 및 변경

  • Release v2.00_240509 : request 주문프로모션정보 값 nullable 제거

  • Release v2.00_240530 : 정기주문으로 주문한 경우, 주문완료 이메일에 필요한 값 추가 및 변경

  • Release v2.00_240530 : 입점사 평가 관련하여 주문 상세에 출고완료예정일시 추가

  • Release v2.00_240613 : 토스 결제 승인 추가

  • Release v2.00_240627 : 토스 간편결제 추가

  • Release v2.00_240725 : E쿠폰상품인 경우 주문내역상태를 주문완료에서 발송완료처리로 적용

  • Release v2.00_240808 : 사은품, 선물하기 상품의 주문상세 테이블에 주문취소가능여부, 회수여부 컬럼 추가

  • Release v2.00_250717 : 증빙서류(세금계산서) 발행 추가

  • Release v2.00_250801 : 환경설정에 따른 증빙서류(세금계산서) 활성화 처리

Header parameters
AuthorizationanyOptional

Access Token

Body

주문하기 Request

Responses
chevron-right
200

주문 성공

No content

post
/v1/order

No content

실제 근무일자 계산

post

기능 설명

  • 기준일자를 받아서 실제 근무일자를 계산하여 리턴합니다.


상세 설명

  • 기준일자를 기준으로 입력받은 일수를 합산합니다.

  • 날짜 계산 중 휴일이 있는 경우 해당 날짜는 합산에서 제외됩니다.

  • 주문상품 출고완료예정일시를 계산하는 경우 주문완료 시점에 상품의 출고완료예정일시를 계산합니다.

  • 주문상품 출고완료예정일시를 계산하는 경우 일반상품인 경우에는 주문시간을, 예약상품인 경우에는 배송지시예약일시를 기준으로 출고완료예정일시를 계산합니다.

  • BO의 협력사 평가 중 소명이의제기에서 자동승인예정일자, 소명사유등록가능일자를 계산합니다.


수정번호

  • Release v2.00_240613:휴일업무구분코드 파라미터 추가, URL 변경

Header parameters
AuthorizationanyOptional

Access Token

Body

실 업무일자 DTO

standardDtmstring · date-timeRequired

기준날짜

dayCountinteger · int64Required

일수

Example: 1
holiJobGbCdstringRequired

휴일업무구분코드(CM001)

Example: 03
Responses
chevron-right
200

성공

*/*
string · date-timeOptional
post
/v1/orderSheet/workingDay

주문서 진입 검증

post

기능 설명

  • 주문서 진입 시 사용자 검증을 진행합니다.


상세 설명

주문서 진입 시 다음 정보들을 검증합니다.

  • 주문서 Request 필수 정보 존재 여부

  • 비회원 인증 여부

  • 주문자 나이

  • 선물하기 주문 시 사용자의 회원 여부


수정번호

  • release_231023 : 선물하기 주문인 경우, 사용자의 회원여부 확인

Header parameters
AuthorizationanyOptional

Access Token

Body

주문서 진입 시 검증 Request DTO

deliMethodCdstring · enumRequired

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
ordGbCdstring · enumRequired

OM002(주문 구분 코드) 10: 일반주문 , 20: 선물하기 , 30: e-쿠폰 , 40: 제휴

Example: 10Possible values:
ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
bsketNoListinteger · int64[]Required

장바구니번호

Example: [100009929]
Responses
chevron-right
200

성공

No content

post
/v1/orderSheet/validateOrderSheet

No content

결제 면세금액 조회

post

기능 설명

  • 상품 과세/면세/영세 구분에 따라 결제를 위한 면세 금액을 조회합니다.


상세 설명

  • 상품 과세/면세/영세 구분에 따라 결제를 위한 면세 금액을 조회합니다.

  • 결제 배분 프로세스를 활용해 면세 상품의 금액을 합산합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

주문하기 Request

Responses
chevron-right
200

성공

*/*
integer · int64Optional
post
/v1/orderSheet/taxFreeAmount

주문서 조회

post

기능 설명

  • 회원 및 비회원의 주문서 정보를 조회합니다.


상세 설명

주문서 진입 시 회원 및 비회원의 주문서 정보를 조회합니다. 주문서 정보에는 회원, 결제수단, 주문기본, 주문상품, 주문배송, 주문프로모션, 적립 정보들이 포함됩니다.

  • 주문한 상품이 다수이면, 상품들의 공통된 결제 가능한 결제수단을 조회합니다.

  • 회원 주문 시 최대 혜택 정보를 조회합니다.

  • 비회원 주문 시 회원의 부결제수단 정보를 조회하지 않습니다.

  • 비회원 주문 시 혜택 및 적립 정보를 조회하지 않습니다.


수정번호

  • Release v2.00_240401 : 주문서 진입 시 구매수량 확인 후 에러메시지 노출 적용

  • Release v2.00_240725 : 주문서 진입 시 상품유형코드에 따른 주문상품구분 셋팅

Header parameters
AuthorizationanyOptional

Access Token

Body

주문서 조회 Request DTO

deliMethodCdstring · enumOptional

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
ordGbCdstring · enumOptional

OM002(주문 구분 코드) 10: 일반주문 , 20: 선물하기 , 30: e-쿠폰 , 40: 제휴

Example: 10Possible values:
ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
ordGoodsGbstringOptional

주문상품구분(OM029)

Example: 10
bsketNoListinteger · int64[]Optional

장바구니번호

Example: [100009929]
Responses
chevron-right
200

성공

*/*

주문서 조회 Response DTO

post
/v1/orderSheet/orderSheet

상담원 주문서 사은행사 조회

post

기능 설명

  • 상담원이 주문한 상품에 진행 중인 사은행사가 존재하는 지 조회합니다.


상세 설명

  • 상담원 주문에서 상품 선택 완료 시 해당 상품에 진행 중인 사은행사가 존재하는 지 조회합니다.


특이사항

  • 회원 정보를 가져오는 방법을 제외하고 aeEvtList(주문서 사은행사 조회) API와 동일 로직입니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

FO 주문서 사은행사 조회 Request DTO

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
mbrNostringOptional

회원번호

mbrGradeCdstring · enumOptional

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:
siteNostringOptional

사이트번호

Example: 1
stafYnstringOptional

임직원여부

Example: Y
Responses
chevron-right
200

성공

*/*

사은행사정보

goodsNostringRequired

상품번호

Example: 10000001
itmNostringRequired

단품번호

Example: 001
aeNostringRequired

사은행사번호

Example: C1000000
addEvtTypCdstring · enumRequired

사은행사 유형 코드(MK012) 10 : 구매금액사은품 , 20 : 상품사은품

Example: 20Possible values:
aeStrDtmstring · date-timeRequired

사은행사시작일시

aeEndDtmstring · date-timeRequired

사은행사종료일시

payStrDtstringOptional

지급시작일자

Example: 20231201
payEndDtstringOptional

지급종료일자

Example: 20231231
tmEvtYnstring · nullableRequired

타임행사여부

Example: N
aplyStrTmstring · nullableOptional

적용시작시간

Example: 0800
aplyEndTmstring · nullableOptional

적용종료시간

Example: 2359
aeDescstringRequired

사은행사설명

Example: 사은행사 설명
aeNmstringRequired

사은행사명

Example: 사은행사 명
post
/v1/orderSheet/getCounselorOrderAeEvtList

주문서 사은행사 조회

post

기능 설명

  • 주문한 상품에 진행 중인 사은행사가 존재하는 지 조회합니다.


상세 설명

주문서 진입 시 주문한 상품에 진행 중인 사은행사가 존재하는 지 조회합니다.

  • 비회원 주문 시 사은행사 정보를 조회하지 않습니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

FO 주문서 사은행사 조회 Request DTO

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
mbrNostringOptional

회원번호

mbrGradeCdstring · enumOptional

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:
siteNostringOptional

사이트번호

Example: 1
stafYnstringOptional

임직원여부

Example: Y
Responses
chevron-right
200

성공

*/*

사은행사정보

goodsNostringRequired

상품번호

Example: 10000001
itmNostringRequired

단품번호

Example: 001
aeNostringRequired

사은행사번호

Example: C1000000
addEvtTypCdstring · enumRequired

사은행사 유형 코드(MK012) 10 : 구매금액사은품 , 20 : 상품사은품

Example: 20Possible values:
aeStrDtmstring · date-timeRequired

사은행사시작일시

aeEndDtmstring · date-timeRequired

사은행사종료일시

payStrDtstringOptional

지급시작일자

Example: 20231201
payEndDtstringOptional

지급종료일자

Example: 20231231
tmEvtYnstring · nullableRequired

타임행사여부

Example: N
aplyStrTmstring · nullableOptional

적용시작시간

Example: 0800
aplyEndTmstring · nullableOptional

적용종료시간

Example: 2359
aeDescstringRequired

사은행사설명

Example: 사은행사 설명
aeNmstringRequired

사은행사명

Example: 사은행사 명
post
/v1/orderSheet/aeEvtList

주문서 적립정보 조회

post

기능 설명

  • 주문 정보에 맞는 적립 정보를 조회합니다.


상세 설명

주문서 화면에서 혜택 적용 정보를 변경할 시 해당 주문 정보에 맞는 적립 정보를 조회합니다.

  • 비회원 주문 시 적립 정보를 조회하지 않습니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

FO 주문서 적립 조회 Request DTO

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
Responses
chevron-right
200

성공

*/*

적립정보

totalAccmAmtinteger · int64Required

전체적립금액

Example: 3000
post
/v1/orderSheet/accumulationInfo

주문완료정보 조회

post

기능 설명

  • 주문 성공 후 주문완료 정보를 조회하는 API 입니다.


상세 설명

  • 요청한 주문에 클레임이 진행되었다면 예외가 발생합니다.

  • 비회원의 경우 비회원 로그인 처리 API를 통해 생성된 쿠키 값이 필수입니다.


수정번호

  • Release v2.00_240401 : 상품 리스트(OrderCompleteGoodsInfo)에 증정품명(prestNm) 추가

  • Release v2.00_240401 : 구매 상품별로 사은품 목록을 표시할 수 있도록 주문순번(ordSeq)과 본품주문순번(aeOrdSeq)을 추가

  • Release v2.00_240401 : 단일상품여부(snsGoodsYn) 조회 추가

cookie
nonmemberInfoStringOptional

비회원 주문정보. 비회원 주문완료 조회시 필수

Header parameters
AuthorizationanyOptional

Access Token

Body

주문완료조회 Request

ordNostringRequired

주문번호

Example: 20230809O007055
systemTypestring · enumOptional

시스템구분코드 10:FO, 20:BO

Default: 10Possible values:
Responses
chevron-right
200

주문완료 조회 성공

application/json

주문완료정보

ordNostringOptional

주문번호

Example: 20230809O007055
ordSeqinteger · int32Optional

주문순번

Example: 1
ordManNmstringOptional

주문자명

Example: 홍길동
ordGbCdstringOptional

주문구분코드(OM002)

Example: 10
ordAccpDtmstring · date-timeOptional

주문일시

aeOrdSeqinteger · int32Optional

본품주문순번

Example: 1
ordGoodsGbstringOptional

주문상품구분(OM029)

Example: 10
post
/v1/order/getOrderCompleteInfo

배송그룹 배송비 조회

post

기능 설명

  • 배송그룹 각각의 배송비를 조회합니다.


상세 설명

  • 요청한 배송그룹의 우편번호가 도서산간 지역일 경우 추가 배송비가 부과됩니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

배송그룹 배송비조회 DTO

deliMethodCdstring · enumRequired

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
Responses
chevron-right
200

성공

*/*
dlvpSeqstringOptional

배송지순번

Example: 1
deliNostringOptional

배송번호

Example: 1
entrNostringOptional

협력사번호

Example: 10000002
deliPolcNostringOptional

배송정책번호

Example: 10000431
post
/v1/delivery/deliveryGroupAmountList

주문서 배송비 조회

post

기능 설명

  • 주문서 화면에서 사용자의 주문 배송지 정보 변경 시 배송비를 조회합니다.


상세 설명

  • 주문서에서 사용자의 주문 배송지 정보 선택 시 배송비를 조회합니다.

  • 상품 별 배송그룹을 만들고, 배송 그룹 별 배송비를 조회합니다.

  • 변경된 배송지가 도서산간 지역일 경우 추가 배송비가 부과될 수 있습니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

배송비 조회 Request DTO

deliMethodCdstring · enumRequired

LO010(배송방법코드) * 10 : 택배배송 * 30 : 매장수령 * 40 : 퀵배송 * 50 : 해외배송 * 60 : 무배송

Example: 10Possible values:
allClaimbooleanOptional

전체클레임 여부

allNonReturnablebooleanOptional
Responses
chevron-right
200

성공

*/*

배송지 목록

dlvpSeqstringOptional

배송지 순번

Example: 1
mbrDlvpSeqstringOptional

회원 배송지순번

Example: 1
baseDlvpYnstringOptional

기본 배송지 여부

Example: Y
dlvpNmstringRequired

배송지명. 일반주문 필수

Example: 우리집
zipNostringRequired

우편번호. 일반주문 필수

Example: 05837
zipAddrstringRequired

우편주소. 일반주문 필수

Example: 서울 송파구 법원로9길
dtlAddrstringRequired

상세주소. 일반주문 필수

Example: 에이치비지니스파크 D동 6층
rcvmnNmstringRequired

수취인명

Example: 홍길동
rcvmnEmailAddrstringOptional

수취인 이메일주소

Example: receiver@plateer.com
rcvmnCellSctNostringRequired

수취인 휴대폰 구분번호

Example: 010
rcvmnCellTxnoNostringRequired

수취인 휴대폰 국번번호

Example: 0000
rcvmnCellEndNostringRequired

수취인 휴대폰 끝번호

Example: 0000
rcvmnTelRgnNostringOptional

수취인 전화 지역번호

Example: 02
rcvmnTelTxnoNostringOptional

수취인 전화 국번번호

Example: 554
rcvmnTelEndNostringOptional

수취인 전화 끝번호

Example: 4583
shopTrafMsgstringOptional

매장전달메시지

Example: 포장 안 해주셔도 돼요.
deliMsgCdstringOptional

배송메시지코드(ME039) 20:배송 전 연락 바랍니다,30:부재 시 문 앞에 놓아주세요,40:부재 시 경비실에 맡겨주세요,50:빠른 배송 부탁 드립니다,60:부재 시 핸드폰으로 연락바랍니다,70:직접입력

Example: 40
deliMsgstring · nullableOptional

배송메시지

Example: 벨X, 노크X
comnFrdrCogoMethodCdstring · nullableOptional

공동현관출입방법코드(ME040) 10:공동현관 출입번호,20:자유 출입 가능,30:기타

Example: 20
comnFrdrEtcMethodstring · nullableOptional

공동현관출입 기타방법

Example: 뒷문 있어요.
comnFrdrPwdstring · nullableOptional

공동현관비밀번호

Example: 123456
pcccSeqstringOptional

회원통관고유부호순번

persCstmCdstring · nullableOptional

통관고유번호

Example: P100000000000
newPersCstmCdstring · nullableOptional

새 통관고유번호

Example: P100000000000
post
/v1/delivery/deliveryAmount

상담원 주문하기

post

기능 설명

  • 상담원이 입력한 주문을 생성하는 API입니다.


상세 설명

  • 회원의 마일리지 결제로 주문을 생성합니다. 주문이 성공하면 회원에게 주문완료 알림톡과 메일을 발송합니다.


특이사항

  • order(주문하기) API와 동일 로직입니다.

  • 다른점은 파라미터의 회원번호(mbrNo)로 주문을 생성하며, 회원번호는 필수 파라미터입니다.


수정번호

  • Release v2.00_240530 : API URL 및 스웨거 변경


Header parameters
AuthorizationanyOptional

Access Token

Body

주문하기 Request

Responses
chevron-right
200

주문 성공

No content

post
/v1/counselorOrder

No content

주문번호 채번

get

기능 설명

  • 주문번호를 채번합니다.


상세 설명

주문서에서 결제하기 직전에 호출되어 주문번호를 채번합니다.

Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

성공

*/*
stringOptional
get
/v1/orderSheet/ordNo

Last updated