search
X2BEE Home

선물함

hashtag
선물 수신자 배송지 입력

put

hashtag
기능 설명

  • 선물 수신자의 배송지를 해당 주문 데이터에 반영합니다.

hashtag
상세 설명

  • 선물하기 랜딩페이지, 받은 선물함 상세, 받은 선물함 목록에서 배송지 입력 버튼 클릭 시에 호출됩니다.

  • 해당 주문의 배송지 정보를 수신자가 입력한 배송지로 UPDATE합니다.

  • 해당 주문 상세 데이터의 배송지시예약일시를 수락한 일시로 UPDATE합니다.

  • 해당 주문 기본 데이터의 선물상태코드(OM044)를 수락으로 변경합니다.

hashtag
수정번호

  • Release v2.00_240711 : 추가 배송비 개선에 따라 추가 배송비 발생 여부 체크 수정

Header parameters
AuthorizationanyOptional

Access Token

Body

주문 배송지 변경/등록 DTO

ordNostringRequired

주문번호

Example: 20230809O007943
clmNostringOptional

클레임번호

Example: 20230801C008072
systemTypestring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:
mbrNostringOptional

회원번호

Example: 10000001
deliNostringRequired

배송번호

Example: 100008491
deliPolcNostringRequired

배송정책번호

Example: 10000431
dlvpNmstringRequired

배송지명

Example: 집
rcvmnNmstringRequired

수취인명

Example: 홍길동
zipNoSeqinteger · int32Optional

우편번호순번

Example: 1
zipNostringRequired

변경후우편번호

Example: 08739
originZipNostringOptional

변경전우편번호

Example: 05837
orginDlvpSeqstringOptional

변경전배송지순번

Example: 1
zipAddrstringRequired

우편주소

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

상세주소

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

수취인휴대폰구분번호

Example: 010
rcvmnCellTxnoNostringRequired

수취인휴대폰국번번호

Example: 1234
rcvmnCellEndNostringRequired

수취인휴대폰끝번호

Example: 5678
deliMsgstringOptional

배송메시지

Example: 문 앞에 두고 가주세요.
deliMsgCdstringOptional

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

Example: 10
comnFrdrEtcMethodstringOptional

공동현관기타방법

Example: 자유출입가능
comnFrdrPwdstringOptional

공동현관비밀번호

Example: 1234
comnFrdrCogoMethodCdstringOptional

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

Example: 10
deliGbCdstring · enumOptional

LO001(배송구분코드) * 10 : 출하 * 20 : 회수

Example: 10Possible values:
dlvpSeqstringOptional

배송순번

Example: 1
rcvmnEmailAddrstringOptional

수취인이메일

Example: test@plateer.com
rcvmnTelRgnNostringOptional

수취인전화지역번호

Example: 02
rcvmnTelTxnoNostringOptional

수취인전화국번번호

Example: 1234
rcvmnTelEndNostringOptional

수취인전화끝번호

Example: 5678
frgnDirPurGoodsYnstringOptional

해외직구상품여부

Responses
chevron-right
200

성공

No content
put
/v1/mypage/giftBox/registerShippingAddress
No content

hashtag
보낸 선물함 내역 조회

post

hashtag
기능 설명

  • 보낸 선물함 목록을 조회합니다.

hashtag
상세 설명

  • 회원번호에 해당하는 선물한 주문 목록을 조회합니다.

  • 비회원은 선물하기가 불가능하므로 조회할 수 없습니다.

  • 조회시작일시, 조회종료일시 사이에 포함된 선물 주문 목록만 조회합니다.

  • 주문현황구분코드는 마이페이지 > 주문 현황 > 주문/배송 클릭시 'O', 취소/교환/반품 클릭시 'C', 선물함 클릭시 'G' 로 데이터를 넘겨받습니다.

    • 주문/배송으로 넘어왔을 경우 모든 주문에 대한 목록 조회이며, 취소/교환/반품으로 넘어왔을 경우는 취소/교환/반품에 대한 목록만 조회합니다.

  • 주문상품 단위로 FO 시스템 클레임처리 가능상태(ST007) 그룹코드의 주문내역상태코드(ref_1_val)과 주문내역구분코드(ref_2_val)에 해당하는 각 코드를 가져와 화면단에서 버튼을 노출합니다.(orderButtonList)

