LogoLogo
  • 샵바이 스킨 알아보기
    • 샵바이 스킨 설명서
    • 오로라 리액트(통합형) 스킨 개발 가이드
    • 오로라 리액트(통합형) 릴리즈 노트
    • 오로라 바닐라(개별형) 릴리즈 노트
    • 1:1 문의하기
  • 오로라 개별형 스킨 개발 가이드
    • 개발 프로세스
      • 등록
      • 개발
        • 개발 환경 구성하기
        • 스킨 디렉토리 구조
      • 설치
    • 기본 API 이해하기
      • 샵바이 API 호출 가이드
        • OAuth 2.0 적용 가이드
      • 외부 스크립트 호출 가이드
    • 화면별 API 활용 가이드
      • 공통 영역
        • 공통 상단
        • 공통 하단
        • 디자인 팝업
        • 슬라이드 메뉴 (모바일 전용)
        • 최근 본 상품
      • 메인 화면
        • 배너 영역
        • 상품진열 영역
        • 인스타그램 연동
      • 회원가입
      • 로그인
      • 간편 로그인
      • 휴대폰 본인인증
      • 상품 리스트
      • 상품 상세
        • 상품 기본 정보
        • 상품 상세 배너 (모바일 전용)
        • 상품 상세정보 (탭)
        • 배송/반품/교환 안내 (탭)
        • 상품후기 (탭)
        • 상품문의 (탭)
        • 관련상품
      • 장바구니
      • 주문서
      • 마이페이지 > 쇼핑정보
        • 주문목록/배송조회
        • 취소/반품/교환 내역
        • 주문 상세
        • 좋아요
      • 마이페이지 > 혜택관리
        • 쿠폰
        • 적립금
      • 마이페이지 > 회원정보
        • 회원정보 수정
        • 회원탈퇴
        • 배송지 관리
      • 마이페이지 > 나의 게시글
        • 1:1 문의
        • 상품문의
        • 상품후기
      • 상품후기 게시판
      • 일반 게시판
      • 기획전
    • KCP 휴대폰 본인인증 연동 (iOS/AOS)
  • 앱 개발 가이드
    • [샵바이] 웹훅(webhook) 가이드
    • [고도몰] 웹훅(webhook) 가이드
  • 추천 콘텐츠
    • 추천 콘텐츠
      • [간편 로그인] SNS 연동 기능 개발 가이드
      • [공통] 마이페이 API 화면가이드
      • [엔터프라이즈] 선물하기 기능 (배송지 나중입력)
      • [엔터프라이즈] 카카오 싱크 신청 가이드
      • [엔터프라이즈] 카카오 싱크 회원가입 API 화면가이드
      • [엔터프라이즈] 이니렌탈(렌탈결제) API 화면가이드
      • [엔터프라이즈] 외부 회원 연동 가이드
      • [엔터프라이즈] 외부 적립금 전환 가이드
      • [엔터프라이즈] 외부 적립금 연동가이드
      • [엔터프라이즈] 사은품 API 화면가이드
      • [엔터프라이즈] PG신청 가이드 (2024/4/1 업데이트)
      • [엔터프라이즈] 카카오 픽셀 설치 가이드
      • [엔터프라이즈]정기결제(배송) API 화면가이드
      • [프로/엔터프라이즈] 쇼핑몰에 인스타그램 위젯을 적용해보세요!
      • [베이직/프로] 카카오싱크 신청 가이드
      • [웹훅 추가] 주문정보 웹훅(Webhook)이란?
      • [웹훅 추가] 회원정보 변경 및 회원탈퇴
      • [웹훅 추가] 앱 설치 및 삭제
      • shop by API, POSTMAN에 추가하기
      • [글로벌] 글로벌 기능 가이드
        • 사용 프로세스
          • 엑심베이 PG 계약
          • 개발 환경 세팅
          • shop by 어드민 세팅
          • 쇼핑몰 스킨 개발
            • 언어/통화 설정
            • 상품/전시 설정
            • 주문서 조회
            • 주문 예약하기
            • 회원 등록
        • 글로벌 주문/환불 프로세스
    • FAQ
      • 에러코드_ (1) 주문
      • 에러코드_ (2) 프로모션
      • 에러코드_ (3) 클레임
      • 쿠폰 코드 API 에러메시지 안내
      • 장바구니/주문결제 에러코드 안내
      • 배송타입 및 택배사코드 안내
      • 파트너어드민 매출내역 조회기준
      • shop api error response 안내
      • server API로 주문의 외부 유입경로 집계 방법
      • 은행코드 안내
      • 7/15 스킨 에디터 업데이트 주의사항
        • 모바일_업데이트 전 템플릿 코드
        • PC_업데이트 전 템플릿 코드
        • 업데이트 후/전 템플릿 코드 비교
      • [샵바이 엔터프라이즈] server API 호출방법
      • [샵바이 엔터프라이즈] 파트너 어드민에서 상품 노출은 미리 해두고, 판매 기간은 미래시점으로 설정할 수 있는 기능이 있을까요?
      • [샵바이 엔터프라이즈] 파트너사 담당MD 일괄변경 어떻게하나요?
Powered by GitBook
On this page

Was this helpful?

  1. 추천 콘텐츠
  2. 추천 콘텐츠

[엔터프라이즈] 사은품 API 화면가이드

Previous[엔터프라이즈] 외부 적립금 연동가이드Next[엔터프라이즈] PG신청 가이드 (2024/4/1 업데이트)

Last updated 3 days ago

Was this helpful?

샵바이 엔터프라이즈의 사은품 기능을 사용하기 위해, shop API로 화면을 어떻게 구현할 수 있을지 안내하기 위한 콘텐츠입니다.

01. 간단소개

  • 기능요약

    • 쇼핑몰 내 등록된 상품을 서비스어드민에서 사은품으로 지정하여, 지급조건 충족 시 사은품으로 지급할 수 있는 기능입니다.

    • 대상 솔루션: 샵바이프리미엄 전용

    • 기능 배포일자:2022-06-14

  • 기능상세

    • 사은품 기능 어드민 설정 및 활용방법은 아래 공지사항 내 첨부파일을 참고해주시길 바랍니다

    • SA(서비스어드민):

    • BPA(파트너 어드민):


02. (예시) API소개 및 화면 가이드 아래 API들을 활용하여 사은품기능을 활용한 화면을 구현할 수 있습니다.

1. 상품 상세페이지 화면

■ 확인하기

GET /free-gift-condition/{productNo}
상품번호에 해당하는 지급가능한 조건 조회하는 API입니다.

상품 상세페이지에서 해당 상품 구매 시, 사은품으로 설정된 상품의 지급조건 정보를 조회할 수 있습니다.

▽ 예시 화면 (사은품 안내영역 제공)

사은품 지급조건을 만족하는 상품이고 사은품 지급조건이 현재 지급 가능한 상태인 경우, 상품 상세페이지에서 사은품 지급조건을 안내합니다.

  • (참고) 상품 상세페이지에서 사은품 영역이 노출되는 어드민 조건

    • 파트너사 프로모션 동의여부 체크

    • 대상 상품의 프로모션 가능여부가 '가능'이며 사은품에 체크

    • 쇼핑몰의 사은품 사용여부가 '사용함'

    • 지급상태가 '지급중'인 사은품 지급조건 중 해당 상품이 대상상품으로 설정된 지급조건이 있는지 체크

    • 사은품으로 지정된 원 상품의 전시상태가 '전시안함'이거나 프론트 '미노출'인 경우에도 사은품으로 지급됨

▽ 예시 화면

  • 위 예시화면의 '지급조건'은 giveConditionExplain(지급조건 설명)을 활용가능하며, 지급조건이 복수개인 경우 지급조건을 모두 노출합니다.

  • 위 예시화면 최하단의 안내문구 영역은 API를 활용하지않고 자유롭게 구현할 수 있습니다.


2. 주문서 작성/결제 화면