hashtag
수정 번호

  • Release v2.00_240729 : 취소 가능 여부(ordCnclPsbYn) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

선물함 목록 조회 DTO

rowsPerPageinteger · int32Optional

화면당노출수량

Example: 10
pageIdxinteger · int32Optional

페이지번호

Example: 1
stdDtstring · dateOptional

조회시작일

Example: 2023-08-02
endDtstring · dateOptional

조회종료일

Example: 2023-08-09
orderClassificationCodestringOptional

주문현황구분코드값(모든주문조회: O / 클레임조회 : C / 선물함조회 : G)

Example: C
pagingYnstringOptional

페이징처리여부

Example: Y
Responses
chevron-right
200

성공

*/*

주문 목록 DTO

totCntinteger · int32Optional

주문건수

Example: 10
rowsPerPageinteger · int32Optional

화면당노출수량

Example: 10
pageIdxinteger · int32Optional

페이지번호

Example: 1
post
/v1/mypage/giftBox/sendGiftBoxList

hashtag
받은 선물함 내역 조회

post

hashtag
기능 설명

  • 받은 선물함 목록을 조회합니다.

hashtag
상세 설명

  • 회원의 휴대전화번호와 선물 주문의 수취인휴대전화번호가 일치하는 주문, 회원의 회원번호와 선물수신자회원번호가 일치하는 주문 목록을 조회합니다.

  • 비회원은 선물하기가 불가능하므로 조회할 수 없습니다.

  • 조회시작일시, 조회종료일시 사이에 포함된 선물 주문 목록만 조회합니다.

  • 주문현황구분코드는 마이페이지 > 주문 현황 > 주문/배송 클릭시 'O', 취소/교환/반품 클릭시 'C', 선물함 클릭시 'G' 로 데이터를 넘겨받습니다.

    • 주문/배송으로 넘어왔을 경우 모든 주문에 대한 목록 조회이며, 취소/교환/반품으로 넘어왔을 경우는 취소/교환/반품에 대한 목록만 조회합니다.

  • 주문상품 단위로 FO 시스템 클레임처리 가능상태(ST007) 그룹코드의 주문내역상태코드(ref_1_val)과 주문내역구분코드(ref_2_val)에 해당하는 각 코드를 가져와 화면단에서 버튼을 노출합니다.(orderButtonList)

    • 받은 선물의 경우 취소/교환/반품 클레임이 불가능합니다.

    • 주문변경, 배송지변경, 배송추적, 배송완료 만 가능합니다.

  • 배송지입력의 경우 주문시점으로부터 3일 이내에 입력 해야합니다. 3일 지난 후 자동취소됩니다.

    • 클레임가능일수(ST006) 그룹코드의 선물수락기한일수(30)으로 기한일수가 변경될 수 있습니다.

Header parameters
AuthorizationanyOptional

Access Token

Body

선물함 목록 조회 DTO

rowsPerPageinteger · int32Optional

화면당노출수량

Example: 10
pageIdxinteger · int32Optional

페이지번호

Example: 1
stdDtstring · dateOptional

조회시작일

Example: 2023-08-02
endDtstring · dateOptional

조회종료일

Example: 2023-08-09
orderClassificationCodestringOptional

주문현황구분코드값(모든주문조회: O / 클레임조회 : C / 선물함조회 : G)

Example: C
pagingYnstringOptional

페이징처리여부

Example: Y
Responses
chevron-right
200

성공

*/*

주문 목록 DTO

totCntinteger · int32Optional

주문건수

Example: 10
rowsPerPageinteger · int32Optional

화면당노출수량

Example: 10
pageIdxinteger · int32Optional

페이지번호

Example: 1
post
/v1/mypage/giftBox/receiveGiftBoxList

hashtag
선물함 상세 조회