GET /order-sheets
주문서번호를 기반으로 주문상품정보를 조회하는 API입니다.

해당 API 호출 시점에, 해당 주문서 내 상품에 연결된 유효한 사은품이 있을 경우 freeGiftInfos로 리턴됩니다.

▽ 예시 화면 (주문서 작성페이지 내 사은품 정보 제공)

위 예시 화면과 같이, API를 활용하여 주문서 작성시 지급 가능한 사은품 정보를 제공할 수 있습니다.

  • 만약, 지급가능한 지급조건이 복수 개인 경우, 어드민 사은품 기본설정 내 중복지급 여부에 따라 주문서에 사은품이 다르게 노출됩니다.

    • '허용 안 함'인 경우: 최신 등록된 1개의 지급조건만 주문서에 노출

    • '허용함'인 경우 : 지급조건을 만족한 사은품 모두 노출

  • 사은품은 100% 할인으로 설정되어 0원처리되는 개념이지만, 프론트 화면에서 가격정보가 노출되지는 않습니다.


2-1. 주문서 작성/결제 화면(쿠폰 적용 후)

POST /order-sheets/{orderSheetNo}/calculate
쿠폰 및 배송비 계산이 적용된 주문서 금액을 조회하는 API 입니다.

해당 API 호출 시점에, 상품 쿠폰 할인금액이 적용된 금액을 기준으로 해당 주문서 내 상품에 연결된 유효한 사은품이 있을 경우 freeGiftInfos로 리턴됩니다.

사은품 지급 금액기준: 판매가 - 즉시할인금액 ± 옵션가 - 추가할인금액 - 상품쿠폰 할인금액

상품별로 금액조건을 체크하여 사은품을 지급합니다.


3. 마이페이지 화면

GET /profile/orders
시작일과 종료일 사이의 주문리스트를 조회하는 API입니다.

마이페이지에서 주문했던 상품 목록 조회시, 해당 상품이 사은품인지 여부를 items > orderOptions> isFreeGift로 리턴합니다.

▽ 예시 화면 (마이페이지 주문내역)

위 예시 화면과 같이, API를 활용하여 마이페이지에서 사은품 여부를 표시할 수 있습니다.

사은품은 주문상태가 결제완료인 시점에 주문서에 추가되며 (입금대기인 상태인 경우 추가되지 않으며, 주문시점에 지급 옵션으로 저장되었으나 실제 지급 시점에 사은품이 지급 불가한 상태인 경우에도 추가되지 않습니다.) 마이페이지에서는 주문서에 추가된 이후부터 지급된 사은품 확인이 가능합니다.

또한 마이페이지 주문내역 화면에서 지급된 사은품 정보 확인 및 클레임 처리 기능을 제공하고 있습니다. 지급된 사은품의 대한 취소/반품 처리가 가능합니다. (※단, 사은품 교환기능 미지원) 다른 상품과 함께 클레임 처리하거나, 사은품 개별 클레임 처리가 가능합니다.

여기서 잠깐, 꼭 참고해주세요!

사은품의 경우 상품후기 작성이 불가하며, 사은품 교환 기능은 제공되지 않습니다.

마이페이지 > 메인, 주문목록/배송조회, 주문상세 페이지에서 사은품의 상품후기 작성이 불가하며 마이페이지 > 나의 상품후기 페이지에서 [상품선택] 클릭하여 상품 선택 팝업 출력 시 사은품은 리스트에 노출되지 않습니다.

위 마이페이지 주문내역 화면에서, 사은품 상품후기 작성/교환버튼 클릭 시, 불가하다는 alert을 출력하는 등의 방법으로 처리 가능합니다.

■ 확인하기

■ 확인하기

■ 확인하기

https://service.e-ncp.com/board/popup/notice/261
https://partner.e-ncp.com/board/popup/notice/262
사은품 지급가능한 조건 조회 API
주문서 조회하기 API
쿠폰 및 배송지 정보가 적용된 주문서 금액 조회하기 API
주문리스트 조회하기 API