post

hashtag
기능설명

  • 보낸 / 받은 선물함 상세 내역을 조회합니다.

hashtag
상세내용

  • 주문번호(ordNo)는 필수 파라미터입니다.

  • 선물함 상세 유형(giftBoxType)값이 없는 경우 default 기타(30)로 할당됩니다.

  • 해당 주문번호의 주문정보가 존재하지 않거나 선물 상품 정보가 없는경우 Exception(code : 1003)이 발생합니다.

  • 보낸 선물함의 경우, 추가적으로 결제정보목록(payInfo)이 세팅됩니다.

  • 배송지정보목록(dlvpInfo)의 첫번째 요소가 선물 수령 배송지입니다.

  • 선물함 상세 유형(giftBoxType : 10 or 20)인 경우에 한해 상품정보목록(prdList)의 버튼목록(orderButtonList)이 세팅됩니다.(로그인 정보 필요)

  • 받은 선물함의 경우, 노출 가능한 버튼 목록(orderButtonList)은 다음과 같습니다.

    1. 주문변경(91)

    2. 배송지변경(92)

    3. 배송추척(94)

    4. 수령확인(96)

    5. 배송지입력(97)

  • 조회되는 공통코드 목록은 다음과 같습니다.

    1. 배송메시지코드(ME039)

    2. 공동현관출입방법코드(ME040)

hashtag
수정번호

  • Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

  • Release v2.00_240711 : 추가 배송비 개선에 따른 배송정책번호(deli_polc_no) 조회 추가

  • Release v2.00_240729 : 취소 가능 여부(ordCnclPsbYn) 추가

Header parameters
AuthorizationanyOptional

Access Token

Body

선물함 상세 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230809O007943
giftBoxTypestring · enumOptional

GiftBoxType(선물함유형) * 10 : 받은선물함 * 20 : 보낸선물함 * 30 : 기타

Example: 10Possible values:
mbrNostringOptional

회원번호

Example: 100001311
cellSctNostringOptional

휴대폰구분번호

Example: 010
cellTxnoNostringOptional

휴대폰국번번호

Example: 1234
cellEndNostringOptional

휴대폰끝번호

Example: 5678
Responses
chevron-right
200

성공

*/*

선물함 상세 조회 응답 DTO

ordNostringOptional

주문번호

Example: 20230809O007943
ordAccpDtmstring · date-timeOptional

주문접수일시

deliMethodCdstringOptional

배송방법코드(LO010)

Example: 10
deliMethodNmstringOptional

배송방법코드명

Example: 10
ordManNmstringOptional

주문자명

Example: 홍길동
ordManCellNostringOptional

주문자 휴대폰번호

Example: Y
mbrNostringOptional

회원번호

Example: 100001452
ordGbCdstringOptional

주문구분코드(OM002)

Example: 10
rcvmnNmstringOptional

수취인명

Example: 홍길동
rcvmnCellNostringOptional

수취인 휴대폰번호

Example: Y
ordManCellSctNostringOptional

주문자휴대폰구분번호

Example: 010
ordManCellTxnoNostringOptional

주문자휴대폰국번번호

Example: 1324
ordManCellEndNostringOptional

주문자휴대폰끝번호

Example: 3546
prstRecvmnMbrNostringOptional

선물수신자회원번호

Example: 100001452
prstRecvmnNmstringOptional

선물수신자명

Example: 홍길동
prstTypCdstringOptional

선물유형코드(OM045)

Example: 10
cardImgstringOptional

카드이미지

Example: /card-congrats.png
prstStatCdstringOptional

선물상태코드(OM044)

Example: 10
prstStatCdNmstringOptional

선물상태코드명

Example: 요청
prstMsgstringOptional

선물메시지

Example: 생일을 축하합니다!
additionalInfointeger · int32Write-onlyOptional
giftAcceptanceDeadlineAndDateinteger · int32Write-onlyOptional
post
/v1/mypage/giftBox/getGiftDetailInfo
Previous정기주문Next공지사항 FAQ

Last updated